Skip to content
This repository was archived by the owner on Mar 20, 2026. It is now read-only.

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

This is an example of the new versioning feature of Material for MkDocs.

How to set up versioning

First, install Material for MkDocs Insiders and mike:

pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
pip install mike

Next, set up your documentation project:

mkdocs new .

Update mkdocs.yml:

site_name: My Docs
theme:
  name: material
extra:
  version:
    provider: mike

Make a change to docs/index.md, and publish the first version:

mike --push --update-aliases 0.1 latest

Set the default version to latest

mike set-default --push latest

Now, make another change and publish a new version:

mike --push --update-aliases 0.2 latest

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors