From 92be6d2c2c322cd8f3950501755e5f2e4b70c074 Mon Sep 17 00:00:00 2001 From: flokoe Date: Sun, 28 Jan 2024 16:59:48 +0100 Subject: [PATCH] Update dev instructions and deprecated markdown_extension --- README.md | 4 +++- mkdocs.yml | 4 ++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 76bc00a..f306a6d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,9 @@ This repo tries to preserve and present all this valuable information in a moder To edit and develop locally install the following packages and run the built in dev webserver: ```bash -pip install mkdocs-material mkdocs-git-revision-date-localized-plugin +python3 -m venv env +pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-awesome-pages-plugin mkdocs-minify-plugin +source env/bin/activate mkdocs serve ``` diff --git a/mkdocs.yml b/mkdocs.yml index 703c386..023d543 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,8 +40,8 @@ plugins: markdown_extensions: - admonition - 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.superfences