1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-27 17:00:54 +01:00

Prepare 8.3.1 release

This commit is contained in:
squidfunk 2022-06-04 13:29:47 +02:00
parent c4cb6b45a3
commit 6f69e3ca74
12 changed files with 91 additions and 11 deletions

View File

@ -1,3 +1,17 @@
mkdocs-material-8.3.1+insiders-4.17.0 (2022-06-04)
* Added support for content tabs anchor links (deep linking)
* Fixed #3975: Detect composition events in search interface (Chinese)
* Fixed #3980: Search plugin doesn't use title set via front matter
mkdocs-material-8.3.1 (2022-06-04)
* Bump required Jinja version to 3.0.2
* Removed unnecessary conditions in templates
* Fixed scroll offset when content tabs are brought into view
* Fixed #3977: Content tabs snapping oddly in Firefox
* Fixed #3983: Missing condition in footer partial (8.3.0 regression)
mkdocs-material-8.3.0 (2022-06-02)
* Added support for custom admonition icons

View File

@ -6,6 +6,14 @@ template: overrides/main.html
## Material for MkDocs
### 8.3.1 <small>_ June 4, 2022</small> { id="8.3.1" }
- Bump required Jinja version to 3.0.2
- Removed unnecessary conditions in templates
- Fixed scroll offset when content tabs are brought into view
- Fixed #3977: Content tabs snapping oddly in Firefox
- Fixed #3983: Missing condition in footer partial (8.3.0 regression)
### 8.3.0 <small>_ June 2, 2022</small> { id="8.3.0" }
- Added support for custom admonition icons

View File

@ -6,6 +6,12 @@ template: overrides/main.html
## Material for MkDocs Insiders
### 4.17.0 <small>_ June 4, 2022</small> { id="4.17.0" }
- Added support for content tabs anchor links (deep linking)
- Fixed #3975: Detect composition events in search interface (Chinese)
- Fixed #3980: Search plugin doesn't use title set via front matter
### 4.16.2 <small>_ May 29, 2022</small> { id="4.16.2" }
- Fixed #3961: Nested sections triggered build error for navigation tabs

View File

@ -174,9 +174,10 @@ which are currently exclusively available to sponsors:
<div class="mdx-columns" markdown>
- [x] [Content tabs: anchor links] :material-alert-decagram:{ title="Added on June 4, 2022" }
- [x] [Navigation pruning] :material-alert-decagram:{ title="Added on May 25, 2022" }
- [x] [Tooltips] :material-alert-decagram:{ title="Added on May 8, 2022" }
- [x] [Chinese search support] :material-alert-decagram:{ title="Added on May 5, 2022" }
- [x] [Chinese search support]
- [x] [Tag icons]
- [x] [Card grids]
- [x] [Offline plugin]
@ -256,7 +257,7 @@ are released for general availability.
- [x] [Navigation icons]
- [x] [Navigation pruning]
- [ ] Navigation status badges
- [ ] Blog
- [ ] Blog plugin
[Annotations]: ../reference/annotations.md
[Chinese search support]: ../blog/2022/chinese-search-support.md
@ -268,13 +269,20 @@ are released for general availability.
- [x] [Privacy plugin]
- [x] [Card grids]
- [x] [Tooltips]
- [ ] [Instant previews]
- [x] [Content tabs: anchor links]
- [ ] Intelligent color palette (system preference)
- [ ] Document authors/contributors
[Privacy plugin]: ../setup/ensuring-data-privacy.md
[Card grids]: ../reference/grids.md
[Tooltips]: ../reference/tooltips.md
[Content tabs: anchor links]: ../reference/content-tabs.md#anchor-links
#### $ 16,000 Chipotle
- [ ] [Instant previews]
- [ ] ... more to be announced
[Instant previews]: https://twitter.com/squidfunk/status/1466794654213492743
### Goals completed

View File

@ -31,6 +31,30 @@ See additional configuration options:
[SuperFences]: ../setup/extensions/python-markdown-extensions.md#superfences
[Tabbed]: ../setup/extensions/python-markdown-extensions.md#tabbed
### Anchor links :material-alert-decagram:{ title="Added on June 4, 2022" }
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-4.17.0][Insiders] ·
:octicons-beaker-24: Experimental
In order to link to content tabs and share them more easily, [Insiders] adds
an anchor link to each content tab automatically, which you can copy via right
click or open in a new tab:
=== "Open me in a new tab ..."
=== "... or me ..."
=== "... or even me"
You can copy the link of the tab and create a link on the same or any other
page. For example, you can [jump to the third tab above this paragraph][tab_1]
or to the [publishing guide for Insiders][tab_2].
[Insiders]: ../insiders/index.md
[tab_1]: #__tabbed_1_3
[tab_2]: ../publishing-your-site.md#__tabbed_1_2
### Linked content tabs
[:octicons-tag-24: 8.3.0][link support] ·

View File

@ -33,7 +33,7 @@ See additional configuration options:
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
[Snippets]: ../setup/extensions/python-markdown-extensions.md#snippets
### Improved tooltips
### Improved tooltips :material-alert-decagram:{ title="Added on May 8, 2022" }
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-4.15.0][Insiders] ·

View File

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

View File

@ -180,7 +180,7 @@ theme:
[navigation.expand enabled]: ../assets/screenshots/navigation-expand.png
[navigation.expand disabled]: ../assets/screenshots/navigation.png
### Navigation pruning
### Navigation pruning :material-alert-decagram:{ title="Added on May 25, 2022" }
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-4.16.0][Insiders] ·

View File

@ -148,6 +148,26 @@ extra:
[Generator notice support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
[Insiders]: ../insiders/index.md
## Usage
### Hiding prev/next links
When [Metadata] is enabled, the footer navigation showing links to the previous
and next page can be hidden by adding the following lines to the front matter of
a page:
``` sh
---
hide:
- footer
---
# Document title
...
```
[Metadata]: extensions/python-markdown.md#metadata
## Customization
### Custom copyright

View File

@ -22,7 +22,7 @@
<link rel="canonical" href="{{ page.canonical_url }}">
{% endif %}
<link rel="icon" href="{{ config.theme.favicon | url }}">
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.3.0">
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.3.1">
{% endblock %}
{% block htmltitle %}
{% if page.meta and page.meta.title %}

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{
"name": "mkdocs-material",
"version": "8.3.0",
"version": "8.3.1",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "mkdocs-material",
"version": "8.3.0",
"version": "8.3.1",
"license": "MIT",
"dependencies": {
"array-flat-polyfill": "^1.0.1",

View File

@ -1,6 +1,6 @@
{
"name": "mkdocs-material",
"version": "8.3.0",
"version": "8.3.1",
"description": "Documentation that simply works",
"keywords": [
"mkdocs",