Skip to content

Plugin Options

Filename

By default, awesome-nav looks for .nav.yml files. Change this using the filename plugin option:

plugins:
  - awesome-nav:
      filename: awesome_nav.yml

Log Level

You can customize the level of most log messages that awesome-nav produces:

plugins:
  - awesome-nav:
      logs:
        nav_override: info

The supported log levels are info, warning and error. The following messages can be configured:

Key Message Default Log Level
nav_override 'nav' config from mkdocs.yml is being replaced with one generated by awesome-nav warning / info (if monorepo plugin is used)
root_title 'title' option has no effect at the top level warning
root_hide 'hide' option has no effect at the top level warning
no_match The nav item '...' doesn't match any files or directories warning