mkdocs-awesome-pages-plugin

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

A plugin for MkDocs that lets you customize page navigation order and titles using `.pages` configuration files placed in your documentation directories, without needing to define the full navigation structure in `mkdocs.yml`.

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

pip install mkdocs-awesome-pages-plugin

uv add mkdocs-awesome-pages-plugin

poetry add mkdocs-awesome-pages-plugin

Installing mkdocs-awesome-pages-plugin

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.

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.md

Requires MkDocs version 1.0 or higher; plugin will not activate if mkdocs.yml already defines a nav or pages entry without a '...' placeholder.

Verify 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

Evidence: mkdocs_awesome_pages_plugin-2.10.1-py3-none-any.whl

Keywords: mkdocs, python, markdown, wiki

Tags

More Documentation packages