From 0d23809524cafe74b4f0777378e98b37987b87e6 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Mon, 5 Sep 2022 13:28:00 +0200 Subject: [PATCH] Update README of docs directory --- docs/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 73f97fab..f3e156ef 100644 --- a/docs/README.md +++ b/docs/README.md @@ -17,7 +17,15 @@ To build: $ make {html|epub|latexpdf} ``` -Note: Building diagrams from source requires `mermaid-cli` to be installed. +Note: Diagrams are currently not built from source. +Instead, pre-built image files are used directly, because there are issues with mermaid in CLI systems. + +If you want to build the diagrams from source, you need `mermaid-cli` to be installed on your system. ```shell $ npm install -g @mermaid-js/mermaid-cli ``` + +You can then use `mmdc` to build/update single diagram files like this: +```shell +mmdc --theme default --width 1600 --backgroundColor transparent -i ecosystem_dia.md -o ecosystem_dia.svg +```