Skip to content

Reference

Plugin Options

plugins:
  - awesome-nav:
      filename: awesome_nav.yml #(1)!
  1. Name of your awesome-nav config files. str .nav.yml
title: Lorem Ipsum #(1)!

preserve_directory_names: true #(2)!

hide: true #(3)!

flatten_single_child_sections: true #(4)!

ignore: "*.hidden.md" #(5)!

sort:
  direction: asc #(6)!
  type: natural #(7)!
  by: filename #(8)!
  sections: last #(9)!
  ignore_case: true #(10)!

nav: #(11)!
  - getting-started.md
  - guides
  - More Resources:
    - "*"
    - Website: https://lukasgeiter.github.io/mkdocs-awesome-nav
  1. Custom title for this directory. Read more str
  2. Disable formatting of generated directory titles. Read more bool false
  3. Hide this directory in the navigation. Read more bool false
  4. For sections with a single child, show the child instead of the section. Read more bool false
  5. Hide everything that matches this glob pattern. Read more str | list[str]
  6. Sorting direction (ascending or descending). Read more asc | desc asc
  7. How numbers are treated when sorting. Read more natural | alphabetical natural
  8. Attribute that is used for sorting. Read more path | filename | title path
  9. How sections are treated when sorting. Read more first | last | mixed last
  10. Enable case-insensitive sorting. Read more bool false
  11. Custom navigation for this directory. Read more