Mike

Latest version: v2.1.3

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

Scan your dependencies

Page 1 of 5

2.1.3

Bug fixes
- When deploying using a deploy prefix, only delete stale versions of the docs
within that prefix

---

2.1.2

Bug fixes
- Remove ambiguity of some Git commands so that file and branch names don't
collide

---

2.1.1

Bug fixes
- Support using environment variables for `INHERIT` when injecting the `mike`
plugin into `mkdocs.yml`

---

2.1.0

New features
- When calling `set-default`, you can now pass `--allow-undefined` to set the
default to a version that doesn't exist yet
- Add global-level `-q` / `--quiet` option to suppress warning messages
- Add support for handling `!relative` in `mkdocs.yml`

Bug fixes
- When loading an MkDocs config, mike now runs the `startup` and `shutdown`
events

---

2.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-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

---

1.1.2

Bug fixes

- Improve support for shell-completion

---

Page 1 of 5

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.