From b0bb32da5339a09917ac0e6568df559f5f6201bf Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Thu, 10 Jul 2025 15:43:46 -0400 Subject: [PATCH] number sections and document sidebar ordering --- .../01-install.md | 0 .../02-build.md | 0 .../index.md | 0 docs/content/{features => 02-features}/index.md | 2 +- docs/content/02-features/navigation.md | 14 ++++++++++++++ .../{customization => 03-customization}/index.md | 0 .../{customization => 03-customization}/plugins.md | 0 .../content/{deployment => 04-deployment}/index.md | 0 .../{advanced => 05-advanced}/api/endpoints.md | 0 docs/content/{advanced => 05-advanced}/index.md | 0 .../01-install.md | 0 .../index.md | 0 .../{advanced => 02-advanced}/api/endpoints.md | 0 13 files changed, 15 insertions(+), 1 deletion(-) rename docs/content/{getting-started => 01-getting-started}/01-install.md (100%) rename docs/content/{getting-started => 01-getting-started}/02-build.md (100%) rename docs/content/{getting-started => 01-getting-started}/index.md (100%) rename docs/content/{features => 02-features}/index.md (75%) create mode 100644 docs/content/02-features/navigation.md rename docs/content/{customization => 03-customization}/index.md (100%) rename docs/content/{customization => 03-customization}/plugins.md (100%) rename docs/content/{deployment => 04-deployment}/index.md (100%) rename docs/content/{advanced => 05-advanced}/api/endpoints.md (100%) rename docs/content/{advanced => 05-advanced}/index.md (100%) rename starter/content/{getting-started => 01-getting-started}/01-install.md (100%) rename starter/content/{getting-started => 01-getting-started}/index.md (100%) rename starter/content/{advanced => 02-advanced}/api/endpoints.md (100%) diff --git a/docs/content/getting-started/01-install.md b/docs/content/01-getting-started/01-install.md similarity index 100% rename from docs/content/getting-started/01-install.md rename to docs/content/01-getting-started/01-install.md diff --git a/docs/content/getting-started/02-build.md b/docs/content/01-getting-started/02-build.md similarity index 100% rename from docs/content/getting-started/02-build.md rename to docs/content/01-getting-started/02-build.md diff --git a/docs/content/getting-started/index.md b/docs/content/01-getting-started/index.md similarity index 100% rename from docs/content/getting-started/index.md rename to docs/content/01-getting-started/index.md diff --git a/docs/content/features/index.md b/docs/content/02-features/index.md similarity index 75% rename from docs/content/features/index.md rename to docs/content/02-features/index.md index aef605a..130fa64 100644 --- a/docs/content/features/index.md +++ b/docs/content/02-features/index.md @@ -2,7 +2,7 @@ Archivox automatically turns your Markdown files into a full documentation site with a responsive layout and search. -* Sidebar navigation generated from folders +* Sidebar navigation generated from folders (prefix names with numbers to control order) * Collapsible mobile menu and dark-mode switch * Client-side search powered by Lunr.js * Shortcodes for rich content (images, tabs, notes) diff --git a/docs/content/02-features/navigation.md b/docs/content/02-features/navigation.md new file mode 100644 index 0000000..4de05d3 --- /dev/null +++ b/docs/content/02-features/navigation.md @@ -0,0 +1,14 @@ +# Controlling Sidebar Order + +Archivox builds the sidebar by scanning the `content/` directory. Folders and files are sorted alphabetically by default. To set a custom order, prefix the names with numbers like `01-` or `02-`. + +``` +content/ + 01-getting-started/ + 01-install.md + 02-build.md + 02-features/ + 03-customization/ +``` + +Numbers are stripped from the displayed titles, but they determine the ordering in the navigation. Nested folders work the same way, letting you create subsections within a section. diff --git a/docs/content/customization/index.md b/docs/content/03-customization/index.md similarity index 100% rename from docs/content/customization/index.md rename to docs/content/03-customization/index.md diff --git a/docs/content/customization/plugins.md b/docs/content/03-customization/plugins.md similarity index 100% rename from docs/content/customization/plugins.md rename to docs/content/03-customization/plugins.md diff --git a/docs/content/deployment/index.md b/docs/content/04-deployment/index.md similarity index 100% rename from docs/content/deployment/index.md rename to docs/content/04-deployment/index.md diff --git a/docs/content/advanced/api/endpoints.md b/docs/content/05-advanced/api/endpoints.md similarity index 100% rename from docs/content/advanced/api/endpoints.md rename to docs/content/05-advanced/api/endpoints.md diff --git a/docs/content/advanced/index.md b/docs/content/05-advanced/index.md similarity index 100% rename from docs/content/advanced/index.md rename to docs/content/05-advanced/index.md diff --git a/starter/content/getting-started/01-install.md b/starter/content/01-getting-started/01-install.md similarity index 100% rename from starter/content/getting-started/01-install.md rename to starter/content/01-getting-started/01-install.md diff --git a/starter/content/getting-started/index.md b/starter/content/01-getting-started/index.md similarity index 100% rename from starter/content/getting-started/index.md rename to starter/content/01-getting-started/index.md diff --git a/starter/content/advanced/api/endpoints.md b/starter/content/02-advanced/api/endpoints.md similarity index 100% rename from starter/content/advanced/api/endpoints.md rename to starter/content/02-advanced/api/endpoints.md