PrimerPages/jekyll-awesome-nav

Awesome nav demo

Install

☰

This page appears under the overridden guides subtree.

Gemfile

Add the plugin to your site’s Gemfile:

gem "jekyll-awesome-nav"

If you use a :jekyll_plugins group, it is fine to place it there:

group :jekyll_plugins do
  gem "jekyll-awesome-nav"
end

Jekyll config

Add the plugin to _config.yml:

plugins:
  - jekyll-awesome-nav

Then configure the docs root:

awesome_nav:
  enabled: true
  root: docs
  nav_filename: .nav.yml

Layout default

Set a layout for the docs folder so every generated page receives the same navigation UI:

defaults:
  - scope:
      path: "docs"
    values:
      layout: awesome_nav_demo

The plugin generates the data. The layout decides how that data looks.

Plugin data Resolved page variables for this page

page.breadcrumbs

[{"title":"Documentation","url":"/docs/"},{"title":"Guides","url":"/docs/guides/"},{"title":"Install Guide","url":"/docs/guides/install/"}]

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

page.awesome_nav_next

{"title":"Layout Integration","url":"/docs/guides/layouts/"}