Package: mkdocs-multiversion-plugin
mkdocs-multiversion-pluginmkdocs-multiversion-pluginis a plugin formkdocs- afast,simpleanddownright gorgeousgorgeous static site generator that's geared towards building project documentation.mkdocs-multiversion-pluginallows you to build and have different versions of your project documentation.How It Worksmkdocs-multiversion-pluginworks by creating a new version of documentation inside mkdocssite_dir/<version>directory and adds configuration file containing information about versions tosite_dir/multiversion.json. The plugin doesn't create new branches in your git repository.SetupInstall the plugin using pip:pipinstallmkdocs-multiversion-pluginNext, add the following lines to yourmkdocs.yml:plugins:
  - multiversionIf you have nopluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set.ConfigurationGuide to all available configuration settings.To change some behavior of the plugin you need to set proper config option inmkdocs.ymlunder plugin section.plugins:
  - multiversion:
    branch_whitelist: None
    version_in_site_name: FalseList of available config options:NameTypeDefault valueDescriptionversion_in_site_namestringTrueAdds the version name to the mkdocssite_nameconfig.branch_whiteliststring^.*$Whitelist branch names, regex.tag_whiteliststring^.*$Whitelist tag names, regex.latest_version_name_formatstringlatest release ({version})Latest version name format, argument:{version}.version_name_formatstring{version}Version name format, argument:{version.css_dirstringcssThe name of the directory for css files.javascript_dirstringjsThe name of the directory for javascript files.versions_urlstring''The URL for the versions file.versions_file_namestringmultiversion.json,index.phpThe name for the file on the server containing generated versions.generate_versions_filebooltrueSpecifies whether to generate a file with versions.versions_providerstringstaticAvailable version providers:php,static.If thegenerate_versions_fileconfiguration option is false, you need to deliver the file with the available versions yourself.The file should contain JSON in the format:{"stable":{"name":"stable","latest":false},"0.2.0":{"latest":true,"name":"latest release (0.2.0)"},"0.1.0":{"latest":false,"name":"0.1.0"}}Versions providerThere are two documentation versions providers:static - static json file generated during building documentation containing versions from git repository.php - the dynamic engine that generates a list of available versions on the server. A server with PHP support is required for its operation. Generated versions are a list of directories on the server.Static provider configuration:plugins:
  - multiversionPHP provider configuration:plugins:
  - multiversion:
    versions_provider: phpIt is possible to override name of the static file:versions_file_name. Be careful to enter the correct path to the file. In case it is a relative path, the name will be prefixed with the path to the base directory:base_url.ContributingPlease note thatmkdocs-multiversion-pluginis currently inBetaand there may be missing feature/documentation so if you could help out by either:finding and reporting bugscontributing by checking out theissuesLicenseBSD-3-Clause