Configuration
Configure the plugin in _config.yml.
awesome_nav:
enabled: true
root: docs
nav_filename: _nav.yml
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. |
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.