{"id":24045,"library":"mkdocs-multirepo-plugin","title":"mkdocs-multirepo-plugin","description":"MkDocs plugin to build documentation from multiple repositories into one unified site. Version 0.8.3. Release cadence: irregular, several releases per year.","status":"active","version":"0.8.3","language":"python","source_language":"en","source_url":"https://github.com/jdoiro3/mkdocs-multirepo-plugin","tags":["mkdocs","plugin","documentation","multi-repo"],"install":[{"cmd":"pip install mkdocs-multirepo-plugin","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Required core dependency","package":"mkdocs","optional":false}],"imports":[{"note":"The plugin is registered by its short name 'multirepo', not the full package name.","wrong":"plugins:\n  - mkdocs-multirepo-plugin","symbol":"plugin","correct":"plugins:\n  - multirepo"}],"quickstart":{"code":"# mkdocs.yml\nsite_name: My Docs\nplugins:\n  - multirepo:\n      repos:\n        - section: Repo A\n          url: https://github.com/example/repo-a.git\n          branch: main\n","lang":"yaml","description":"Basic configuration to include documentation from an external git repository."},"warnings":[{"fix":"Ensure git is installed: `git --version` should succeed.","message":"The plugin requires the Git executable to be installed and available in PATH. Cloning repos fails silently if git is missing.","severity":"gotcha","affected_versions":"all"},{"fix":"Use `nav_repos` with a `nav` key to control navigation structure.","message":"The `repos` configuration parameter was deprecated in favour of `nav_repos` for navigation support. Using `repos` without a nav may yield unexpected navigation ordering.","severity":"deprecated","affected_versions":">=0.6.0"},{"fix":"Use relative paths starting from the docs directory, e.g., `!import path/to/file.md`.","message":"When using `!import` statements in mkdocs.yml, the path must be relative to the docs directory. Relative paths from project root cause import errors.","severity":"gotcha","affected_versions":"all"},{"fix":"Add `keep_docs_dir: true` to the plugin config if you want the docs_dir to remain unchanged.","message":"In version 0.6.0, the default behaviour changed: docs_dir contents are moved into a subdirectory. Set `keep_docs_dir: true` to preserve existing behaviour.","severity":"breaking","affected_versions":">=0.6.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Install with `pip install mkdocs-multirepo-plugin` and ensure configuration uses `- multirepo` (not `- mkdocs-multirepo-plugin`).","cause":"The plugin is not installed or configuration uses wrong name.","error":"Error: The plugin 'multirepo' does not exist"},{"fix":"Delete the cloned directory manually or use a CI clean step: `rm -rf <path>` before building docs.","cause":"The cloned repo directory already exists from a previous build. The plugin does not clean it automatically.","error":"fatal: destination path '<path>' already exists and is not an empty directory."},{"fix":"The correct import path is `from mkdocs_multirepo_plugin.plugin import MultiRepoPlugin`. However, the plugin should be used via mkdocs.yml, not imported directly.","cause":"Import error when trying to use plugin in Python code (e.g., for custom hooks).","error":"No module named 'mkdocs_multirepo_plugin'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}