mike-demo

Demo repository to setup mike.

• 1. Install
• 2. Snippets
• 3. How-To
• 4. Publishing Documentation
• 5. Notes for Setting up Mike
• 6. Credits

---

1. Install

# Install packages
poetry install

# Install pre-commit
pre-commit install

2. Snippets

# Build a version and push to gh-pages branch
mike build <VERSION-TAG> <ALIAS> -p

# Set default version (Important to-be specified before `mike serve`)
mike set-default <VERSION-TAG>

# Serve the documentation locally
mike serve

3. How-To

# Create initial documentation
mkdocs new .

# Create first version and push
mike deploy 0.1.0 latest -p

# Set default version to "latest"
mike set-default latest

# Do some stuff
# ...

# Create new version, update the "latest" alias and push
mike deploy 0.2.0 latest --update-aliases -p

4. Publishing Documentation

A new version of the documentation will be created every time you create a new Git tag. The created documentation can be found here.

5. Notes for Setting up Mike

• Mike does not create a new MKDocs project. This needs to-be setup manually.
• Mike does not include the material extras. This needs to-be added manually.

6. Credits

• https://github.com/jimporter/mike
• https://github.com/squidfunk/mkdocs-material-example-versioning