{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"}],"enrichment":{"capability":"Merges documentation from multiple Git repositories into a single MkDocs site, keeping docs distributed across repos while building them into one searchable site.","skillfed_tags":["mkdocs-plugin","monorepo","documentation-aggregation"],"use_cases":["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."],"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\u2014each with its own mkdocs.yml\u2014and 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.\n\nThe 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.","worth_installing":"Yes, if you need to aggregate documentation from multiple Git repositories into one MkDocs site. The plugin is actively maintained, has no known vulnerabilities, and low install friction. It's suitable for production use in CI/CD pipelines. Install only if you actually have multiple documentation sources to merge; for single-repo documentation, standard MkDocs is simpler."},"id":"mkdocs-multirepo-plugin","links":{"html":"https://skillfed.io/packages/mkdocs-multirepo-plugin","md":"https://skillfed.io/packages/mkdocs-multirepo-plugin.md","pypi":"https://pypi.org/project/mkdocs-multirepo-plugin/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2024-08-13","license_spdx":null,"license_treatment":"permissive","name":"mkdocs-multirepo-plugin","python_support":"unspecified","summary":"Build documentation in multiple repos into one site."},"popularity":{"monthly_downloads":74434,"position":14831,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.8.3"}