Skip to content

backstage/mkdocs-monorepo-plugin

PyPI PyPI - License

Note: This plugin is in beta. Whilst it is not expected to significantly change in functionality, it may not yet be fully compatible with other Mkdocs configuration and thus may break with some advanced configurations. Once these have been resolved and all bugs have been ironed out, we will move this to a stable release.

✚ 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:

$ pip install mkdocs-monorepo-plugin

Usage

Take a look at our sample project or do the following:

  • In the root, add the monorepo to your plugins key in mkdocs.yml
  • Create a subfolder, with a mkdocs.yml with a site_name and nav, as well as a docs/ folder with an index.md
  • Back in in the root mkdocs.yml, use the !include syntax in your nav to link to to a subfolder mkdocs.yml

Example root /mkdocs.yml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
site_name: Cats API

# You can declare "!include" statements here. This enables you
# to include mkdocs.yml that are located in subfolders. In this
# case we have two folders (v1/ and v2/) and wish to merge them
# into this single navigation. The 'Intro' and 'Authentication'
# files are located in the root docs/ folder as usual.

nav:
  - Intro: 'index.md'
  - Authentication: 'authentication.md'
  - API:
    - v1: '!include ./v1/mkdocs.yml'
    - v2: '!include ./v2/mkdocs.yml'

plugins:
  - monorepo

Example submodule /v1/mkdocs.yml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# In this case, we use the site_name to figure out how we should merge
# this with the root documentation. It should refer to a folder structure.
# The example below will merge documentation as following:
#
#   reference.md -> docs/versions/v1/reference.md -> http://localhost:8000/versions/v1/reference/
#   changelog.md -> docs/versions/v1/changelog.md -> http://localhost:8000/versions/v1/changelog/
#

site_name: versions/v1

nav:
  - Reference: "reference.md"
  - Changelog: "changelog.md"

nav:
  - code-samples.md

Example submodule /v2/mkdocs.yml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# It works the same as above, but with relative to the site_name we use here:
#
#   migrating.md -> docs/versions/v2/migrating.md -> http://localhost:8000/versions/v2/migrating/
#   reference.md -> docs/versions/v2/reference.md -> http://localhost:8000/versions/v2/reference/
#   changelog.md -> docs/versions/v2/changelog.md -> http://localhost:8000/versions/v2/changelog/

site_name: versions/v2

nav:
  - Migrating to v2: "migrating.md"
  - Reference: "reference.md"
  - Changelog: "changelog.md"

An example filetree when using the Mkdocs Monorepo plugin looks like this:

$ tree .

├── docs
│   ├── authentication.md
│   └── index.md
├── mkdocs.yml
├── v1
│   ├── docs
│   │   ├── changelog.md
│   │   └── reference.md
│   └── mkdocs.yml
└── v2
    ├── docs
    │   ├── changelog.md
    │   ├── migrating.md
    │   └── reference.md
    └── mkdocs.yml

5 directories, 10 files

Supported Versions

  • Python 3 — 3.6, 3.7
  • Mkdocs 1.0.4 and above.

License

Released under the Apache 2.0 License. See here for more details.

Contributing

Check out our CONTRIBUTING for more details.

Extra Reading