Releases: jimporter/mike
Releases · jimporter/mike
v2.1.4
v2.1.3
v2.1.2
v2.1.1
v2.1.0
New features
- When calling
set-default, you can now pass--allow-undefinedto set the default to a version that doesn't exist yet - Add global-level
-q/--quietoption to suppress warning messages - Add support for handling
!relativeinmkdocs.yml
Bug fixes
- When loading an MkDocs config, mike now runs the
startupandshutdownevents
v2.0.0
New features
- Add support for applying arbitrary properties to documentation versions
- Add support for hiding specific versions from the selector when using the default themes
- Deploy aliases using symbolic links by default; this can be configured via
--alias-typeon the command line oralias_typein themikeMkDocs plugin - Avoid creating empty commits by default; if you want empty commits, pass
--allow-empty - Look for both
mkdocs.ymlandmkdocs.yamlconfiguration files - Support
GIT_COMMITTER_(NAME|EMAIL|DATE)when generating commits - Allow specifying
alias_type,redirect_template, anddeploy_prefixin themikeMkDocs plugin - Add a
--debugflag to help diagnose bugs with mike - Port number is now optional for
--dev-addrinmike serve, defaulting to 8000
Breaking changes
--prefixis now--deploy-prefix--no-redirectis now--alias-type=copy--ignoreis now--ignore-remote-status-f/--forceis 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)--rebaseis no longer supported (instead of using this, it's better to use Git to resolve any conflicts)
Bug fixes
- Aliases that are "similar" to preexisting versions (e.g.
1.0and1.0.0) can now be set properly - Versions that don't start with a digit (or
vand then a digit) are now treated separately from other versions: they're considered development versions, and thus newer than "ordinary" versions - Fix retrieval of Git user name/email when using non-UTF8 encodings
- Fix version selector for
mkdocsandreadthedocsthemes whenuse_directory_urlsis false - When redirecting to another page, include the
?query - Ensure that aliases cannot be circularly defined
- Support file names with double-quotes or newlines