mkdocs-awesome-pages-plugin
An MkDocs plugin that simplifies configuring page titles and their order
Decision gist · record as of 2026-08-14
Yes. The plugin is actively maintained, has no known vulnerabilities, installs with low friction, and solves a real pain point for MkDocs users managing complex documentation structures. It is stable (Production/Stable status) and widely used. Install if you use MkDocs and want finer control over navigation without maintaining a rigid mkdocs.yml structure.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires MkDocs version 1.0 or higher; plugin will not activate if mkdocs.yml already defines a nav or pages entry without a '...' placeholder.
- Low friction install with a pure-Python wheel.
- Actively maintained with recent commits and a stable release cycle; requires MkDocs 1.0 or higher and Python >=3.8.1.
License · maintenance · safety
MIT (permissive) — MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.
last release 2024-12-22 (600 days) · last repo commit 2026-04-10 · 625 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 921,472 downloads/mo, #4,719 on PyPI
Alternatives
Verify before relying
pip install mkdocs-awesome-pages-plugin
# In mkdocs.yml:
plugins:
- search
- awesome-pages
# In docs/.pages:
nav:
- introduction.md
- ...
- summary.md- Whether the plugin supports MkDocs 2.x versions beyond those listed in classifiers.
- Performance impact when managing large documentation trees with many nested directories.
What it is and what it does
This plugin extends MkDocs by allowing you to control page navigation and ordering through simple `.pages` YAML files placed in your documentation directories, rather than maintaining a monolithic navigation structure in `mkdocs.yml`. It depends on mkdocs, wcmatch, and natsort to parse configuration files, match patterns, and apply natural sort ordering.
You can customize titles, reorder pages, apply ascending or descending sort, use natural sort order, filter remaining items with glob patterns, group pages into sections, hide directories, and collapse single-page folders. The plugin integrates with MkDocs' file-based navigation, letting you define parts of your nav manually in `mkdocs.yml` and use `...` as a placeholder for auto-generated content from the file structure.
Use it for
- Reorder documentation pages without editing mkdocs.yml by creating .pages files in each directory.
- Apply custom titles to navigation entries while keeping the actual filenames unchanged.
- Sort documentation sections alphabetically or in reverse order using natural sort logic.
- Hide certain directories from navigation while keeping them accessible via direct URL.
- Combine manual navigation definition in mkdocs.yml with auto-generated structure for mixed control.
- Collapse single-page folders to reduce navigation nesting and improve readability.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The plugin is actively maintained, has no known vulnerabilities, installs with low friction, and solves a real pain point for MkDocs users managing complex documentation structures. It is stable (Production/Stable status) and widely used. Install if you use MkDocs and want finer control over navigation without maintaining a rigid mkdocs.yml structure.
Install
mkdocs-awesome-pages-plugin on PyPI
Before you install
Low friction install with a pure-Python wheel. Actively maintained with recent commits and a stable release cycle; requires MkDocs 1.0 or higher and Python >=3.8.1.
Requires MkDocs version 1.0 or higher; plugin will not activate if mkdocs.yml already defines a nav or pages entry without a '...' placeholder.
License in practice
MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.
Quickstart
pip install mkdocs-awesome-pages-plugin
# In mkdocs.yml:
plugins:
- search
- awesome-pages
# In docs/.pages:
nav:
- introduction.md
- ...
- summary.mdVerify before relying
- Whether the plugin supports MkDocs 2.x versions beyond those listed in classifiers.
- Performance impact when managing large documentation trees with many nested directories.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.8.1 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesmkdocswcmatchnatsort |
| Maintenance | Actively maintained 600 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 921,472 / month, #4,719 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 LicenseProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.9 |
Evidence: mkdocs_awesome_pages_plugin-2.10.1-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 ordering”
- mkdocs-awesome-pages-pluginA plugin for MkDocs that lets you customize page navigation order and…
- mkdocs-awesome-navA MkDocs plugin that lets you customize your site's navigation…
- mkdocs-literate-navMkDocs plugin that lets you define site navigation as Markdown lists…
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-nav · mkdocs-include-dir-to-nav · mkdocs-literate-nav · mkdocs-section-index · mkdocs-simple-hooks · mkdocs-task-collector · mkdocs-exclude · mkdocs-api-autonav · mkdocs-monorepo-plugin · mkdocs-auto-tag-plugin