PrimerPages/jekyll-awesome-nav

Awesome nav demo

Generated Data

☰

The plugin writes navigation data onto each page under the configured docs root.

Page variables

Variable Description
page.awesome_nav Full resolved docs tree with current and contains_current state for rendering.
page.awesome_nav_local Navigation items for the current directory context.
page.awesome_nav_dir Directory that supplied the current local nav context.
page.breadcrumbs Lightweight breadcrumb entries for the current page.
page.awesome_nav_previous Previous page in the resolved navigation order.
page.awesome_nav_next Next page in the resolved navigation order.

For README-indexed directories, these values are computed using the directory index URL (for example /ros2/) rather than a nested README leaf item.

Tree item shape

Navigation entries are hashes with a title, URL, optional children, and current-state flags:

title: Install Guide
url: /docs/guides/install/
current: true
contains_current: true
children: []

Layouts should treat children as optional because leaf pages do not need nested items.

Breadcrumb items stay lightweight. Linked entries include url; grouping entries may only include title:

title: Install Guide
url: /docs/guides/install/

Site variables

The plugin also writes resolved data into site.config for advanced theme use:

Variable Description
site.awesome_nav_tree Full resolved tree.
site.awesome_nav_local_map Local navigation lookup by directory.
site.awesome_nav_files Loaded .nav.yml data.

When the site uses jekyll-readme-index, generated README index pages are included in these resolved structures because awesome-nav runs after low-priority generators.

Most layouts should prefer the page.* variables because they are already scoped to the current page.

Plugin data Resolved page variables for this page

page.breadcrumbs

[{"title":"Documentation","url":"/docs/"},{"title":"Guides","url":"/docs/guides/"},{"title":"Generated Data","url":"/docs/guides/data/"}]

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":true,"contains_current":true}],"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":"Navigation Overrides","url":"/docs/guides/overrides/"}

page.awesome_nav_next

{"title":"Examples Home","url":"/docs/examples/"}