mkdocs-versioning is a plugin for mkdocs, a tool designed to create static websites usually for generating project documentation.
mkdocs-versioning extends mkdocs by differentiating between different versions of documentation you may build. For example, a newer versions of some software may work differently from an older version and it is important that users of an older version of the software reads the appropriate version of the documentation in order to ensure that the user has the correct information and uses the software appropriately.
The project is no longer maintained. Instead, use https://github.com/jimporter/mike as it is more popular and is under active development. The plugin should still work as long as mkdocs does not change how it builds documentation. If you are willing to take over the project, feel free to get in touch.
Install the plugin using pip:
pip install mkdocs-versioningNext, add the following lines to your mkdocs.yml:
plugins:
- search
- mkdocs-versioning:
version: 0.3.0If you have no
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set.
Instructions on how to use the plugin is available at https://zayd62.github.io/mkdocs-versioning/
Please note that mkdocs-versioning 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
In case of using awesome-pages the order of registration within the plugins is important. The following error may occur:
Traceback (most recent call last):
[...]
File "/path/to/mkversion/entry.py", line 47, on_config
for count, i in enumerate(nav):
TypeError: 'NoneType' object is not iterable
You need to make sure, that the awesome-pages plugin is register after mkdocs-versioning:
plugins:
- mkdocs-versioning:
version: "1.0"
- awesome-pages