mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-23 23:21:00 +01:00
Prepare 9.2.4 release
This commit is contained in:
parent
db568b1e6b
commit
cafdc48a8a
@ -1,5 +1,12 @@
|
||||
mkdocs-material-9.2.4 (2023-xx-xx)
|
||||
mkdocs-material-9.2.4+insiders-4.40.0 (2023-08-26)
|
||||
|
||||
* Added logo, title and description options to social plugin default layouts
|
||||
* Fixed privacy plugin compatibility issue with Python < 3.10
|
||||
* Fixed #5896: Blog plugin errors when using custom index pages
|
||||
|
||||
mkdocs-material-9.2.4 (2023-08-26)
|
||||
|
||||
* Added version to bug report name in info plugin
|
||||
* Updated Afrikaans translations
|
||||
|
||||
mkdocs-material-9.2.3+insiders-4.39.3 (2023-08-24)
|
||||
|
@ -2,6 +2,11 @@
|
||||
|
||||
## Material for MkDocs
|
||||
|
||||
### 9.2.4 <small>August 26, 2023</small> { id="9.2.4" }
|
||||
|
||||
- Added version to bug report name in info plugin
|
||||
- Updated Afrikaans translations
|
||||
|
||||
### 9.2.3 <small>August 22, 2023</small> { id="9.2.3" }
|
||||
|
||||
- Fixed blog plugin rendering wrongly with `markdown.extensions.toc`
|
||||
|
@ -2,6 +2,12 @@
|
||||
|
||||
## Material for MkDocs Insiders
|
||||
|
||||
### 4.40.0 <small>August 26, 2023</small> { id="4.39.3" }
|
||||
|
||||
- Added logo, title and description options to social plugin default layouts
|
||||
- Fixed privacy plugin compatibility issue with Python < 3.10
|
||||
- Fixed #5896: Blog plugin errors when using custom index pages
|
||||
|
||||
### 4.39.3 <small>August 24, 2023</small> { id="4.39.3" }
|
||||
|
||||
- Fixed lxml dependency missing in Docker container (4.39.2 regression)
|
||||
|
@ -331,6 +331,46 @@ The following configuration options are available for card generation:
|
||||
font_family: Ubuntu
|
||||
```
|
||||
|
||||
[`title`](#+social.cards_layout_options.title){ #+social.cards_layout_options.title }
|
||||
|
||||
: [:octicons-tag-24: insiders-4.40.0][Insiders] – Set the social card
|
||||
title, which takes precedence over `page.title` and `page.meta.title`:
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- social:
|
||||
cards_layout_options:
|
||||
title: Social card title
|
||||
```
|
||||
|
||||
[`description`](#+social.cards_layout_options.description){ #+social.cards_layout_options.description }
|
||||
|
||||
: [:octicons-tag-24: insiders-4.40.0][Insiders] – Set the social card
|
||||
description, which takes precedence over `site_description` and
|
||||
`page.meta.description`:
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- social:
|
||||
cards_layout_options:
|
||||
description: Social card description
|
||||
```
|
||||
|
||||
[`logo`](#+social.cards_layout_options.logo){ #+social.cards_layout_options.logo }
|
||||
|
||||
: [:octicons-tag-24: insiders-4.40.0][Insiders] – Set the logo used as
|
||||
part of the social card, overriding the `theme.logo` or
|
||||
`theme.icon.logo` settings which are used as defaults:
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- social:
|
||||
cards_layout_options:
|
||||
logo: layouts/logo.png
|
||||
```
|
||||
|
||||
The path of the image must be defined relative to the project root.
|
||||
|
||||
[`cards_include`](#+privacy.cards_include){ #+privacy.cards_include }
|
||||
|
||||
: [:octicons-tag-24: insiders-4.35.0][Insiders] · :octicons-milestone-24:
|
||||
@ -507,16 +547,16 @@ The following configuration options are available for caching:
|
||||
## Usage
|
||||
|
||||
If you want to adjust the title or set a custom description for the social card,
|
||||
you can set the front matter `title` and `description` properties, which take
|
||||
precedence over the default values.
|
||||
you can set the front matter [`title`][Changing the title] and
|
||||
[`description`][Changing the description] properties, which take precedence over
|
||||
the defaults, or use:
|
||||
|
||||
- [Changing the title]
|
||||
- [Changing the description]
|
||||
- [`cards_layout_options.title`](#+social.cards_layout_options.title)
|
||||
- [`cards_layout_options.description`](#+social.cards_layout_options.description)
|
||||
|
||||
[Changing the title]: ../reference/index.md#setting-the-page-title
|
||||
[Changing the description]: ../reference/index.md#setting-the-page-description
|
||||
|
||||
|
||||
### Choosing a font
|
||||
|
||||
Some fonts do not contain CJK characters, like for example the
|
||||
|
@ -32,7 +32,7 @@
|
||||
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
|
||||
{% endif %}
|
||||
<link rel="icon" href="{{ config.theme.favicon | url }}">
|
||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.2.3">
|
||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.2.4">
|
||||
{% endblock %}
|
||||
{% block htmltitle %}
|
||||
{% if page.meta and page.meta.title %}
|
||||
|
4
package-lock.json
generated
4
package-lock.json
generated
@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "mkdocs-material",
|
||||
"version": "9.2.3",
|
||||
"version": "9.2.4",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "mkdocs-material",
|
||||
"version": "9.2.3",
|
||||
"version": "9.2.4",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"clipboard": "^2.0.11",
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "mkdocs-material",
|
||||
"version": "9.2.3",
|
||||
"version": "9.2.4",
|
||||
"description": "Documentation that simply works",
|
||||
"keywords": [
|
||||
"mkdocs",
|
||||
|
Loading…
Reference in New Issue
Block a user