Add mike for versioned documentation#82
Merged
ssestak merged 1 commit intofeature/docs-sitefrom Feb 20, 2026
Merged
Conversation
Replace mkdocs gh-deploy with mike deploy to support multiple doc versions. Tag pushes publish under the tag name with a "latest" alias, while main-branch pushes publish under "main". The Material theme version selector is enabled via extra.version.provider. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
ssestak
force-pushed
the
feature/mike-versioned-docs
branch
from
a98b77a to
fa3701e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replace
mkdocs gh-deploy --forcewithmike deployto support versioned documentation. Tag pushes publish docs under the tag name with alatestalias and root redirect, while main-branch pushes publish undermain. The Material theme version selector dropdown is enabled automatically.Changes
mike>=2.1dependencyextra.version.provider: mikeinmkdocs.ymlsedstep that injected version intosite_name(mike handles version display via the selector widget)requirements-docs.txtto workflowpathstriggerDiagram
View diagram
flowchart TD A[Push event] --> B{refs/tags/*?} B -- Yes --> C[version = tag name] C --> D[alias = latest] D --> E[mike deploy --push --update-aliases VERSION latest] E --> F[mike set-default --push latest] B -- No --> G[version = main] G --> H[mike deploy --push main] F --> I[gh-pages updated] H --> I