mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-28 01:10:58 +01:00
Prepare 8.0.3 release
This commit is contained in:
parent
0b22e78832
commit
b6ca0a1053
12
CHANGELOG
12
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)
|
mkdocs-material-8.0.2+insiders-4.1.0 (2021-11-30)
|
||||||
|
|
||||||
* Added support for passing page title to feedback forms
|
* Added support for passing page title to feedback forms
|
||||||
|
@ -6,6 +6,13 @@ template: overrides/main.html
|
|||||||
|
|
||||||
## Material for MkDocs
|
## Material for MkDocs
|
||||||
|
|
||||||
|
### 8.0.3 <small>_ December 2, 2021</small> { 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 <small>_ November 30, 2021</small> { id="8.0.2" }
|
### 8.0.2 <small>_ November 30, 2021</small> { id="8.0.2" }
|
||||||
|
|
||||||
- Fixed #3275: Code annotations always disappear on click
|
- Fixed #3275: Code annotations always disappear on click
|
||||||
|
@ -6,7 +6,12 @@ template: overrides/main.html
|
|||||||
|
|
||||||
## Material for MkDocs Insiders
|
## Material for MkDocs Insiders
|
||||||
|
|
||||||
### 4.1.0 <small>_ November 30, 2021</small> { id="4.0.0" }
|
### 4.2.0 <small>_ December 2, 2021</small> { id="4.2.0" }
|
||||||
|
|
||||||
|
- Added support for dismissable announcement bar
|
||||||
|
- Added support for named placeholders in feedback widget
|
||||||
|
|
||||||
|
### 4.1.0 <small>_ November 30, 2021</small> { id="4.1.0" }
|
||||||
|
|
||||||
- Added support for passing page title to feedback forms
|
- Added support for passing page title to feedback forms
|
||||||
|
|
||||||
|
@ -162,8 +162,9 @@ The following features are solely available via Material for MkDocs Insiders:
|
|||||||
|
|
||||||
<div class="mdx-columns" markdown>
|
<div class="mdx-columns" markdown>
|
||||||
|
|
||||||
- [x] [Was this page helpful?] :material-new-box:
|
- [x] [Dismissable announcement bar] :material-new-box:
|
||||||
- [x] [Brand new search plugin] :material-new-box:
|
- [x] [Was this page helpful?]
|
||||||
|
- [x] [Brand new search plugin]
|
||||||
- [x] [Rich search previews]
|
- [x] [Rich search previews]
|
||||||
- [x] [Tokenizer with lookahead]
|
- [x] [Tokenizer with lookahead]
|
||||||
- [x] [Advanced search highlighting]
|
- [x] [Advanced search highlighting]
|
||||||
@ -172,7 +173,7 @@ The following features are solely available via Material for MkDocs Insiders:
|
|||||||
- [x] [Cookie consent]
|
- [x] [Cookie consent]
|
||||||
- [x] [Linking content tabs]
|
- [x] [Linking content tabs]
|
||||||
- [x] [Boosting pages in search]
|
- [x] [Boosting pages in search]
|
||||||
- [x] [Tags] with search integration
|
- [x] [Tags with search integration]
|
||||||
- [x] [Stay on page when switching versions]
|
- [x] [Stay on page when switching versions]
|
||||||
- [x] [Custom admonition icons]
|
- [x] [Custom admonition icons]
|
||||||
- [x] [Mermaid.js integration]
|
- [x] [Mermaid.js integration]
|
||||||
@ -193,11 +194,11 @@ are released for general availability.
|
|||||||
|
|
||||||
- [x] [Mermaid.js integration]
|
- [x] [Mermaid.js integration]
|
||||||
- [x] [Stay on page when switching versions]
|
- [x] [Stay on page when switching versions]
|
||||||
- [x] [Tags] with search integration
|
- [x] [Tags with search integration]
|
||||||
|
|
||||||
[Mermaid.js integration]: ../reference/diagrams.md
|
[Mermaid.js integration]: ../reference/diagrams.md
|
||||||
[Stay on page when switching versions]: ../setup/setting-up-versioning.md#stay-on-page
|
[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
|
#### $ 6,000 – Trinidad Scorpion
|
||||||
|
|
||||||
@ -213,10 +214,11 @@ are released for general availability.
|
|||||||
|
|
||||||
- [x] [Cookie consent]
|
- [x] [Cookie consent]
|
||||||
- [x] [Was this page helpful?]
|
- [x] [Was this page helpful?]
|
||||||
- [ ] Link cards
|
- [x] [Dismissable announcement bar]
|
||||||
|
|
||||||
[Cookie consent]: ../setup/setting-up-site-analytics.md#cookie-consent
|
[Cookie consent]: ../setup/setting-up-site-analytics.md#cookie-consent
|
||||||
[Was this page helpful?]: ../setup/setting-up-site-analytics.md#was-this-page-helpful
|
[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
|
#### $ 8,000 – Scotch Bonnet
|
||||||
|
|
||||||
|
@ -31,6 +31,8 @@ theme:
|
|||||||
|
|
||||||
[Automatic hiding support]: https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.0
|
[Automatic hiding support]: https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.0
|
||||||
|
|
||||||
|
## Customization
|
||||||
|
|
||||||
### Announcement bar
|
### Announcement bar
|
||||||
|
|
||||||
[:octicons-tag-24: 5.0.0][Announcement bar support] ·
|
[: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
|
[Announcement bar support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
|
||||||
[extend the theme]: ../customization.md#extending-the-theme
|
[extend the theme]: ../customization.md#extending-the-theme
|
||||||
[overriding blocks]: ../customization.md#overriding-blocks
|
[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]: #
|
||||||
|
@ -22,7 +22,7 @@
|
|||||||
<link rel="canonical" href="{{ page.canonical_url }}">
|
<link rel="canonical" href="{{ page.canonical_url }}">
|
||||||
{% endif %}
|
{% endif %}
|
||||||
<link rel="icon" href="{{ config.theme.favicon | url }}">
|
<link rel="icon" href="{{ config.theme.favicon | url }}">
|
||||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.0.2">
|
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.0.3">
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
{% block htmltitle %}
|
{% block htmltitle %}
|
||||||
{% if page and page.meta and page.meta.title %}
|
{% if page and page.meta and page.meta.title %}
|
||||||
|
2
package-lock.json
generated
2
package-lock.json
generated
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "mkdocs-material",
|
"name": "mkdocs-material",
|
||||||
"version": "8.0.2",
|
"version": "8.0.3",
|
||||||
"lockfileVersion": 1,
|
"lockfileVersion": 1,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "mkdocs-material",
|
"name": "mkdocs-material",
|
||||||
"version": "8.0.2",
|
"version": "8.0.3",
|
||||||
"description": "A Material Design theme for MkDocs",
|
"description": "A Material Design theme for MkDocs",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"mkdocs",
|
"mkdocs",
|
||||||
|
Loading…
Reference in New Issue
Block a user