Mike

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-type` on the command line or `alias_type` in the `mike` MkDocs plugin
- Avoid creating empty commits by default; if you want empty commits, pass
`--allow-empty`
- Look for both `mkdocs.yml` and `mkdocs.yaml` configuration files
- Support `GIT_COMMITTER_(NAME|EMAIL|DATE)` when generating commits
- Allow specifying `alias_type`, `redirect_template`, and `deploy_prefix` in the
`mike` MkDocs plugin
- Add a `--debug` flag to help diagnose bugs with mike
- Port number is now optional for `--dev-addr` in `mike serve`, defaulting to
8000

Breaking changes

- `--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)

Bug fixes

- Aliases that are "similar" to preexisting versions (e.g. `1.0` and `1.0.0`)
can now be set properly
- Versions that *don't* start with a digit (or `v` and 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 `mkdocs` and `readthedocs` themes when
`use_directory_urls` is false
- When redirecting to another page, include the `?query`
- Ensure that aliases cannot be circularly defined
- Support file names with double-quotes or newlines

---

Bug fixes

- Improve support for shell-completion

---

Bug fixes

- Fix support for Unicode in redirection templates
- Properly decode paths in the development server

---

New features
- Add support for [`!ENV`][mkdocs-env] and [`INHERIT`][mkdocs-inherit] in
`mkdocs.yml`
- Add `mike generate-completion` to generate shell-completion functions

[mkdocs-env]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
[mkdocs-inherit]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance

---

Bug fixes

- When redirecting to another page, include the `hash`
- Ensure the MkDocs `search` plugin is correctly enabled when building via mike

---

New features
- Remove `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
- When deploying aliases, deploy redirect pages to the real version by default;
pass `--no-redirect` to deploy copies
- Improve the default redirect template to support redirection when the user has
disabled JavaScript
- Allow deploying docs to a subdirectory within the target branch via `--prefix`
- Add support for custom templates with `mike set-default`
- Read from `remote_branch` and `remote_name` if set in `mkdocs.yml`
- Allow updating an existing alias with `mike alias -u`

Breaking changes
- Require Python 3.6+
- Remove support for installing extras for `material` theme since `material`
now has [built-in support][material-mike] for mike

Bug fixes
- Canonical URLs in generated documentation now point to the correct location
- `mike alias` now checks for existing aliases to prevent erroneously setting an
alias for two different versions
- Replace `packaging` dependency with `verspec` for future stability
- Validate version and alias names to ensure they're non-empty and don't
contain a directory separator

[material-mike]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning

---