Skip to main content

A tool that allows for versioning sites built with mkdocs

Project description

mkdocs-versioning

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.

Please note that mkdocs-versioning is currently in Alpha and there may be missing feature/documentation so if you could help out by either:

  1. finding and reporting bugs
  2. contributing by checking out the issues

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-versioning-0.1.0.tar.gz (6.9 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_versioning-0.1.0-py3-none-any.whl (9.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page