jdoiro3/mkdocs-multirepo-plugin

📦 Prs in Release

• [Fix script execution in virtualenvs](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/156)

📦 Prs in Release

• [Fix Version Parsing and Git Version Check](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/151)

📦 Prs in Release

• [Better Git Version Parsing and Checking](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/148)

📦 Prs in Release

• [Support edit_url starting with http](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/120)
• [Support Gitlab CI job token](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/145)

📦 Prs in Release

• [Fix section case](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/124)
• [Remove deprecation warning](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/131)

📦 Prs in Release

• [Only exclude mkdocs config YAML files.](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/117)

📦 Prs in Release

• [Fix deps for Python 3.10](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/104)

📦 Prs in Release

• [Disable globbing in clone scripts](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/86)
• [Fix keep docs dir](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/89)

📦 Prs in Release

• [Add support for nav repos](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/80)

✨ Added Features

• A new `nav_repos` was added to the configuration. This is similar to the `repos` configuration except that `nav_repos`
• expects a `nav` to be present to use in the navigation. This configuration can also be used along with `!import` statements.
• <details><summary><b>See example</b></summary>
• ```yaml
• plugins:
• search
• multirepo:
• cleanup: false
• + 19 more

📦 PRs in Release

• [Create .git/info dir if it does not exist](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/59)
• [Fix edit urls and add new `keep_docs_dir` config param](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/75)
• [Fix Readme](https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/77)

✨ Added Features

• ```yaml
• plugins:
• search
• multirepo:
• keep_docs_dir: true
• ```

📋 Changes

• Fixed use of GithubAccessToken environment variable so that the sparse clone now uses the correct token.

📋 Changes

• Added a specific `GithubAccessToken` environment variable that allows usage of the plugin with GitHub Apps-generated access tokens and personal access tokens.
• Fixed edit urls for imported repos where the the Mkdocs `edit_uri` and `repo_url` aren't set, and the Multirepo `edit_uri` for an imported repo isn't set. Note that the edit url for imported repos hasn't been robustly tested yet.

💥 Breaking Changes

• Previously, you would separate config values in an `!import` statement using multiple ampersands (`&`). Now, the `!import` statement will follow general URL syntax, where the url and query string (config values) is separated by one question mark (`?`) and then each config section is separated by an ampersand. Below is an example `!import` statement.
• `'!import {url}?branch={branch}&docs_dir={path}&multi_docs={True | False}&config={filename}.yml'`

📋 Other Changes

• Section names are slugified for clear urls (see PR https://github.com/jdoiro3/mkdocs-multirepo-plugin/pull/28 and Issue https://github.com/jdoiro3/mkdocs-multirepo-plugin/issues/24 for details). This most likely will change in future releases.

✨ Additions

• Previously, `!import` statements could only be included within top level sections in the *nav*. Now, the `!import` statement can be located anywhere in the *nav*.
• ```yaml
• nav:
• Home: index.md
• microservice:
• Home: test.md
• ServiceA: '!import https://github.com/jdoiro3/mkdocs-multirepo-demoRepo1?branch=main'
• ServiceB: '!import https://github.com/jdoiro3/mkdocs-multirepo-demoRepo1?branch=main'
• + 1 more

✨ Additions

• Users can now store the *multirepo* config file for an imported repo either within the *docs* directory or the *root* directory. If the name of the config isn't *mkdocs.yml*, it can also be specified via the new url parameter: *?config={filename}.yml*.

📋 Changes

• Fixed the issue where build outputs contained configuration files (see issue #9 for details).

📋 Changes

• Section names with spaces were causing two directories to be created when the version of `git` was old (i.e., `sparse_clone_old.sh` was run).

✨ Additions

• Added the ability to call `mkdocs serve` in an imported repo

✨ Additions

• Added support for macOS

📋 Changes

• Fixed bug in nav based importing.

✨ Additions

• Added a progress bar in the terminal output

✨ Features

• Build docs from multiple repos into one site
• Importing repos that are monorepos (not tested well)
• Run `mkdocs serve` within an imported repo for local development (not tested well)