From 556c39460fbe898efe407a5af03ebbc5e7ad0f5e Mon Sep 17 00:00:00 2001 From: John Practicalli <250870+practicalli-john@users.noreply.github.com> Date: Fri, 20 Oct 2023 14:38:00 +0100 Subject: [PATCH] mkdocs: update emoji extension name for material 9.4 and update readme --- CHANGELOG.md | 1 + README.md | 2 +- mkdocs.yml | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b8caa6d..3e8adb31 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ - dev: action/checkout v4 with sparse-checkout for megalinter - dev: sparse-checkout for publish-book workflow - dev: action/checkout v4 with sparse-checkout for changelog checker workflow +- mkdocs: update emoji extension name for material 9.4 and update readme ### Added - building-api: add reitit overview and quick intro diff --git a/README.md b/README.md index ae3a8a4f..600fdcf4 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Publish book workflow installs Material for MkDocs version 9 Install mkdocs version 9 using the Python pip package manager ```bash -pip install mkdocs-material=="9.*" +pip3 install mkdocs-material=="9.4" ``` Install the plugins used by the Practicalli site using Pip (these are also installed in the GitHub Action workflow) diff --git a/mkdocs.yml b/mkdocs.yml index 92e37c90..eef7edb3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,8 +63,8 @@ markdown_extensions: - md_in_html # Grids - footnotes # footnotes and abbreviations - 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: anchor_linenums: true - pymdownx.inlinehilite