Mike

Latest version: v2.1.3

Safety actively analyzes 688568 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 2 of 5

1.1.1

Bug fixes

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

---

1.1.0

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

---

1.0.1

Bug fixes

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

---

1.0.0

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

---

0.5.5

Bug fixes
- Add support for `mkdocs.yml` files using `!!python` tags

---

0.5.3

Bug fixes
- Fix some cases of `material` theme's version selector failing to load
- Add support for `material` v5.0+

---

Page 2 of 5

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.