docs: add mermaid plugin for mkdocs (#263)

Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>

Author: ktro2828

.pre-commit-config.yaml

@@ -10,6 +10,7 @@ repos:
       - id: check-toml
       - id: check-xml
       - id: check-yaml
+        exclude: ^mkdocs\.yaml$
       - id: detect-private-key
       - id: end-of-file-fixer
       - id: mixed-line-ending

mkdocs.yaml

@@ -51,6 +51,7 @@ theme:
 
 plugins:
   - search
+  - mermaid2
   - mike:
       version_selector: true
       canonical_version: latest
@@ -94,7 +95,12 @@ markdown_extensions:
       pygments_lang_class: true
   - pymdownx.inlinehilite
   - pymdownx.snippets
-  - pymdownx.superfences
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:mermaid2.fence_mermaid_custom
+
   - pymdownx.details
   - admonition
 

pyproject.toml

@@ -35,6 +35,7 @@ dev = [
     "mkdocstrings[python]>=0.18",
     "ruff>=0.8",
     "mike>=2.1.3",
+    "mkdocs-mermaid2-plugin>=1.2.3",
 ]
 
 [project.scripts]