{"repo":"jimporter/mike","free":true,"listed":false,"github":"https://github.com/jimporter/mike","clone":"git clone https://github.com/jimporter/mike.git","description":"Manage multiple versions of your MkDocs-powered documentation via Git","language":"Python","stars":737,"topics":["mkdocs","documentation-tool","git","github-pages"],"license":"BSD-3-Clause","category":"docs-static-sites","readme_excerpt":"mike [![PyPi version][pypi-image]][pypi-link] [![Build status][ci-image]][ci-link] [![Coverage status][codecov-image]][codecov-link] mike is a Python utility that makes it easy to deploy multiple versions of your MkDocs-powered docs to a Git branch, suitable for hosting on Github via gh-pages . To see an example of this in action, take a look at the documentation for [bfg9000][bfg9000]. Why Use mike? mike is built around the idea that once you've generated your docs for a particular version, you should never need to touch that version again. This means you never have to worry about breaking changes in MkDocs, since your old docs (built with an old version of MkDocs) are already generated and sitting in your gh-pages branch. While mike is flexible, it's optimized around putting your docs in a . directory, with optional aliases (e.g. latest or dev ) to particularly notable versions. This makes it easy to make permalinks to whatever version of the documentation you want to direct people to. How It Works mike works by creating a new Git commit on your gh-pages branch every time you deploy a new version of your docs using mike deploy (or other mike subcommands that change your gh-pages branch). When deploying a particular version, previously-deployed docs for that version are erased and overwritten, but docs for other versions remain untouched. Installation Like most Python projects, mike uses [setuptools][setuptools], so installation is what you might expect: Once you've installe","default_branch":null,"files":null,"tree":[],"storefront":"/r/jimporter","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/jimporter/mike/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}