mkdocs-multirepo-plugin

What it is and what it does

mkdocs-multirepo-plugin is an MkDocs plugin that pulls documentation from multiple Git repositories and builds them into a single searchable site. Instead of centralizing all docs in one repo, you keep documentation close to the code in separate repositories—each with its own mkdocs.yml—and the plugin fetches and merges them during the build process. It supports three import methods: automatic directory-based navigation via the `repos` config, explicit file imports via `nav_repos`, or inline `!import` statements in your nav section. Documentation is fetched asynchronously using asyncio, and the plugin can run in CI/CD pipelines.

The plugin is designed for monorepos and multi-service architectures where different teams maintain separate documentation but need a unified site. Configuration happens entirely within mkdocs.yml, and you can control which branch or tag to import, customize the docs directory path, and optionally preserve the docs directory structure in the final build.

Use it for

• Build a unified documentation site for a microservices architecture where each service team maintains its own docs repository.
• Aggregate documentation from multiple open-source projects into a single searchable reference site.
• Create a monorepo documentation site that pulls docs from multiple project subdirectories, each with its own mkdocs.yml.
• Maintain a central documentation hub that imports README and docs from upstream projects without forking them.
• Set up a CI/CD pipeline that automatically rebuilds documentation when multiple source repositories change.

Worth the install?

AI-flagged interpretation of the facts on this page. Verify before relying on it.

Install

mkdocs-multirepo-plugin on PyPI

Before you install

Low install friction with a pure-Python wheel distribution. Actively maintained as of 2026-03-19 with 195 repository stars. Six runtime dependencies are all standard Python packages, and asyncio-based imports mean documentation builds asynchronously.

Requires Git to be installed and accessible; newer versions of Git are preferred per the documentation.

License in practice

MIT license (permissive) means you can use, modify, and distribute this plugin freely with minimal restrictions—suitable for both open-source and commercial projects.

Quickstart

pip install mkdocs-multirepo-plugin

# In mkdocs.yml:
plugins:
  - multirepo:
      cleanup: true

nav:
  - Home: 'index.md'
  - Docs: '!import https://github.com/user/repo'

Package facts

Evidence: mkdocs_multirepo_plugin-0.8.3-py2.py3-none-any.whl

Tags

More Documentation packages

See also mkdocs-monorepo-plugin · mkdocs-redirects · mkdocs-same-dir · mkdocs-task-collector · mkdocs-techdocs-core · pierre-storage · poetry-multiproject-plugin · mkdocs-with-pdf · mkdocs-section-index · mkdocs-simple-hooks