A plugin for customizing the navigation structure of your MkDocs site.
Project Links
Meta
Author: Lukas Geiter
Requires Python: >=3.10
Classifiers
License
- OSI Approved :: MIT License
Development Status
- 5 - Production/Stable
Intended Audience
- Developers
- Information Technology
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.
3.3.0
Dec 02, 2025
3.2.0
Sep 10, 2025
3.1.2
May 18, 2025
3.1.1
Apr 06, 2025
3.1.0
Mar 29, 2025
3.0.0
Feb 16, 2025
Wheel compatibility matrix
Files in release
Extras:
None
Dependencies:
mkdocs
(>=1.6.0)
natsort
(>=8.1.0)
pydantic
(>=2.0.2)
pydantic
(>=2.8.1)
wcmatch
(>=8.4)