mike (for Zensical)

This fork makes mike compatible with Zensical, a modern static site generator built by the Material for MkDocs team. Please note that this is part of our effort to enable the MkDocs ecosystem to switch to Zensical as soon as possible, and should be considered a temporary solution until Zensical provides native support for versioning in the coming months.

Zensical's upcoming native versioning will allow to deploy versioned documentation anywhere, not only on GitHub Pages, and allow for more degrees of freedom in how versions are deployed and served. All mike commands stay the same. Limitations:

1. Installation must happen from GitHub – this fork won't be published on PyPI.
2. This fork is based on mike 2.2.0 - we provide bug fixes, but no new features.

Installation

pip install git+https://github.com/squidfunk/mike.git

Usage

Please see mike's documentation for usage: https://github.com/jimporter/mike?tab=readme-ov-file#mike

Acknowledgements

Jim Porter has created and maintained mike for years, and we are grateful for his work on this project, enabling users of Material for MkDocs to deploy versioned documentation to GitHub Pages. This fork is based on his work, and we will continue to maintain it until Zensical provides native support for versioning.

License

This project is licensed under the BSD 3-clause license.