From b6ca0a1053432014742c38aedd8f86c0d98d6dbb Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 2 Dec 2021 15:22:23 +0100 Subject: [PATCH] Prepare 8.0.3 release --- CHANGELOG | 12 ++++++++++++ docs/changelog/index.md | 7 +++++++ docs/insiders/changelog.md | 7 ++++++- docs/insiders/index.md | 14 ++++++++------ docs/setup/setting-up-the-header.md | 28 ++++++++++++++++++++++++++++ material/base.html | 2 +- package-lock.json | 2 +- package.json | 2 +- 8 files changed, 64 insertions(+), 10 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index e560e339b..01b91ecef 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,15 @@ +mkdocs-material-8.0.3+insiders-4.2.0 (2021-12-02) + + * Added support for dismissable announcement bar + * Added support for named placeholders in feedback widget + +mkdocs-material-8.0.3 (2012-12-02) + + * Removed deprecated google_analytics setting (was forgotten in 8.0.0) + * Fixed syntax error in Swedish and Polish translations + * Fixed #3283: Invalid back-to-top button position with sticky navigation tabs + * Fixed #3285: Default details marker showing due to Safari bug + mkdocs-material-8.0.2+insiders-4.1.0 (2021-11-30) * Added support for passing page title to feedback forms diff --git a/docs/changelog/index.md b/docs/changelog/index.md index 3832d31a9..10f846d9f 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -6,6 +6,13 @@ template: overrides/main.html ## Material for MkDocs +### 8.0.3 _ December 2, 2021 { id="8.0.3" } + +- Removed deprecated `google_analytics` setting (was forgotten in 8.0.0) +- Fixed syntax error in Swedish and Polish translations +- Fixed #3283: Invalid back-to-top button position with sticky navigation tabs +- Fixed #3285: Default details marker showing due to Safari bug + ### 8.0.2 _ November 30, 2021 { id="8.0.2" } - Fixed #3275: Code annotations always disappear on click diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index 986977ca7..8ca7ac7e3 100644 --- a/docs/insiders/changelog.md +++ b/docs/insiders/changelog.md @@ -6,7 +6,12 @@ template: overrides/main.html ## Material for MkDocs Insiders -### 4.1.0 _ November 30, 2021 { id="4.0.0" } +### 4.2.0 _ December 2, 2021 { id="4.2.0" } + +- Added support for dismissable announcement bar +- Added support for named placeholders in feedback widget + +### 4.1.0 _ November 30, 2021 { id="4.1.0" } - Added support for passing page title to feedback forms diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 158f4404b..2a4f22ea0 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -162,8 +162,9 @@ The following features are solely available via Material for MkDocs Insiders:
-- [x] [Was this page helpful?] :material-new-box: -- [x] [Brand new search plugin] :material-new-box: +- [x] [Dismissable announcement bar] :material-new-box: +- [x] [Was this page helpful?] +- [x] [Brand new search plugin] - [x] [Rich search previews] - [x] [Tokenizer with lookahead] - [x] [Advanced search highlighting] @@ -172,7 +173,7 @@ The following features are solely available via Material for MkDocs Insiders: - [x] [Cookie consent] - [x] [Linking content tabs] - [x] [Boosting pages in search] -- [x] [Tags] with search integration +- [x] [Tags with search integration] - [x] [Stay on page when switching versions] - [x] [Custom admonition icons] - [x] [Mermaid.js integration] @@ -193,11 +194,11 @@ are released for general availability. - [x] [Mermaid.js integration] - [x] [Stay on page when switching versions] -- [x] [Tags] with search integration +- [x] [Tags with search integration] [Mermaid.js integration]: ../reference/diagrams.md [Stay on page when switching versions]: ../setup/setting-up-versioning.md#stay-on-page - [Tags]: ../setup/setting-up-tags.md + [Tags with search integration]: ../setup/setting-up-tags.md #### $ 6,000 – Trinidad Scorpion @@ -213,10 +214,11 @@ are released for general availability. - [x] [Cookie consent] - [x] [Was this page helpful?] -- [ ] Link cards +- [x] [Dismissable announcement bar] [Cookie consent]: ../setup/setting-up-site-analytics.md#cookie-consent [Was this page helpful?]: ../setup/setting-up-site-analytics.md#was-this-page-helpful + [Dismissable announcement bar]: ../setup/setting-up-the-header.md#mark-as-read #### $ 8,000 – Scotch Bonnet diff --git a/docs/setup/setting-up-the-header.md b/docs/setup/setting-up-the-header.md index 2a0ad3fa3..ddf8e423e 100644 --- a/docs/setup/setting-up-the-header.md +++ b/docs/setup/setting-up-the-header.md @@ -31,6 +31,8 @@ theme: [Automatic hiding support]: https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.0 +## Customization + ### Announcement bar [:octicons-tag-24: 5.0.0][Announcement bar support] · @@ -53,3 +55,29 @@ block][overriding blocks], which is empty by default: [Announcement bar support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0 [extend the theme]: ../customization.md#extending-the-theme [overriding blocks]: ../customization.md#overriding-blocks + +#### Mark as read + +[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } · +[:octicons-tag-24: insiders-4.2.0][Insiders] · +:octicons-unlock-24: Feature flag · +:octicons-beaker-24: Experimental + +In order to render temporary announcements that can be marked as read by the +user, a button to dismiss the current announcement can be included. Add the +following lines to `mkdocs.yml`: + +``` yaml +theme: + features: + - announce.dismiss +``` + +When the user clicks the button, the current announcement is dismissed and not +displayed again until the content of the announcement changes. This is handled +automatically. + +[Scroll to the top of this page][top] to see it in action. + + [Insiders]: ../insiders/index.md + [top]: # diff --git a/material/base.html b/material/base.html index a027b5d25..998294af2 100644 --- a/material/base.html +++ b/material/base.html @@ -22,7 +22,7 @@ {% endif %} - + {% endblock %} {% block htmltitle %} {% if page and page.meta and page.meta.title %} diff --git a/package-lock.json b/package-lock.json index 22c776859..012108829 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "8.0.2", + "version": "8.0.3", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index b6bca4e81..ccbcbbb02 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "8.0.2", + "version": "8.0.3", "description": "A Material Design theme for MkDocs", "keywords": [ "mkdocs",