Releases: jdoiro3/mkdocs-multirepo-plugin
Releases · jdoiro3/mkdocs-multirepo-plugin
Release v0.4.12
Changes in this Release
- Fixed use of GithubAccessToken environment variable so that the sparse clone now uses the correct token.
Release v0.4.11
Changes in this Release
- 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
andrepo_url
aren't set, and the Multirepoedit_uri
for an imported repo isn't set. Note that the edit url for imported repos hasn't been robustly tested yet.
Slugify Section Names and Changed Import Param Separator
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
0.3.6
v0.3.5
v0.3.3
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.
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'
v0.3.2
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).