An MkDocs plugin that simplifies configuring page titles and their order through .pages configuration files
Create documentation navigation that explicitly lists pages, directories, custom sections, and an external link for the existing docs tree:
docs/index.mddocs/overview.mddocs/guides/intro.mddocs/guides/advanced.mddocs/api/index.md plus any additional API pages in that folderUse a .pages configuration file to define the navigation order and titles so the plugin picks up the structure without relying on automatic discovery. Enable the navigation plugin in mkdocs.yml (defaults are fine) so the .pages file is applied.
Home, Overview, Guides, API Reference, and Project Website in that order. @testGetting Started (docs/guides/intro.md) followed by Deep Dive (docs/guides/advanced.md). @testdocs/api/ directory as API Reference, preserving its internal ordering (starting with index.md) without flattening into the root. @testProject Website pointing to https://example.com/docs. @test@generates
# docs/.pages
nav:
- Home: index.md
- Overview: overview.md
- Guides:
- Getting Started: guides/intro.md
- Deep Dive: guides/advanced.md
- API Reference: api/
- Project Website: https://example.com/docsProvides .pages navigation processing to apply explicit entries for pages, directories, sections, and external links.
@satisfied-by
tessl i tessl/pypi-mkdocs-awesome-pages-plugin@2.10.0evals
scenario-1
scenario-2
scenario-3
scenario-4
scenario-5
scenario-6
scenario-7
scenario-8
scenario-9
scenario-10