From 20f7440280079a2d9f2654d7a276a0e899b64476 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Mon, 22 Feb 2021 23:05:09 +0100 Subject: [PATCH] Prepare 7.0.0 release --- CHANGELOG | 9 + docs/changelog.md | 2 +- docs/upgrading.md | 305 ++++++++++++++++++ .../assets/stylesheets/main.3149646c.min.css | 2 - .../stylesheets/main.3149646c.min.css.map | 1 - .../assets/stylesheets/main.a3f8f96a.min.css | 2 + .../stylesheets/main.a3f8f96a.min.css.map | 1 + material/base.html | 4 +- material/partials/footer.html | 62 ++-- package-lock.json | 2 +- package.json | 2 +- .../stylesheets/main/layout/_footer.scss | 20 +- src/base.html | 4 +- src/partials/footer.html | 92 +++--- src/partials/header.html | 2 +- 15 files changed, 408 insertions(+), 102 deletions(-) delete mode 100644 material/assets/stylesheets/main.3149646c.min.css delete mode 100644 material/assets/stylesheets/main.3149646c.min.css.map create mode 100644 material/assets/stylesheets/main.a3f8f96a.min.css create mode 100644 material/assets/stylesheets/main.a3f8f96a.min.css.map diff --git a/CHANGELOG b/CHANGELOG index e7ebee993..b8fa18ec9 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,12 @@ +mkdocs-material-7.0.0 (2021-02-22) + + * Added support for deploying multiple versions + * Added support for integrating a language selector + * Added support for rendering admonitions as inline blocks + * Rewrite of the underlying reactive architecture + * Removed Webpack in favor of reactive build strategy (-480 dependencies) + * Fixed keyboard navigation for code blocks after content tabs switch + mkdocs-material-6.2.8 (2021-02-04) * Updated Japanese and Polish translations diff --git a/docs/changelog.md b/docs/changelog.md index 814a0cf66..1c01b8d88 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -9,7 +9,7 @@ template: overrides/main.html ### 7.0.0 _ February 22, 2021 - Added support for deploying multiple versions -- Added support for adding a language selector +- Added support for integrating a language selector - Added support for rendering admonitions as inline blocks - Rewrite of the underlying reactive architecture - Removed Webpack in favor of reactive build strategy (-480 dependencies) diff --git a/docs/upgrading.md b/docs/upgrading.md index 51e971cde..818aa706b 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -16,6 +16,311 @@ Inspect the currently installed version with: pip show mkdocs-material ``` +## Upgrading from 6.x to 7.x + +### What's new? + +- Added support for deploying multiple versions +- Added support for integrating a language selector +- Added support for rendering admonitions as inline blocks +- Rewrite of the underlying reactive architecture +- Removed Webpack in favor of reactive build strategy (-480 dependencies) +- Fixed keyboard navigation for code blocks after content tabs switch + +### Changes to `mkdocs.yml` + +#### `extra.version.method` + +The versioning method configuration was renamed to `extra.version.provider` to +allow for different versioning strategies in the future: + +=== "7.x" + + ``` yaml + extra: + version: + provider: mike + ``` + +=== "6.x" + + ``` yaml + extra: + version: + method: mike + ``` + +### Changes to `*.html` files + +The templates have undergone a set of changes to make them future-proof. If +you've used theme extension to override a block or template, make sure that it +matches the new structure: + +- If you've overridden a __block__, check `base.html` for potential changes +- If you've overridden a __template__, check the respective `*.html` file for + potential changes + +??? quote "`base.html`" + + ``` diff + @@ -61,7 +61,7 @@ + font.text | replace(' ', '+') + ':300,400,400i,700%7C' + + font.code | replace(' ', '+') + }}&display=fallback"> + - + + + {% endif %} + {% endblock %} + {% if config.extra.manifest %} + @@ -131,7 +131,7 @@ + {% if page and page.meta and page.meta.hide %} + {% set hidden = "hidden" if "navigation" in page.meta.hide %} + {% endif %} + -