{"repo":"backstage/mkdocs-monorepo-plugin","free":true,"listed":false,"github":"https://github.com/backstage/mkdocs-monorepo-plugin","clone":"git clone https://github.com/backstage/mkdocs-monorepo-plugin.git","description":"✚ Build multiple documentation folders in a single Mkdocs. Designed for large codebases.","language":"Python","stars":399,"topics":["documentation","mkdocs","plugin","monoliths","monorepos","mkdocs-monorepo-plugin"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"backstage/mkdocs-monorepo-plugin ✚ This plugin enables you to build multiple sets of documentation in a single Mkdocs. It is designed to address writing documentation in Spotify's largest and most business-critical codebases (typically monoliths or monorepos). ✏️ Blog Post 🐍 Python Package ✚ Demo 📕 Docs Features - Support for multiple docs/ folders in Mkdocs. Having a single docs/ folder in a large codebase is hard to maintain. Who owns which documentation? What code is it associated with? Bringing docs closer to the associated code enables you to update them better, as well as leverage folder-based features such as [GitHub Codeowners]. - Support for multiple navigations. In Spotify, large repositories typically are split up by multiple owners. These are split by folders. By introducing multiple mkdocs.yml files along with multiple docs/ folder, each team can take ownership of their own navigation. This plugin then intelligently merges of the documentation together into a single repository. - Support across multiple repositories. Using Git Submodules it is possible to merge documentation across multiple repositories into a single codebase dynamically. - The same great Mkdocs developer experience. It is possible to run mkdocs serve in the root to merge all of your documentation together, or in a subfolder to build specific documentation. Autoreload still works as usual. No more using symlinks! Install It's easy to get started using [PyPI] and pip using Python: Usage Take a l","default_branch":null,"files":null,"tree":[],"storefront":"/r/backstage","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/backstage/mkdocs-monorepo-plugin/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}