pypi / mike

mike

What changed in mike 1 to 2, from its official release notes, upgrade guides and advisories. Sources checked 2026-10-30.

13 breaking15 new APIs and options6 behavior and defaults6 fixes and other

See which of these apply to your code, ranked, in your agent:

npx @unstale/cli init

mike 227 changes

Empty commits are avoided by default; pass this option if you want empty commits.
2.0.0release notes
Aliases can no longer be defined circularly.
2.0.0release notes
Versions not starting with a digit, or with v followed by a digit, are treated as development versions and newer than ordinary versions.
2.0.0release notes
The force option is no longer supported on subcommands that can push; users who need to force-push can use Git directly.
2.0.0release notes
This option is no longer supported; use --ignore-remote-status instead.
2.0.0release notes
This option is no longer supported; use --alias-type=copy instead.
2.0.0release notes
This option is no longer supported; use --deploy-prefix instead.
2.0.0release notes
This option is no longer supported; use Git to resolve conflicts instead.
2.0.0release notes
Redirects to another page now include the query string.
2.0.0release notes

Adds support for ProperDocs.
2.2.0release notes
Aliases are deployed using symbolic links by default; this can be configured with this command-line option.
2.0.0release notes
The MkDocs plugin can configure alias deployment type.
2.0.0release notes
A debug flag is available to help diagnose bugs with mike.
2.0.0release notes
The MkDocs plugin can now specify a deployment prefix.
2.0.0release notes
Arbitrary properties can now be applied to documentation versions.
2.0.0release notes
Commit generation now supports Git committer name, email, and date environment variables.
2.0.0release notes
The MkDocs plugin can now specify a redirect template.
2.0.0release notes
Specific versions can now be hidden from the selector when using the default themes.
2.0.0release notes

New commits use DST timestamps when DST is in effect.
2.2.0release notes
Supports ISO8601 and RFC 2822 values for GIT_COMMITTER_DATE.
2.2.0release notes
Uses the built-in importlib in Python 3.10 and greater.
2.1.4release notes
The port for --dev-addr is now optional and defaults to 8000.
2.0.0release notes
Configuration file discovery now looks for both mkdocs.yml and mkdocs.yaml.
2.0.0release notes

File names containing double-quotes or newlines are now supported.
2.0.0release notes
Retrieval of Git user name and email now works with non-UTF8 encodings.
2.0.0release notes
Aliases similar to preexisting versions, such as 1.0 and 1.0.0, can now be set properly.
2.0.0release notes
The selector is fixed for the mkdocs and readthedocs themes when use_directory_urls is false.
2.0.0release notes

Deploying aliases now deploys redirect pages to the real version by default instead of copies.
1.0.0release notes
The command is removed and replaced with an MkDocs plugin; remove any JS/CSS it added to your docs directory.
1.0.0release notes
Python 3.6 or later is now required.
1.0.0release notes
Names are now validated to ensure they are non-empty and contain no directory separator.
1.0.0release notes

This option allows updating an existing alias.
1.0.0release notes
Pass this flag when deploying aliases to deploy copies instead of redirect pages.
1.0.0release notes
Deploy docs to a subdirectory within the target branch using this option.
1.0.0release notes
The command now supports custom templates.
1.0.0release notes
mike now reads this setting from mkdocs.yml when it is set.
1.0.0release notes
mike now reads this setting from mkdocs.yml when it is set.
1.0.0release notes

The default redirect template now supports redirection when JavaScript is disabled.
1.0.0release notes

Canonical URLs in generated documentation now point to the correct location.
1.0.0release notes
The command now checks for existing aliases to prevent setting an alias for two different versions.
1.0.0release notes