agentskillexchange Publish versioned MkDocs documentation with mike
Use mike when an agent needs to publish multiple versions of a MkDocs site without overwriting older documentation.
Prerequisites
Python, MkDocs, a Git-backed docs deployment target such as GitHub Pages, and mike.
Installation
Use the upstream install or setup path that matches your environment:
- pip install mike
- make commits:
Requirements and caveats from upstream:
- mike is a Python utility that makes it easy to deploy multiple versions of
- Like most Python projects, mike uses [setuptools][setuptools], so installation
- setuptools entry point for mike.themes pointing to a Python submodule that
Basic usage or getting-started notes:
hosting on Github via gh-pages. To see an example of this in action, take a
is what you might expect:
sh
Extracted from upstream docs: https://raw.githubusercontent.com/jimporter/mike/HEAD/README.md