NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI · #4164 most downloaded on PyPI
Manage multiple versions of your MkDocs-powered documentation
Last release 5 months ago
14 Apr 2026
Ships unpredictably
gaps range from 2 weeks to 2.1 years
Nearly every release is documented
notes for 27 of 29 stable releases
1 version withdrawn
withdrawn after publishing
9 years old
30 releases · first in 2017
Use DST timestamps for new commits when DST is in effect
GIT_COMMITTER_DATEGIT_COMMITTER_DATEUse built-in importlib in Python 3.10 and greater
importlib in Python 3.10 and greaterOne column per quarter.
When deploying using a deploy prefix, only delete stale versions of the docs within that prefix
Remove ambiguity of some Git commands so that file and branch names don't collide
Support using environment variables for INHERIT when injecting the mike plugin into mkdocs.yml
INHERIT when injecting the mike plugin into mkdocs.ymlWhen calling set-default , you can now pass --allow-undefined to set the default to a version that doesn't exist yet
set-default, you can now pass --allow-undefined to set the default to a version that doesn't exist yet-q / --quiet option to suppress warning messages!relative in mkdocs.ymlstartup and shutdown eventsAdd support for applying arbitrary properties to documentation versions
--alias-type on the command line or alias_type in the mike MkDocs plugin--allow-emptymkdocs.yml and mkdocs.yaml configuration filesGIT_COMMITTER_(NAME|EMAIL|DATE) when generating commitsalias_type, redirect_template, and deploy_prefix in the mike MkDocs plugin--debug flag to help diagnose bugs with mike--dev-addr in mike serve, defaulting to 8000--prefix is now --deploy-prefix--no-redirect is now --alias-type=copy--ignore is now --ignore-remote-status-f / --force is no longer supported on subcommands that can push (this option was too error-prone, and users who really need to force-push can use Git directly)--rebase is no longer supported (instead of using this, it's better to use Git to resolve any conflicts)1.0 and 1.0.0) can now be set properlyv and then a digit) are now treated separately from other versions: they're considered development versions, and thus newer than "ordinary" versionsmkdocs and readthedocs themes when use_directory_urls is false?queryImprove support for shell-completion
Fix support for Unicode in redirection templates
Add support for !ENV and INHERIT in mkdocs.yml
!ENV and INHERIT in
mkdocs.ymlmike generate-completion to generate shell-completion functionsWhen redirecting to another page, include the #hash
#hashsearch plugin is correctly enabled when building via mikeRemove mike install-extras and replace it with an MkDocs plugin; if you previously used install-extras, be sure to remove the added JS/CSS from your d
mike install-extras and replace it with an MkDocs plugin; if you
previously used install-extras, be sure to remove the added JS/CSS from your
docs directory--no-redirect to deploy copies--prefixmike set-defaultremote_branch and remote_name if set in mkdocs.ymlmike alias -umaterial theme since material
now has built-in support for mikemike alias now checks for existing aliases to prevent erroneously setting an
alias for two different versionspackaging dependency with verspec for future stabilityNothing published for this version
Add support for mkdocs.yml files using !!python tags
mkdocs.yml files using !!python tagsNothing published for this version
Fix some cases of material theme's version selector failing to load
material theme's version selector failing to loadmaterial v5.0+Add support for custom site_dir in mkdocs.yml
site_dir in mkdocs.ymlmkdocs.yml when running install-extrasFix version selector with material theme when on homepage
material theme when on homepageAdd support for the [material][material] theme
material thememkdocs-bootswatch-classic themesmkdocs theme to work with both MkDocs
1.0 and 1.1Fix using mike from subdirectories in some more cases
mike from subdirectories in some more casesFix using mike commands from non-root directories of your project
mike commands from non-root directories of your projectAdd support for listing doc version in JSON format via -j/--json
-j/--json-u/--update-aliases optionSelectively require enum34 in a Wheel-compatible way
enum34 in a Wheel-compatible wayInclude templates/index.html in source dists (fixes mike set-default)
templates/index.html in source dists (fixes mike set-default)Add support for Python 3.7 as well as newer versions of ruamel.yaml
ruamel.yamlSupport defining theme in mkdocs.yml as a mapping instead of just a string
mkdocs.yml as a mapping instead of just a stringFix version selection on real Github pages
Add an alias command to copy an existing set of docs to a new alias
alias command to copy an existing set of docs to a new aliasrename command to retitleAdd support for locally-serving documentation for testing purposes
Nothing published for this version
Your coding agent can read these notes before it upgrades. Set up the MCP server →