Skip to content

Commit b6ca0a1

Browse files
committed
Prepare 8.0.3 release
1 parent 0b22e78 commit b6ca0a1

File tree

8 files changed

+64
-10
lines changed

8 files changed

+64
-10
lines changed

CHANGELOG

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
mkdocs-material-8.0.3+insiders-4.2.0 (2021-12-02)
2+
3+
* Added support for dismissable announcement bar
4+
* Added support for named placeholders in feedback widget
5+
6+
mkdocs-material-8.0.3 (2012-12-02)
7+
8+
* Removed deprecated google_analytics setting (was forgotten in 8.0.0)
9+
* Fixed syntax error in Swedish and Polish translations
10+
* Fixed #3283: Invalid back-to-top button position with sticky navigation tabs
11+
* Fixed #3285: Default details marker showing due to Safari bug
12+
113
mkdocs-material-8.0.2+insiders-4.1.0 (2021-11-30)
214

315
* Added support for passing page title to feedback forms

docs/changelog/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ template: overrides/main.html
66

77
## Material for MkDocs
88

9+
### 8.0.3 <small>_ December 2, 2021</small> { id="8.0.3" }
10+
11+
- Removed deprecated `google_analytics` setting (was forgotten in 8.0.0)
12+
- Fixed syntax error in Swedish and Polish translations
13+
- Fixed #3283: Invalid back-to-top button position with sticky navigation tabs
14+
- Fixed #3285: Default details marker showing due to Safari bug
15+
916
### 8.0.2 <small>_ November 30, 2021</small> { id="8.0.2" }
1017

1118
- Fixed #3275: Code annotations always disappear on click

docs/insiders/changelog.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ template: overrides/main.html
66

77
## Material for MkDocs Insiders
88

9-
### 4.1.0 <small>_ November 30, 2021</small> { id="4.0.0" }
9+
### 4.2.0 <small>_ December 2, 2021</small> { id="4.2.0" }
10+
11+
- Added support for dismissable announcement bar
12+
- Added support for named placeholders in feedback widget
13+
14+
### 4.1.0 <small>_ November 30, 2021</small> { id="4.1.0" }
1015

1116
- Added support for passing page title to feedback forms
1217

docs/insiders/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,9 @@ The following features are solely available via Material for MkDocs Insiders:
162162

163163
<div class="mdx-columns" markdown>
164164

165-
- [x] [Was this page helpful?] :material-new-box:
166-
- [x] [Brand new search plugin] :material-new-box:
165+
- [x] [Dismissable announcement bar] :material-new-box:
166+
- [x] [Was this page helpful?]
167+
- [x] [Brand new search plugin]
167168
- [x] [Rich search previews]
168169
- [x] [Tokenizer with lookahead]
169170
- [x] [Advanced search highlighting]
@@ -172,7 +173,7 @@ The following features are solely available via Material for MkDocs Insiders:
172173
- [x] [Cookie consent]
173174
- [x] [Linking content tabs]
174175
- [x] [Boosting pages in search]
175-
- [x] [Tags] with search integration
176+
- [x] [Tags with search integration]
176177
- [x] [Stay on page when switching versions]
177178
- [x] [Custom admonition icons]
178179
- [x] [Mermaid.js integration]
@@ -193,11 +194,11 @@ are released for general availability.
193194

194195
- [x] [Mermaid.js integration]
195196
- [x] [Stay on page when switching versions]
196-
- [x] [Tags] with search integration
197+
- [x] [Tags with search integration]
197198

198199
[Mermaid.js integration]: ../reference/diagrams.md
199200
[Stay on page when switching versions]: ../setup/setting-up-versioning.md#stay-on-page
200-
[Tags]: ../setup/setting-up-tags.md
201+
[Tags with search integration]: ../setup/setting-up-tags.md
201202

202203
#### $ 6,000 – Trinidad Scorpion
203204

@@ -213,10 +214,11 @@ are released for general availability.
213214

214215
- [x] [Cookie consent]
215216
- [x] [Was this page helpful?]
216-
- [ ] Link cards
217+
- [x] [Dismissable announcement bar]
217218

218219
[Cookie consent]: ../setup/setting-up-site-analytics.md#cookie-consent
219220
[Was this page helpful?]: ../setup/setting-up-site-analytics.md#was-this-page-helpful
221+
[Dismissable announcement bar]: ../setup/setting-up-the-header.md#mark-as-read
220222

221223
#### $ 8,000 – Scotch Bonnet
222224

docs/setup/setting-up-the-header.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ theme:
3131
3232
[Automatic hiding support]: https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.0
3333
34+
## Customization
35+
3436
### Announcement bar
3537
3638
[:octicons-tag-24: 5.0.0][Announcement bar support] ·
@@ -53,3 +55,29 @@ block][overriding blocks], which is empty by default:
5355
[Announcement bar support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
5456
[extend the theme]: ../customization.md#extending-the-theme
5557
[overriding blocks]: ../customization.md#overriding-blocks
58+
59+
#### Mark as read
60+
61+
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
62+
[:octicons-tag-24: insiders-4.2.0][Insiders] ·
63+
:octicons-unlock-24: Feature flag ·
64+
:octicons-beaker-24: Experimental
65+
66+
In order to render temporary announcements that can be marked as read by the
67+
user, a button to dismiss the current announcement can be included. Add the
68+
following lines to `mkdocs.yml`:
69+
70+
``` yaml
71+
theme:
72+
features:
73+
- announce.dismiss
74+
```
75+
76+
When the user clicks the button, the current announcement is dismissed and not
77+
displayed again until the content of the announcement changes. This is handled
78+
automatically.
79+
80+
[Scroll to the top of this page][top] to see it in action.
81+
82+
[Insiders]: ../insiders/index.md
83+
[top]: #

material/base.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<link rel="canonical" href="{{ page.canonical_url }}">
2323
{% endif %}
2424
<link rel="icon" href="{{ config.theme.favicon | url }}">
25-
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.0.2">
25+
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.0.3">
2626
{% endblock %}
2727
{% block htmltitle %}
2828
{% if page and page.meta and page.meta.title %}

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mkdocs-material",
3-
"version": "8.0.2",
3+
"version": "8.0.3",
44
"description": "A Material Design theme for MkDocs",
55
"keywords": [
66
"mkdocs",

0 commit comments

Comments
 (0)