Skip to content

Commit 6f69e3c

Browse files
committed
Prepare 8.3.1 release
1 parent c4cb6b4 commit 6f69e3c

File tree

12 files changed

+91
-11
lines changed

12 files changed

+91
-11
lines changed

CHANGELOG

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
mkdocs-material-8.3.1+insiders-4.17.0 (2022-06-04)
2+
3+
* Added support for content tabs anchor links (deep linking)
4+
* Fixed #3975: Detect composition events in search interface (Chinese)
5+
* Fixed #3980: Search plugin doesn't use title set via front matter
6+
7+
mkdocs-material-8.3.1 (2022-06-04)
8+
9+
* Bump required Jinja version to 3.0.2
10+
* Removed unnecessary conditions in templates
11+
* Fixed scroll offset when content tabs are brought into view
12+
* Fixed #3977: Content tabs snapping oddly in Firefox
13+
* Fixed #3983: Missing condition in footer partial (8.3.0 regression)
14+
115
mkdocs-material-8.3.0 (2022-06-02)
216

317
* Added support for custom admonition icons

docs/changelog/index.md

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

77
## Material for MkDocs
88

9+
### 8.3.1 <small>_ June 4, 2022</small> { id="8.3.1" }
10+
11+
- Bump required Jinja version to 3.0.2
12+
- Removed unnecessary conditions in templates
13+
- Fixed scroll offset when content tabs are brought into view
14+
- Fixed #3977: Content tabs snapping oddly in Firefox
15+
- Fixed #3983: Missing condition in footer partial (8.3.0 regression)
16+
917
### 8.3.0 <small>_ June 2, 2022</small> { id="8.3.0" }
1018

1119
- Added support for custom admonition icons

docs/insiders/changelog.md

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

77
## Material for MkDocs Insiders
88

9+
### 4.17.0 <small>_ June 4, 2022</small> { id="4.17.0" }
10+
11+
- Added support for content tabs anchor links (deep linking)
12+
- Fixed #3975: Detect composition events in search interface (Chinese)
13+
- Fixed #3980: Search plugin doesn't use title set via front matter
14+
915
### 4.16.2 <small>_ May 29, 2022</small> { id="4.16.2" }
1016

1117
- Fixed #3961: Nested sections triggered build error for navigation tabs

docs/insiders/index.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,10 @@ which are currently exclusively available to sponsors:
174174

175175
<div class="mdx-columns" markdown>
176176

177+
- [x] [Content tabs: anchor links] :material-alert-decagram:{ title="Added on June 4, 2022" }
177178
- [x] [Navigation pruning] :material-alert-decagram:{ title="Added on May 25, 2022" }
178179
- [x] [Tooltips] :material-alert-decagram:{ title="Added on May 8, 2022" }
179-
- [x] [Chinese search support] :material-alert-decagram:{ title="Added on May 5, 2022" }
180+
- [x] [Chinese search support]
180181
- [x] [Tag icons]
181182
- [x] [Card grids]
182183
- [x] [Offline plugin]
@@ -256,7 +257,7 @@ are released for general availability.
256257
- [x] [Navigation icons]
257258
- [x] [Navigation pruning]
258259
- [ ] Navigation status badges
259-
- [ ] Blog
260+
- [ ] Blog plugin
260261

261262
[Annotations]: ../reference/annotations.md
262263
[Chinese search support]: ../blog/2022/chinese-search-support.md
@@ -268,13 +269,20 @@ are released for general availability.
268269
- [x] [Privacy plugin]
269270
- [x] [Card grids]
270271
- [x] [Tooltips]
271-
- [ ] [Instant previews]
272+
- [x] [Content tabs: anchor links]
272273
- [ ] Intelligent color palette (system preference)
273274
- [ ] Document authors/contributors
274275

275276
[Privacy plugin]: ../setup/ensuring-data-privacy.md
276277
[Card grids]: ../reference/grids.md
277278
[Tooltips]: ../reference/tooltips.md
279+
[Content tabs: anchor links]: ../reference/content-tabs.md#anchor-links
280+
281+
#### $ 16,000 – Chipotle
282+
283+
- [ ] [Instant previews]
284+
- [ ] ... more to be announced
285+
278286
[Instant previews]: https://twitter.com/squidfunk/status/1466794654213492743
279287

280288
### Goals completed

docs/reference/content-tabs.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,30 @@ See additional configuration options:
3131
[SuperFences]: ../setup/extensions/python-markdown-extensions.md#superfences
3232
[Tabbed]: ../setup/extensions/python-markdown-extensions.md#tabbed
3333
34+
### Anchor links :material-alert-decagram:{ title="Added on June 4, 2022" }
35+
36+
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
37+
[:octicons-tag-24: insiders-4.17.0][Insiders] ·
38+
:octicons-beaker-24: Experimental
39+
40+
In order to link to content tabs and share them more easily, [Insiders] adds
41+
an anchor link to each content tab automatically, which you can copy via right
42+
click or open in a new tab:
43+
44+
=== "Open me in a new tab ..."
45+
46+
=== "... or me ..."
47+
48+
=== "... or even me"
49+
50+
You can copy the link of the tab and create a link on the same or any other
51+
page. For example, you can [jump to the third tab above this paragraph][tab_1]
52+
or to the [publishing guide for Insiders][tab_2].
53+
54+
[Insiders]: ../insiders/index.md
55+
[tab_1]: #__tabbed_1_3
56+
[tab_2]: ../publishing-your-site.md#__tabbed_1_2
57+
3458
### Linked content tabs
3559
3660
[:octicons-tag-24: 8.3.0][link support] ·

docs/reference/tooltips.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ See additional configuration options:
3333
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
3434
[Snippets]: ../setup/extensions/python-markdown-extensions.md#snippets
3535
36-
### Improved tooltips
36+
### Improved tooltips :material-alert-decagram:{ title="Added on May 8, 2022" }
3737
3838
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
3939
[:octicons-tag-24: insiders-4.15.0][Insiders] ·

docs/setup/extensions/python-markdown.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ No configuration options are available. See reference for usage:
168168
- [Setting the page icon]
169169
- [Setting the page template]
170170
- [Adding tags]
171-
- [Hiding the tags]
171+
- [Hiding tags on a page]
172172
- [Hiding the sidebars]
173173
- [Hiding the feedback widget]
174174

@@ -179,7 +179,7 @@ No configuration options are available. See reference for usage:
179179
[Setting the page icon]: ../../reference/index.md#setting-the-page-icon
180180
[Setting the page template]: ../../reference/index.md#setting-the-page-template
181181
[Adding tags]: ../../setup/setting-up-tags.md#adding-tags
182-
[Hiding the tags]: ../../setup/setting-up-tags.md#hiding-the-tags
182+
[Hiding tags on a page]: ../../setup/setting-up-tags.md#hiding-tags-on-a-page
183183
[Hiding the sidebars]: ../../setup/setting-up-navigation.md#hiding-the-sidebars
184184
[Hiding the feedback widget]: ../../setup/setting-up-site-analytics.md#hiding-the-feedback-widget
185185

docs/setup/setting-up-navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ theme:
180180
[navigation.expand enabled]: ../assets/screenshots/navigation-expand.png
181181
[navigation.expand disabled]: ../assets/screenshots/navigation.png
182182

183-
### Navigation pruning
183+
### Navigation pruning :material-alert-decagram:{ title="Added on May 25, 2022" }
184184

185185
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
186186
[:octicons-tag-24: insiders-4.16.0][Insiders] ·

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,26 @@ extra:
148148
[Generator notice support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
149149
[Insiders]: ../insiders/index.md
150150

151+
## Usage
152+
153+
### Hiding prev/next links
154+
155+
When [Metadata] is enabled, the footer navigation showing links to the previous
156+
and next page can be hidden by adding the following lines to the front matter of
157+
a page:
158+
159+
``` sh
160+
---
161+
hide:
162+
- footer
163+
---
164+
165+
# Document title
166+
...
167+
```
168+
169+
[Metadata]: extensions/python-markdown.md#metadata
170+
151171
## Customization
152172

153173
### Custom copyright

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.3.0">
25+
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.3.1">
2626
{% endblock %}
2727
{% block htmltitle %}
2828
{% if page.meta and page.meta.title %}

0 commit comments

Comments
 (0)