fix(docs): configure just-the-docs theme properly

schamane · schamane · commit b7213036516f · 2025-11-13T11:58:18.000+01:00
- Fix Jekyll config to use just-the-docs theme correctly
- Add proper navigation structure with parent/child relationships
- Remove custom api layout to use just-the-docs theme
- Update all markdown pages with proper frontmatter
- Configure navigation order and hierarchy
- Remove layout references from _api HTML files

This should fix the missing navigation and styling issues on GitHub Pages
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -4,8 +4,8 @@ source "https://rubygems.org"
 ruby ">= 2.6.0"
 
 # Use exact versions for reproducible builds
-gem "jekyll", "4.4.1"
-gem "just-the-docs", "~> 0.10.0"
+gem "jekyll", "~> 4.3.0"
+gem "just-the-docs", "~> 0.8.2"
 
 group :jekyll_plugins do
   gem "jekyll-feed", "~> 0.15.0"
diff --git a/docs/_api/classes/Syslog.html b/docs/_api/classes/Syslog.html
@@ -1,8 +1,7 @@
 ---
 title: "Syslog"
-layout: api
 parent: API Reference
-nav_order: auto
+nav_order: 2
 ---
 
 <div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">Syslog</a></li></ul><h1>Class Syslog</h1>
diff --git a/docs/_api/functions/alert.html b/docs/_api/functions/alert.html
@@ -1,6 +1,6 @@
 ---
 title: "Alert"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/functions/createSyslog.html b/docs/_api/functions/createSyslog.html
@@ -1,6 +1,6 @@
 ---
 title: "CreateSyslog"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/functions/critical.html b/docs/_api/functions/critical.html
@@ -1,6 +1,6 @@
 ---
 title: "Critical"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/functions/debug.html b/docs/_api/functions/debug.html
@@ -1,6 +1,6 @@
 ---
 title: "Debug"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/functions/emergency.html b/docs/_api/functions/emergency.html
@@ -1,6 +1,6 @@
 ---
 title: "Emergency"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/functions/error.html b/docs/_api/functions/error.html
@@ -1,6 +1,6 @@
 ---
 title: "Error"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/functions/info.html b/docs/_api/functions/info.html
@@ -1,6 +1,6 @@
 ---
 title: "Info"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/functions/notice.html b/docs/_api/functions/notice.html
@@ -1,6 +1,6 @@
 ---
 title: "Notice"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/functions/warning.html b/docs/_api/functions/warning.html
@@ -1,6 +1,6 @@
 ---
 title: "Warning"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/hierarchy.html b/docs/_api/hierarchy.html
@@ -1,6 +1,6 @@
 ---
 title: "Hierarchy"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/index.html b/docs/_api/index.html
@@ -1,8 +1,7 @@
 ---
 title: "Index"
-layout: api
 parent: API Reference
-nav_order: auto
+nav_order: 1
 ---
 
 <div class="col-content"><div class="tsd-page-title"><h1>node-syslog API</h1>
diff --git a/docs/_api/interfaces/SyslogOptions.html b/docs/_api/interfaces/SyslogOptions.html
@@ -1,6 +1,6 @@
 ---
 title: "SyslogOptions"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/types/SyslogFacilityType.html b/docs/_api/types/SyslogFacilityType.html
@@ -1,6 +1,6 @@
 ---
 title: "SyslogFacilityType"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/types/SyslogLevelType.html b/docs/_api/types/SyslogLevelType.html
@@ -1,6 +1,6 @@
 ---
 title: "SyslogLevelType"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/types/SyslogOptionType.html b/docs/_api/types/SyslogOptionType.html
@@ -1,6 +1,6 @@
 ---
 title: "SyslogOptionType"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/variables/Facilities.html b/docs/_api/variables/Facilities.html
@@ -1,6 +1,6 @@
 ---
 title: "Facilities"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/variables/Levels.html b/docs/_api/variables/Levels.html
@@ -1,6 +1,6 @@
 ---
 title: "Levels"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/variables/Options.html b/docs/_api/variables/Options.html
@@ -1,6 +1,6 @@
 ---
 title: "Options"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/variables/SyslogFacility.html b/docs/_api/variables/SyslogFacility.html
@@ -1,6 +1,6 @@
 ---
 title: "SyslogFacility"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/variables/SyslogLevel.html b/docs/_api/variables/SyslogLevel.html
@@ -1,6 +1,6 @@
 ---
 title: "SyslogLevel"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/variables/SyslogOption.html b/docs/_api/variables/SyslogOption.html
@@ -1,6 +1,6 @@
 ---
 title: "SyslogOption"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_api/variables/defaultLogger.html b/docs/_api/variables/defaultLogger.html
@@ -1,6 +1,6 @@
 ---
 title: "DefaultLogger"
-layout: api
+
 parent: API Reference
 nav_order: auto
 ---
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -26,7 +26,7 @@ plugins:
   - jekyll-seo-tag
 permalink: pretty
 
-# Custom theme configuration
+# Just the Docs theme configuration
 color_scheme: light
 search_enabled: true
 heading_anchors: true
@@ -43,67 +43,9 @@ aux_links_new_tab: true
 # Google Analytics Tracking (optional)
 ga_tracking: ""
 
-# Navigation structure
-navigation:
-  - title: "Getting Started"
-    url: "/getting-started/"
-  - title: "Installation"
-    url: "/installation/"
-  - title: "Examples"
-    url: "/examples/"
-  - title: "API Reference"
-    url: "/_api/"
-    children:
-      - title: "Overview"
-        url: "/_api/"
-      - title: "Classes"
-        url: "/_api/classes/"
-      - title: "Interfaces"
-        url: "/_api/interfaces/"
-      - title: "Functions"
-        url: "/_api/functions/"
-      - title: "Types"
-        url: "/_api/types/"
-      - title: "Variables"
-        url: "/_api/variables/"
-  - title: "Migration Guide"
-    url: "/migration/"
-  - title: "Debugging"
-    url: "/debugging-guide/"
-  - title: "Performance"
-    url: "/performance-summary/"
-  - title: "TypeScript"
-    url: "/typescript-configuration/"
-
-# Exclude from processing
-exclude:
-  - Gemfile
-  - Gemfile.lock
-  - node_modules/
-  - vendor/bundle/
-  - vendor/cache/
-  - vendor/gems/
-  - vendor/ruby/
-  - "../src/"
-  - "../test/"
-  - "../scripts/"
-  - "../binding.gyp"
-  - "../.git/"
-  - "../.gitignore"
-  - "../README.md"
-  - "../package.json"
-  - "../package-lock.json"
-  - "../tsconfig.json"
-  - "../pnpm-lock.yaml"
-  - "../.eslintrc.js"
-  - "../vitest.config.ts"
-  - "../AGENTS.md"
-  - "../CONTRIBUTING.md"
-  - "../LICENSE.md"
-  - "../openspec/"
-  - "api/"  # Exclude original TypeDoc HTML directory
-  - "_layouts_backup/"
-  - "_includes_backup/"
+# Navigation structure - just-the-docs format
+nav_sort: case_insensitive
+exclude: ["Gemfile", "Gemfile.lock", "node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/", "src/", "test/", "scripts/", "binding.gyp", ".git/", ".gitignore", "README.md", "package.json", "package-lock.json", "tsconfig.json", "pnpm-lock.yaml", ".eslintrc.js", "vitest.config.ts", "AGENTS.md", "CONTRIBUTING.md", "LICENSE.md", "openspec/", "api/"]
 
 # Include for processing
 include:
diff --git a/docs/_layouts/api.html b/docs/_layouts/api.html
diff --git a/docs/api-overview.md b/docs/api-overview.md
diff --git a/docs/debugging-guide.md b/docs/debugging-guide.md
diff --git a/docs/examples.md b/docs/examples.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/installation.md b/docs/installation.md
diff --git a/docs/migration.md b/docs/migration.md
diff --git a/docs/performance-summary.md b/docs/performance-summary.md
diff --git a/docs/typescript-configuration.md b/docs/typescript-configuration.md
