This commit is contained in:
Bernd Reuther
2020-10-22 16:52:29 +02:00
parent 11cd200260
commit f21ecac9f0
2 changed files with 13 additions and 21 deletions
+7 -12
View File
@@ -374,26 +374,21 @@ plugins:
#### Block-Diagramme #### Block-Diagramme
``` ```
pip3 install mkdocs-build-plantuml-plugin pip3 install mkdocs-mermaid2-plugin
``` ```
Änderung in "mkdocs.yml": Änderung in "mkdocs.yml":
``` ```
plugins: plugins:
- build_plantuml: - mermaid2
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
``` ```
Beispiel: Beispiel:
```plantuml ```mermaid
Alice -> Bob graph TD
A[Client] --> B[Load Balancer]
B --> C[Server01]
B --> D[Server02]
``` ```
+6 -9
View File
@@ -21,6 +21,11 @@ markdown_extensions:
- pymdownx.details - pymdownx.details
- pymdownx.highlight - pymdownx.highlight
- pymdownx.superfences - pymdownx.superfences
# make exceptions to highlighting of code:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid
- pymdownx.inlinehilite - pymdownx.inlinehilite
- pymdownx.keys - pymdownx.keys
- pymdownx.tabbed - pymdownx.tabbed
@@ -35,12 +40,4 @@ plugins:
placeholder: z.B. 0.0.0.0 placeholder: z.B. 0.0.0.0
DOMAIN_NAME: DOMAIN_NAME:
placeholder: z.B. fritz.box placeholder: z.B. fritz.box
- build_plantuml: - mermaid2
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