Awesome nav demo
Use plain folders and pages when you want navigation to come directly from the docs tree.
docs/
├── index.md
├── getting-started.md
└── guides/
├── index.md
├── install.md
└── config.md
With no .nav.yml files, the plugin turns that structure into sections and pages automatically.
awesome_nav:
enabled: true
root: docs
nav_filename: .nav.yml
This is a good default when the filesystem already reflects the order and grouping you want.
page.breadcrumbs[{"title":"Documentation","url":"/docs/"},{"title":"Examples"},{"title":"Basic Folder Navigation","url":"/docs/examples/basic-folder-navigation/"}]
page.awesome_nav[{"title":"Getting Started","url":"/docs/getting-started/","current":false,"contains_current":false},{"title":"Guides","url":"/docs/guides/","children":[{"title":"Install Guide","url":"/docs/guides/install/","current":false,"contains_current":false},{"title":"Layout Integration","url":"/docs/guides/layouts/","current":false,"contains_current":false},{"title":"Configuration","url":"/docs/guides/config/","current":false,"contains_current":false},{"title":".nav.yml Reference","url":"/docs/guides/nav-file/","current":false,"contains_current":false},{"title":"Navigation Overrides","url":"/docs/guides/overrides/","current":false,"contains_current":false},{"title":"Generated Data","url":"/docs/guides/data/","current":false,"contains_current":false}],"current":false,"contains_current":false},{"title":"Examples","children":[{"title":"Examples Home","url":"/docs/examples/","current":false,"contains_current":false},{"title":"Basic Folder Navigation","url":"/docs/examples/basic-folder-navigation/","current":true,"contains_current":true},{"title":"Local Override","url":"/docs/examples/local-override/","current":false,"contains_current":false}],"current":false,"contains_current":true}]
page.awesome_nav_local[{"title":"Getting Started","url":"/docs/getting-started/"},{"title":"Guides","url":"/docs/guides/","children":[{"title":"Install Guide","url":"/docs/guides/install/"},{"title":"Layout Integration","url":"/docs/guides/layouts/"},{"title":"Configuration","url":"/docs/guides/config/"},{"title":".nav.yml Reference","url":"/docs/guides/nav-file/"},{"title":"Navigation Overrides","url":"/docs/guides/overrides/"},{"title":"Generated Data","url":"/docs/guides/data/"}]},{"title":"Examples","children":[{"title":"Examples Home","url":"/docs/examples/"},{"title":"Basic Folder Navigation","url":"/docs/examples/basic-folder-navigation/"},{"title":"Local Override","url":"/docs/examples/local-override/"}]}]
page.awesome_nav_dir"docs"
page.awesome_nav_previous{"title":"Examples Home","url":"/docs/examples/"}
page.awesome_nav_next{"title":"Local Override","url":"/docs/examples/local-override/"}