From a0cc06b11251cbd34c13950d19139953b5848604 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 21 Sep 2023 18:56:35 +0200 Subject: [PATCH] Prepare 9.4.0 release --- .vscode/settings.json | 4 ++-- CHANGELOG | 10 ++++++++++ docs/changelog/index.md | 10 ++++++++++ docs/creating-your-site.md | 4 ++-- docs/reference/icons-emojis.md | 4 ++-- docs/schema/extensions/pymdownx.json | 4 ++-- docs/setup/changing-the-logo-and-icons.md | 4 ++-- docs/setup/extensions/index.md | 10 +++++----- docs/setup/extensions/python-markdown-extensions.md | 12 ++++++------ material/__init__.py | 2 +- material/templates/base.html | 2 +- package-lock.json | 4 ++-- package.json | 2 +- 13 files changed, 46 insertions(+), 26 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 36ef96f40..07c273165 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -14,8 +14,8 @@ "yaml.customTags": [ "!ENV scalar", "!ENV sequence", - "tag:yaml.org,2002:python/name:materialx.emoji.to_svg", - "tag:yaml.org,2002:python/name:materialx.emoji.twemoji", + "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg", + "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji", "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" ] } diff --git a/CHANGELOG b/CHANGELOG index 0ca98300b..b7273bb8f 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,13 @@ +mkdocs-material-9.4.0 (2023-09-21) + + * Added Belarusian translations + * Added version info to entrypoint of package + * Added emoji extension as a replacement for materialx + * Improved slate color scheme (dark mode) - now even darker + * Restructured project to improve development experience + * Updated MkDocs to 1.5.3 + * Fixed #3890: Development mode crashes on Linux + mkdocs-material-9.3.2+insiders-4.42.0 (2023-09-19) * Added support for using git submodules in projects plugin diff --git a/docs/changelog/index.md b/docs/changelog/index.md index 18bdb9cc7..0fa493860 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -2,6 +2,16 @@ ## Material for MkDocs +### 9.4.0 September 21, 2023 { id="9.4.0" } + +- Added Belarusian translations +- Added version info to entrypoint of package +- Added emoji extension as a replacement for materialx +- Improved slate color scheme (dark mode) - now even darker +- Restructured project to improve development experience +- Updated MkDocs to 1.5.3 +- Fixed #3890: Development mode crash on Linux + ### 9.3.2 September 19, 2023 { id="9.3.2" } - Updated Slovenian translations diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index dd6d6fee9..7aff2746e 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -66,8 +66,8 @@ theme: "yaml.customTags": [ // (1)! "!ENV scalar", "!ENV sequence", - "tag:yaml.org,2002:python/name:materialx.emoji.to_svg", - "tag:yaml.org,2002:python/name:materialx.emoji.twemoji", + "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg", + "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji", "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" ] } diff --git a/docs/reference/icons-emojis.md b/docs/reference/icons-emojis.md index 69909d450..bff42037e 100644 --- a/docs/reference/icons-emojis.md +++ b/docs/reference/icons-emojis.md @@ -41,8 +41,8 @@ lines to `mkdocs.yml`: markdown_extensions: - attr_list - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg ``` The following icon sets are bundled with Material for MkDocs: diff --git a/docs/schema/extensions/pymdownx.json b/docs/schema/extensions/pymdownx.json index a821ca62c..c6f50c79b 100644 --- a/docs/schema/extensions/pymdownx.json +++ b/docs/schema/extensions/pymdownx.json @@ -168,11 +168,11 @@ "properties": { "emoji_generator": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_generator", - "default": "!!python/name:materialx.emoji.to_svg" + "default": "!!python/name:material.extensions.emoji.to_svg" }, "emoji_index": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_index", - "default": "!!python/name:materialx.emoji.twemoji" + "default": "!!python/name:material.extensions.emoji.twemoji" }, "options": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", diff --git a/docs/setup/changing-the-logo-and-icons.md b/docs/setup/changing-the-logo-and-icons.md index 414dcf4d7..c8cdd05ff 100644 --- a/docs/setup/changing-the-logo-and-icons.md +++ b/docs/setup/changing-the-logo-and-icons.md @@ -129,8 +129,8 @@ Then, add the following lines to `mkdocs.yml`: ``` yaml markdown_extensions: - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg options: custom_icons: - overrides/.icons diff --git a/docs/setup/extensions/index.md b/docs/setup/extensions/index.md index db440bc34..7acf2e628 100644 --- a/docs/setup/extensions/index.md +++ b/docs/setup/extensions/index.md @@ -15,7 +15,7 @@ syntax extensions for technical writing. ## Supported extensions -The following extensions are all supported by Material for MkDocs and therefore +The following extensions are all supported by Material for MkDocs and therefore strongly recommended. Click on each extension to learn about its purpose and configuration: @@ -77,8 +77,8 @@ your documentation project. ### Minimal configuration -This configuration is a good starting point for when you're using Material for -MkDocs for the first time. The best idea is to explore the [reference], and +This configuration is a good starting point for when you're using Material for +MkDocs for the first time. The best idea is to explore the [reference], and gradually add what you want to use: ``` yaml @@ -121,8 +121,8 @@ markdown_extensions: - pymdownx.caret - pymdownx.details - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.highlight - pymdownx.inlinehilite - pymdownx.keys diff --git a/docs/setup/extensions/python-markdown-extensions.md b/docs/setup/extensions/python-markdown-extensions.md index 3b19859ce..0893d29b4 100644 --- a/docs/setup/extensions/python-markdown-extensions.md +++ b/docs/setup/extensions/python-markdown-extensions.md @@ -222,8 +222,8 @@ in `*.svg` file format into the resulting HTML page. Enable it via `mkdocs.yml`: ``` yaml markdown_extensions: - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji # (1)! - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji # (1)! + emoji_generator: !!python/name:material.extensions.emoji.to_svg ``` 1. [Python Markdown Extensions] uses the `pymdownx` namespace, but in order to @@ -241,7 +241,7 @@ The following configuration options are supported: ``` yaml markdown_extensions: - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji + emoji_index: !!python/name:material.extensions.emoji.twemoji ``` @@ -253,7 +253,7 @@ The following configuration options are supported: ``` yaml markdown_extensions: - pymdownx.emoji: - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_generator: !!python/name:material.extensions.emoji.to_svg ``` @@ -265,8 +265,8 @@ The following configuration options are supported: ``` yaml markdown_extensions: - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg options: custom_icons: - overrides/.icons diff --git a/material/__init__.py b/material/__init__.py index d89d649d0..a6e03b58d 100644 --- a/material/__init__.py +++ b/material/__init__.py @@ -18,4 +18,4 @@ # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. -__version__ = "9.3.2" +__version__ = "9.4.0" diff --git a/material/templates/base.html b/material/templates/base.html index 36fcdae02..bfe7193cb 100644 --- a/material/templates/base.html +++ b/material/templates/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 366a16d5a..47cb14c6c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "mkdocs-material", - "version": "9.3.2", + "version": "9.4.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "mkdocs-material", - "version": "9.3.2", + "version": "9.4.0", "license": "MIT", "dependencies": { "clipboard": "^2.0.11", diff --git a/package.json b/package.json index 87279274d..66d52a3ef 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "9.3.2", + "version": "9.4.0", "description": "Documentation that simply works", "keywords": [ "mkdocs",