tag:github.com,2008:https://github.com/jimporter/mike/releases 2024-08-13T05:00:47Z tag:github.com,2008:Repository/104630947/v2.1.3 2024-08-13T05:03:33Z <h3>Bug fixes</h3> <ul> <li>When deploying using a deploy prefix, only delete stale versions of the docs within that prefix</li> </ul> jimporter tag:github.com,2008:Repository/104630947/v2.1.2 2024-06-24T16:37:06Z <h3>Bug fixes</h3> <ul> <li>Remove ambiguity of some Git commands so that file and branch names don't collide</li> </ul> jimporter tag:github.com,2008:Repository/104630947/v2.1.1 2024-05-03T19:06:58Z <h3>Bug fixes</h3> <ul> <li>Support using environment variables for <code>INHERIT</code> when injecting the <code>mike</code> plugin into <code>mkdocs.yml</code></li> </ul> jimporter tag:github.com,2008:Repository/104630947/v2.1.0 2024-05-02T01:00:06Z <h3>New features</h3> <ul> <li>When calling <code>set-default</code>, you can now pass <code>--allow-undefined</code> to set the default to a version that doesn't exist yet</li> <li>Add global-level <code>-q</code> / <code>--quiet</code> option to suppress warning messages</li> <li>Add support for handling <code>!relative</code> in <code>mkdocs.yml</code></li> </ul> <h3>Bug fixes</h3> <ul> <li>When loading an MkDocs config, mike now runs the <code>startup</code> and <code>shutdown</code> events</li> </ul> jimporter tag:github.com,2008:Repository/104630947/v2.0.0 2023-11-02T22:10:14Z <h3>New features</h3> <ul> <li>Add support for applying arbitrary properties to documentation versions</li> <li>Add support for hiding specific versions from the selector when using the default themes</li> <li>Deploy aliases using symbolic links by default; this can be configured via <code>--alias-type</code> on the command line or <code>alias_type</code> in the <code>mike</code> MkDocs plugin</li> <li>Avoid creating empty commits by default; if you want empty commits, pass <code>--allow-empty</code></li> <li>Look for both <code>mkdocs.yml</code> and <code>mkdocs.yaml</code> configuration files</li> <li>Support <code>GIT_COMMITTER_(NAME|EMAIL|DATE)</code> when generating commits</li> <li>Allow specifying <code>alias_type</code>, <code>redirect_template</code>, and <code>deploy_prefix</code> in the <code>mike</code> MkDocs plugin</li> <li>Add a <code>--debug</code> flag to help diagnose bugs with mike</li> <li>Port number is now optional for <code>--dev-addr</code> in <code>mike serve</code>, defaulting to 8000</li> </ul> <h3>Breaking changes</h3> <ul> <li><code>--prefix</code> is now <code>--deploy-prefix</code></li> <li><code>--no-redirect</code> is now <code>--alias-type=copy</code></li> <li><code>--ignore</code> is now <code>--ignore-remote-status</code></li> <li><code>-f</code> / <code>--force</code> 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)</li> <li><code>--rebase</code> is no longer supported (instead of using this, it's better to use Git to resolve any conflicts)</li> </ul> <h3>Bug fixes</h3> <ul> <li>Aliases that are "similar" to preexisting versions (e.g. <code>1.0</code> and <code>1.0.0</code>) can now be set properly</li> <li>Versions that <em>don't</em> start with a digit (or <code>v</code> and then a digit) are now treated separately from other versions: they're considered development versions, and thus newer than "ordinary" versions</li> <li>Fix retrieval of Git user name/email when using non-UTF8 encodings</li> <li>Fix version selector for <code>mkdocs</code> and <code>readthedocs</code> themes when <code>use_directory_urls</code> is false</li> <li>When redirecting to another page, include the <code>?query</code></li> <li>Ensure that aliases cannot be circularly defined</li> <li>Support file names with double-quotes or newlines</li> </ul> jimporter tag:github.com,2008:Repository/104630947/v1.1.2 2021-10-04T05:26:35Z <h3>Bug fixes</h3> <ul> <li>Improve support for shell-completion</li> </ul> jimporter tag:github.com,2008:Repository/104630947/v1.1.1 2021-09-13T22:49:29Z <h3>Bug fixes</h3> <ul> <li>Fix support for Unicode in redirection templates</li> <li>Properly decode paths in the development server</li> </ul> jimporter tag:github.com,2008:Repository/104630947/v1.1.0 2021-09-02T04:40:08Z <h3>New features</h3> <ul> <li>Add support for <a href="https://www.mkdocs.org/user-guide/configuration/#environment-variables" rel="nofollow"><code>!ENV</code></a> and <a href="https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance" rel="nofollow"><code>INHERIT</code></a> in <code>mkdocs.yml</code></li> <li>Add <code>mike generate-completion</code> to generate shell-completion functions</li> </ul> jimporter tag:github.com,2008:Repository/104630947/v1.0.1 2021-06-01T05:04:38Z <h3>Bug fixes</h3> <ul> <li>When redirecting to another page, include the <code>#hash</code></li> <li>Ensure the MkDocs <code>search</code> plugin is correctly enabled when building via mike</li> </ul> jimporter tag:github.com,2008:Repository/104630947/v1.0.0 2021-04-10T20:09:52Z <h3>New features</h3> <ul> <li>Remove <code>mike install-extras</code> and replace it with an MkDocs plugin; if you previously used <code>install-extras</code>, be sure to remove the added JS/CSS from your docs directory</li> <li>When deploying aliases, deploy redirect pages to the real version by default; pass <code>--no-redirect</code> to deploy copies</li> <li>Improve the default redirect template to support redirection when the user has disabled JavaScript</li> <li>Allow deploying docs to a subdirectory within the target branch via <code>--prefix</code></li> <li>Add support for custom templates with <code>mike set-default</code></li> <li>Read from <code>remote_branch</code> and <code>remote_name</code> if set in <code>mkdocs.yml</code></li> <li>Allow updating an existing alias with <code>mike alias -u</code></li> </ul> <h3>Breaking changes</h3> <ul> <li>Require Python 3.6+</li> <li>Remove support for installing extras for <code>material</code> theme since <code>material</code><br> now has [built-in support][material-mike] for mike</li> </ul> <h3>Bug fixes</h3> <ul> <li>Canonical URLs in generated documentation now point to the correct location</li> <li><code>mike alias</code> now checks for existing aliases to prevent erroneously setting an alias for two different versions</li> <li>Replace <code>packaging</code> dependency with <code>verspec</code> for future stability</li> <li>Validate version and alias names to ensure they're non-empty and don't contain a directory separator</li> </ul> jimporter