mkdocs-monorepo-plugin
Plugin for adding monorepository support in Mkdocs.
Decision gist · record as of 2026-08-14
Yes, if you have a monorepo or multi-team codebase and need to organize documentation across multiple folders. The plugin is stable and has low install friction. However, note that maintenance is aging (435 days since last release); verify that it works with your specific mkdocs version and plugin ecosystem before committing to it for a critical project.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or later and mkdocs 1.0.4 or above.
- Each included mkdocs.yml must have a corresponding docs folder in the same directory.
- Low install friction with only two runtime dependencies (mkdocs and python-slugify).
License · maintenance · safety
Apache-2.0 (permissive) — Licensed under Apache-2.0 (permissive), allowing commercial and private use with minimal restrictions; you must include a copy of the license and state significant changes.
last release 2025-06-05 (435 days) · last repo commit 2025-06-15 · 398 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 2,021,911 downloads/mo, #3,358 on PyPI
Alternatives
Verify before relying
pip install mkdocs-monorepo-plugin
# In root mkdocs.yml:
nav:
- Home: 'index.md'
- API:
- v1: '!include ./v1/mkdocs.yml'
- v2: '!include ./v2/mkdocs.yml'
plugins:
- monorepo- Whether Git Submodules integration for cross-repository documentation merging is fully functional in current versions
- Compatibility with mkdocs plugins beyond the core ecosystem
- Performance characteristics when merging documentation from many subfolders
What it is and what it does
This plugin extends Mkdocs to support documentation structures spread across multiple folders and configuration files, rather than requiring all docs in a single location. It introduces an `!include` directive in mkdocs.yml that lets you reference separate mkdocs.yml files from subdirectories, which the plugin then merges into a unified site. This is designed for large codebases—especially monorepos—where different teams own different parts of the codebase and want to maintain their documentation close to their code.
The plugin preserves the normal Mkdocs developer experience: you can run `mkdocs serve` at the root to see the merged documentation with live reload, or in a subfolder to work on a single section. It also supports glob-style patterns (via `*include`) to automatically include multiple matching configuration files without listing each one individually.
Use it for
- Building unified API documentation for a monorepo where each API version lives in its own folder with its own mkdocs.yml
- Organizing documentation by team ownership in a large codebase, with each team maintaining their own docs folder and navigation
- Merging documentation from multiple Git repositories using submodules into a single published site
- Maintaining separate changelogs and reference docs for different components while presenting them under one navigation structure
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you have a monorepo or multi-team codebase and need to organize documentation across multiple folders.
The plugin is stable and has low install friction. However, note that maintenance is aging (435 days since last release); verify that it works with your specific mkdocs version and plugin ecosystem before committing to it for a critical project.
Install
mkdocs-monorepo-plugin on PyPI
Before you install
Low install friction with only two runtime dependencies (mkdocs and python-slugify). Maintenance status is aging—last release was 435 days ago—but the repository remains active and the package is marked Production/Stable.
Requires Python 3.9 or later and mkdocs 1.0.4 or above. Each included mkdocs.yml must have a corresponding docs folder in the same directory.
License in practice
Licensed under Apache-2.0 (permissive), allowing commercial and private use with minimal restrictions; you must include a copy of the license and state significant changes.
Quickstart
pip install mkdocs-monorepo-plugin
# In root mkdocs.yml:
nav:
- Home: 'index.md'
- API:
- v1: '!include ./v1/mkdocs.yml'
- v2: '!include ./v2/mkdocs.yml'
plugins:
- monorepoVerify before relying
- Whether Git Submodules integration for cross-repository documentation merging is fully functional in current versions
- Compatibility with mkdocs plugins beyond the core ecosystem
- Performance characteristics when merging documentation from many subfolders
Package facts
| License | Apache-2.0 permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesmkdocspython-slugify |
| Maintenance | Aging 435 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 2,021,911 / month, #3,358 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 TechnologyProgramming Language :: PythonProgramming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.9 |
Evidence: mkdocs_monorepo_plugin-1.1.2-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 multiple docs folders”
- mkdocs-monorepo-pluginEnables building multiple sets of documentation from separate folders…
- mkdocs-meta-managerA MkDocs plugin that automatically applies meta tags to markdown…
- mkdocs-multirepo-pluginMerges documentation from multiple Git repositories into a single…
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-multirepo-plugin · mkdocs-techdocs-core · mkdocs-task-collector · mkdocs-simple-hooks · mkdocs-same-dir · mkdocs-meta-manager · mkdocs-awesome-pages-plugin · mkdocs-include-dir-to-nav · mkdocs-section-index · mkdocs-literate-nav