From f21ecac9f024c20cc45e84bb22daf92e28308fea Mon Sep 17 00:00:00 2001 From: Bernd Reuther Date: Thu, 22 Oct 2020 16:52:29 +0200 Subject: [PATCH] mermaid2 --- docs/index.md | 19 +++++++------------ mkdocs.yml | 15 ++++++--------- 2 files changed, 13 insertions(+), 21 deletions(-) diff --git a/docs/index.md b/docs/index.md index f857991..e952634 100644 --- a/docs/index.md +++ b/docs/index.md @@ -374,26 +374,21 @@ plugins: #### Block-Diagramme ``` -pip3 install mkdocs-build-plantuml-plugin +pip3 install mkdocs-mermaid2-plugin ``` Änderung in "mkdocs.yml": ``` plugins: - - build_plantuml: - render: "server" # or "local" for local rendering - bin_path: "/usr/local/bin/plantuml" # ignored when render: server - server: "http://www.plantuml.com/plantuml" # offical plantuml server - output_format: "svg" # or "png" - diagram_root: "docs/diagrams" # should reside under docs_dir - output_folder: "out" - input_folder: "src" - input_extensions: "" # comma separated list of extensions to parse, by default every file is parsed + - mermaid2 ``` Beispiel: -```plantuml -Alice -> Bob +```mermaid +graph TD +A[Client] --> B[Load Balancer] +B --> C[Server01] +B --> D[Server02] ``` diff --git a/mkdocs.yml b/mkdocs.yml index d3f582f..2cac189 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,6 +21,11 @@ markdown_extensions: - pymdownx.details - pymdownx.highlight - pymdownx.superfences + # make exceptions to highlighting of code: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:mermaid2.fence_mermaid - pymdownx.inlinehilite - pymdownx.keys - pymdownx.tabbed @@ -35,12 +40,4 @@ plugins: placeholder: z.B. 0.0.0.0 DOMAIN_NAME: placeholder: z.B. fritz.box - - build_plantuml: - render: "server" # or "local" for local rendering - bin_path: "/usr/local/bin/plantuml" # ignored when render: server - server: "http://www.plantuml.com/plantuml" # offical plantuml server - output_format: "svg" # or "png" - diagram_root: "docs/diagrams" # should reside under docs_dir - output_folder: "out" - input_folder: "src" - input_extensions: "" # comma separated list of extensions to parse, by default every file is parsed \ No newline at end of file + - mermaid2 \ No newline at end of file