Skip to content

Config Options

This page will go into more detail on the available config options that this plugin provides.

Option: version

This is a REQUIRED option. This lets the plugin know what version the docs belong to. It is recommended that you use semantic versioning but any versioning scheme works. The versions are parsed as type str and is sorted alphabetically in descending order.

Example mkdocs.yml
plugins:
- mkdocs-versioning:
    version: 0.3.0

Option: exclude_from_nav

This is a OPTIONAL option. This lets the plugin know what files to exclude from the navifation. The value should be a list of paths from the docs directory.

Example mkdocs.yml
plugins:
- mkdocs-versioning:
    exclude_from_nav: ["images"]

Option: version_selection_page

This is a OPTIONAL option. This lets the plugin know if there is a custom version selection page and to use rather than the default. The markdown file should be located in the docs directory

Example mkdocs.yml
plugins:
- mkdocs-versioning:
    version_selection_page: "version_page.md"
Last update: June 27, 2020 11:45:23