diff --git a/CHANGELOG b/CHANGELOG index d95971c50..6a010f684 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -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) diff --git a/docs/changelog/index.md b/docs/changelog/index.md index 7e61f016c..1bb949d33 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -2,6 +2,11 @@ ## Material for MkDocs +### 9.2.4 August 26, 2023 { id="9.2.4" } + +- Added version to bug report name in info plugin +- Updated Afrikaans translations + ### 9.2.3 August 22, 2023 { id="9.2.3" } - Fixed blog plugin rendering wrongly with `markdown.extensions.toc` diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index b74a92468..e6d6eb2ab 100644 --- a/docs/insiders/changelog.md +++ b/docs/insiders/changelog.md @@ -2,6 +2,12 @@ ## Material for MkDocs Insiders +### 4.40.0 August 26, 2023 { 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 August 24, 2023 { id="4.39.3" } - Fixed lxml dependency missing in Docker container (4.39.2 regression) diff --git a/docs/setup/setting-up-social-cards.md b/docs/setup/setting-up-social-cards.md index 15581f0e4..14daa4206 100644 --- a/docs/setup/setting-up-social-cards.md +++ b/docs/setup/setting-up-social-cards.md @@ -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 diff --git a/material/base.html b/material/base.html index 44a77d010..2b41684ec 100644 --- a/material/base.html +++ b/material/base.html @@ -32,7 +32,7 @@ {% endif %} - + {% endblock %} {% block htmltitle %} {% if page.meta and page.meta.title %} diff --git a/package-lock.json b/package-lock.json index ec05d3791..3c2e6e8fe 100644 --- a/package-lock.json +++ b/package-lock.json @@ -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", diff --git a/package.json b/package.json index 460a0233d..fe10b98d9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "9.2.3", + "version": "9.2.4", "description": "Documentation that simply works", "keywords": [ "mkdocs",