mkdocs-awesome-nav
A plugin for customizing the navigation structure of your MkDocs site.
Decision gist · record as of 2026-08-14
Yes. The plugin is actively maintained, has low install friction, carries a permissive MIT license, and solves a real problem for MkDocs users managing growing documentation. No known vulnerabilities. Install it if you're using MkDocs and want more flexible navigation control than the default config allows.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later.
- Low friction install with a stable, recently-active codebase.
- The package depends on mkdocs, natsort, pydantic, and wcmatch—all common, well-maintained libraries.
License · maintenance · safety
permissive license (permissive) — Licensed under MIT (permissive), so you can use, modify, and distribute this plugin freely in both open and closed projects with minimal restrictions.
last release 2025-12-02 (255 days) · last repo commit 2026-04-10 · 625 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 1,120,316 downloads/mo, #4,340 on PyPI
Alternatives
Verify before relying
pip install mkdocs-awesome-nav
Then add to mkdocs.yml:
plugins:
- awesome-nav- Whether the plugin works with all current MkDocs versions or has specific version constraints beyond what the fact sheet states.
What it is and what it does
Awesome Nav is a MkDocs plugin that gives you declarative control over your documentation site's navigation without hand-writing the entire structure. Instead of manually listing every page in your mkdocs.yml, you define rules in a separate nav configuration file—reorder items, create sections, add external links, hide pages, and use glob patterns to match files. It sits on top of MkDocs and relies on natsort for sorting, pydantic for configuration validation, and wcmatch for glob pattern matching.
The plugin is useful when your documentation grows beyond a handful of pages and you want flexible, maintainable control over how visitors navigate it. It's actively maintained, has no known security vulnerabilities, and is in the top 5000 PyPI packages by download volume.
Use it for
- Reorder documentation pages without editing mkdocs.yml directly, using sorting rules or manual ordering.
- Hide sensitive or draft pages from navigation while keeping them accessible by direct URL.
- Add external links (e.g., to a blog or external resource) directly in the navigation tree.
- Match and organize pages using glob patterns instead of listing them one by one.
- Customize page titles in navigation independently of their actual file names or frontmatter.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The plugin is actively maintained, has low install friction, carries a permissive MIT license, and solves a real problem for MkDocs users managing growing documentation. No known vulnerabilities. Install it if you're using MkDocs and want more flexible navigation control than the default config allows.
Install
mkdocs-awesome-nav on PyPI
Before you install
Low friction install with a stable, recently-active codebase. The package depends on mkdocs, natsort, pydantic, and wcmatch—all common, well-maintained libraries. Last commit was 2026-04-10 and the project is marked active.
Requires Python 3.10 or later.
License in practice
Licensed under MIT (permissive), so you can use, modify, and distribute this plugin freely in both open and closed projects with minimal restrictions.
Quickstart
pip install mkdocs-awesome-nav
Then add to mkdocs.yml:
plugins:
- awesome-navVerify before relying
- Whether the plugin works with all current MkDocs versions or has specific version constraints beyond what the fact sheet states.
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesmkdocsnatsortpydanticwcmatch |
| Maintenance | Actively maintained 255 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 1,120,316 / month, #4,340 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableIntended Audience :: DevelopersIntended Audience :: Information TechnologyLicense :: OSI Approved :: MIT License |
Evidence: mkdocs_awesome_nav-3.3.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs navigation customization”
- mkdocs-awesome-navA MkDocs plugin that lets you customize your site's navigation…
- mkdocs-awesome-pages-pluginA plugin for MkDocs that lets you customize page navigation order and…
- mkdocs-include-dir-to-navA MkDocs plugin that automatically expands directory references in…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also mkdocs-awesome-pages-plugin · mkdocs-include-dir-to-nav · mkdocs-literate-nav · mkdocs-api-autonav · mkdocs-section-index · mkdocs-exclude · mkdocs-monorepo-plugin · mkdocs-auto-tag-plugin · mkdocs-multirepo-plugin · mkdocs-redirects