Merge pull request #5281 from jitseklomp/mermaid

Add mermaid mkdocs plugin

Author: trozet

mkdocs.yml

@@ -42,6 +42,7 @@ plugins:
   - macros:
       #include_dir: examples
       j2_line_comment_prefix: "#$"
+  - mermaid2
   - blog:
       # NOTE: configuration options can be found at
       # https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/
@@ -58,7 +59,11 @@ markdown_extensions:
   - pymdownx.details
   - pymdownx.highlight
   - pymdownx.inlinehilite
-  - pymdownx.superfences
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:mermaid2.fence_mermaid_custom
   - pymdownx.snippets:
       base_path: site-src
       check_paths: true

requirements.txt

@@ -10,6 +10,7 @@ mkdocs-awesome-pages-plugin
 mkdocs-macros-plugin
 mkdocs-material
 mkdocs-material-extensions
+mkdocs-mermaid2-plugin
 mike
 pep562
 Pygments