PrimerPages/jekyll-awesome-nav

Awesome nav demo

Configuration

☰

Configure the plugin in _config.yml.

awesome_nav:
  enabled: true
  root: docs
  nav_filename: .nav.yml
  include:
    - "**/*.md"
    - "**/*.html"
    - "**/*.htm"
  ignore:
    - "assets/**"

Options

Option Default Description
enabled true Turns generation on or off.
root docs Folder that contains your documentation pages.
nav_filename .nav.yml Filename used for local subtree overrides.
include ["**/*.md", "**/*.html", "**/*.htm"] Source path globs eligible for nav generation.
ignore ["assets/**"] Source path globs excluded from nav generation.

include is evaluated first, then ignore removes matches.

Page titles

Generated items use page front matter when it is available:

---
title: Configuration
nav_title: Config
---

Use title for the page heading and nav_title when the navigation label should be shorter.

URLs

Jekyll controls the final page URL. The plugin reads those URLs from generated pages, so settings like permalink: pretty work normally.

Plugin data Resolved page variables for this page

page.breadcrumbs

[{"title":"Documentation","url":"/docs/"},{"title":"Guides","url":"/docs/guides/"},{"title":"Configuration","url":"/docs/guides/config/"}]

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":true,"contains_current":true},{"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":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":"Layout Integration","url":"/docs/guides/layouts/"}

page.awesome_nav_next

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