A plugin that allows you to have several versions of the documentation built with mkdocs
Project description
mkdocs-multiversion-plugin
mkdocs-multiversion-plugin
is a plugin for mkdocs - a fast, simple and downright gorgeous gorgeous static site generator that's geared towards building project documentation.
mkdocs-multiversion-plugin
allows you to build and have different versions of your project documentation.
How It Works
mkdocs-multiversion-plugin
works by creating a new version of documentation inside mkdocs site_dir/<version>
directory and adds configuration file containing information about versions to site_dir/multiversion.json
. The plugin doesn't create new branches in your git repository.
Setup
Install the plugin using pip:
pip install mkdocs-multiversion-plugin
Next, add the following lines to your mkdocs.yml
:
plugins:
- multiversion
If you have no
plugins
entry in your config file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
entry set.
Configuration
Guide to all available configuration settings.
To change some behavior of the plugin you need to set proper config option in mkdocs.yml
under plugin section.
plugins:
- multiversion:
branch_whitelist: None
version_in_site_name: False
List of available config options:
Name | Type | Default value | Description |
---|---|---|---|
version_in_site_name |
string | True |
Adds the version name to the mkdocs site_name config. |
branch_whitelist |
string | ^.*$ |
Whitelist branch names, regex. |
tag_whitelist |
string | ^.*$ |
Whitelist tag names, regex. |
latest_version_name_format |
string | latest release ({version}) |
Latest version name format, argument: {version} . |
version_name_format |
string | {version} |
Version name format, argument: {version . |
css_dir |
string | css |
The name of the directory for css files. |
javascript_dir |
string | js |
The name of the directory for javascript files. |
Contributing
Please note that mkdocs-multiversion-plugin
is currently in Beta and there may be missing feature/documentation so if you could help out by either:
- finding and reporting bugs
- contributing by checking out the issues
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for mkdocs-multiversion-plugin-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4fb75a248ecabc98e535672357f7f14c2909f505266fe6260774458e1d4e3235 |
|
MD5 | f557507a79285764ab2b0bf159c1a941 |
|
BLAKE2b-256 | d8c980a411d998b3ee59ebf121151719adbe069eff4b017068c39196b876f65d |