PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-22 12:22:06 +01:00
Code Issues Releases Wiki Activity

Update README of docs directory

Browse source
This commit is contained in:
Paul Schaub 2022-09-05 13:28:00 +02:00
parent 7bff3128cb
commit 0d23809524
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/README.md
View file

@ -17,7 +17,15 @@ To build:
$ make {html|epub|latexpdf} $ 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 ```shell
$ npm install -g @mermaid-js/mermaid-cli $ 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
```