From 2d7e9341f7cbc0c8625efae30c481aed8e23f449 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 5 Aug 2018 18:59:58 +0200 Subject: [PATCH] Prepare 3.0.0 release --- .gitignore | 4 ++++ CHANGELOG | 2 +- docs/release-notes.md | 18 ++++++++++++++++++ material/base.html | 2 +- package.json | 2 +- 5 files changed, 25 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 0afee02c4..c7bfbe989 100644 --- a/.gitignore +++ b/.gitignore @@ -25,6 +25,10 @@ /node_modules /npm-debug.log* + +# Python-related +__pycache__ + # Files generated by build /build /material/manifest.json diff --git a/CHANGELOG b/CHANGELOG index 25847490a..597cb51e0 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,4 +1,4 @@ -mkdocs-material-3.0.0 (2018-08-xx) +mkdocs-material-3.0.0 (2018-08-05) * Upgraded MkDocs to 1.0 * Upgraded Python in official Docker image to 3.6 diff --git a/docs/release-notes.md b/docs/release-notes.md index ff4111bcb..cd7a36ac9 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -14,6 +14,18 @@ To inspect the currently installed version, use the following command: pip show mkdocs-material ``` +### Material 2.x to 3.x + +* Material for MkDocs 3.x requires MkDocs 1.0 because the way paths are resolved + internally changed significantly. Furthermore, `pages` was renamed to `nav`, + so remember to adjust your `mkdocs.yml` file. + +* All extended templates *should* continue to work but in order to make them + future-proof the `url` filter should be introduced on all paths. Please see + the [official release notes][_1] for further guidance. + + [_1]: https://www.mkdocs.org/about/release-notes/#version-10-2018-08-03 + ### Material 1.x to 2.x * Material for MkDocs 2.x requires MkDocs 0.17.1, as this version introduced @@ -37,6 +49,12 @@ pip show mkdocs-material ## Changelog +### 3.0.0 _ August 5, 2018 + +* Upgraded MkDocs to 1.0 +* Upgraded Python in official Docker image to 3.6 +* Added Serbian and Serbo-Croatian translations + ### 2.9.4 _ July 29, 2018 * Fixed build error after MkDocs upgrade diff --git a/material/base.html b/material/base.html index 1410b8358..24bd249e7 100644 --- a/material/base.html +++ b/material/base.html @@ -36,7 +36,7 @@ {% endfor %} - + {% endblock %} {% block htmltitle %} {% if page and page.meta and page.meta.title %} diff --git a/package.json b/package.json index 8e1bb3ead..6ed358e2e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "2.9.4", + "version": "3.0.0", "description": "A Material Design theme for MkDocs", "keywords": [ "mkdocs",