PrimerPages/jekyll-awesome-nav

Awesome nav demo

Navigation Overrides

☰

By default, the plugin builds navigation from files and folders. A local .nav.yml lets a folder replace its own subtree.

This demo has an override at docs/guides/.nav.yml:

nav:
  - Guides Hub: index.md
  - Install Guide: install.md
  - Layout Integration: layouts.md
  - Configuration: config.md

When to use an override

Use .nav.yml when a section needs:

  • a custom order
  • shorter or clearer labels
  • links that do not map one-to-one with filenames
  • a curated subset of pages
  • generated batches mixed with manual items
  • hidden sections or filtered globs

What gets replaced

An override replaces the subtree for the directory where it appears. Other directories still use generated navigation.

For example, docs/guides/.nav.yml controls the guides section only. The root docs/ tree is still generated from the folder structure and then uses the guides override for that branch.

Each item uses a Title: path.md entry. Nested sections use a list:

nav:
  - Section:
      - Page: section/page.md

Use Markdown source paths. The plugin resolves them through Jekyll pages and then uses the final page URL.

More options

.nav.yml also supports:

  • glob entries like "*.md" and "*/"
  • append_unmatched: true to append generated items you did not list manually
  • ignore: to filter generated matches
  • sort: to order generated batches
  • hide: true to remove a subtree entirely

The full syntax and option reference lives in .nav.yml Reference.

Plugin data Resolved page variables for this page

page.breadcrumbs

[{"title":"Documentation","url":"/docs/"},{"title":"Guides","url":"/docs/guides/"},{"title":"Navigation Overrides","url":"/docs/guides/overrides/"}]

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":true,"contains_current":true},{"title":"Generated Data","url":"/docs/guides/data/","current":false,"contains_current":false}],"current":false,"contains_current":true},{"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":false,"contains_current":false},{"title":"Local Override","url":"/docs/examples/local-override/","current":false,"contains_current":false}],"current":false,"contains_current":false}]

page.awesome_nav_local

[{"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/"}]

page.awesome_nav_dir

"docs/guides"

page.awesome_nav_previous

{"title":".nav.yml Reference","url":"/docs/guides/nav-file/"}

page.awesome_nav_next

{"title":"Generated Data","url":"/docs/guides/data/"}