Home
Softono
mkdocs-awesome-nav

mkdocs-awesome-nav

Open source MIT Python
624
Stars
43
Forks
23
Issues
8
Watchers
2 months
Last Commit

About mkdocs-awesome-nav

A plugin for customizing the navigation structure of your MkDocs site.

Platforms

Web Self-hosted

Languages

Python

Awesome Nav for MkDocs

Formerly known as mkdocs-awesome-pages-plugin. Read more about the change

This MkDocs plugin gives you full control over your navigation structure without having to write the entire thing by hand. Whether you just want to add an external link or restructure the entire navigation tree, awesome-nav has you covered.

Feature Highlights

  • Adjusting Item Order: Manually re-order navigation items or use the extensive sorting options.
  • Adding Sections & Links: Create sections and add external links.
  • Customizing Titles: Change the title of sections and override page titles.
  • Hiding Pages: Hide pages or entire sections from the navigation, making them only accessible by url.
  • Using Glob Patterns: Match files using glob patterns to show or hide them.

Check out the documentation for more information and examples.