Skip to content

Commit cafdc48

Browse files
committed
Prepare 9.2.4 release
1 parent db568b1 commit cafdc48

File tree

7 files changed

+68
-10
lines changed

7 files changed

+68
-10
lines changed

CHANGELOG

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
mkdocs-material-9.2.4 (2023-xx-xx)
1+
mkdocs-material-9.2.4+insiders-4.40.0 (2023-08-26)
22

3+
* Added logo, title and description options to social plugin default layouts
4+
* Fixed privacy plugin compatibility issue with Python < 3.10
5+
* Fixed #5896: Blog plugin errors when using custom index pages
6+
7+
mkdocs-material-9.2.4 (2023-08-26)
8+
9+
* Added version to bug report name in info plugin
310
* Updated Afrikaans translations
411

512
mkdocs-material-9.2.3+insiders-4.39.3 (2023-08-24)

docs/changelog/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
## Material for MkDocs
44

5+
### 9.2.4 <small>August 26, 2023</small> { id="9.2.4" }
6+
7+
- Added version to bug report name in info plugin
8+
- Updated Afrikaans translations
9+
510
### 9.2.3 <small>August 22, 2023</small> { id="9.2.3" }
611

712
- Fixed blog plugin rendering wrongly with `markdown.extensions.toc`

docs/insiders/changelog.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
## Material for MkDocs Insiders
44

5+
### 4.40.0 <small>August 26, 2023</small> { id="4.39.3" }
6+
7+
- Added logo, title and description options to social plugin default layouts
8+
- Fixed privacy plugin compatibility issue with Python < 3.10
9+
- Fixed #5896: Blog plugin errors when using custom index pages
10+
511
### 4.39.3 <small>August 24, 2023</small> { id="4.39.3" }
612

713
- Fixed lxml dependency missing in Docker container (4.39.2 regression)

docs/setup/setting-up-social-cards.md

+45-5
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,46 @@ The following configuration options are available for card generation:
331331
font_family: Ubuntu
332332
```
333333

334+
[`title`](#+social.cards_layout_options.title){ #+social.cards_layout_options.title }
335+
336+
: [:octicons-tag-24: insiders-4.40.0][Insiders] – Set the social card
337+
title, which takes precedence over `page.title` and `page.meta.title`:
338+
339+
``` yaml
340+
plugins:
341+
- social:
342+
cards_layout_options:
343+
title: Social card title
344+
```
345+
346+
[`description`](#+social.cards_layout_options.description){ #+social.cards_layout_options.description }
347+
348+
: [:octicons-tag-24: insiders-4.40.0][Insiders] – Set the social card
349+
description, which takes precedence over `site_description` and
350+
`page.meta.description`:
351+
352+
``` yaml
353+
plugins:
354+
- social:
355+
cards_layout_options:
356+
description: Social card description
357+
```
358+
359+
[`logo`](#+social.cards_layout_options.logo){ #+social.cards_layout_options.logo }
360+
361+
: [:octicons-tag-24: insiders-4.40.0][Insiders] – Set the logo used as
362+
part of the social card, overriding the `theme.logo` or
363+
`theme.icon.logo` settings which are used as defaults:
364+
365+
``` yaml
366+
plugins:
367+
- social:
368+
cards_layout_options:
369+
logo: layouts/logo.png
370+
```
371+
372+
The path of the image must be defined relative to the project root.
373+
334374
[`cards_include`](#+privacy.cards_include){ #+privacy.cards_include }
335375

336376
: [:octicons-tag-24: insiders-4.35.0][Insiders] · :octicons-milestone-24:
@@ -507,16 +547,16 @@ The following configuration options are available for caching:
507547
## Usage
508548

509549
If you want to adjust the title or set a custom description for the social card,
510-
you can set the front matter `title` and `description` properties, which take
511-
precedence over the default values.
550+
you can set the front matter [`title`][Changing the title] and
551+
[`description`][Changing the description] properties, which take precedence over
552+
the defaults, or use:
512553

513-
- [Changing the title]
514-
- [Changing the description]
554+
- [`cards_layout_options.title`](#+social.cards_layout_options.title)
555+
- [`cards_layout_options.description`](#+social.cards_layout_options.description)
515556

516557
[Changing the title]: ../reference/index.md#setting-the-page-title
517558
[Changing the description]: ../reference/index.md#setting-the-page-description
518559

519-
520560
### Choosing a font
521561

522562
Some fonts do not contain CJK characters, like for example the

material/base.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
3333
{% endif %}
3434
<link rel="icon" href="{{ config.theme.favicon | url }}">
35-
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.2.3">
35+
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.2.4">
3636
{% endblock %}
3737
{% block htmltitle %}
3838
{% if page.meta and page.meta.title %}

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mkdocs-material",
3-
"version": "9.2.3",
3+
"version": "9.2.4",
44
"description": "Documentation that simply works",
55
"keywords": [
66
"mkdocs",

0 commit comments

Comments
 (0)