github jimporter/mike v1.0.0

latest releases: v2.1.2, v2.1.1, v2.1.0...
3 years ago

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

Don't miss a new mike release

NewReleases is sending notifications on new releases.