@defaude/ningyo
v1.2.0
Published
Generates SVGs from Mermaid diagrams.
Downloads
3
Readme
Ningyo
🧜♀️ Because we like Mermaids - but Bitbucket and Confluence don't... 🙄
Turns this
```mermaid
pie title NETFLIX
"Time spent searching" : 95
"Time spent watching" : 5
```
into this
OR
this
stateDiagram-v2
[*] --> eat
eat --> sleep
sleep --> code
code --> eat
into this
Usage
Put your diagram(s) in .mmd
or Markdown files and pass their filenames as parameters to ningyo:
npx @defaude/ningyo foo.mmd bar.md baz.md
By default, the created SVG files will be optimized with svgo. Some diagram styles might
be broken by this, however. You can skip svgo by adding the --no-optimize
flag:
npx @defaude/ningyo foo.md bar.md baz.md --no-optimize
Further reading
Look at the reference to see what you can do with Mermaid.
Sadly, there are no network / cloud diagrams available at the moment, but with a little effort, it might become reality some time in the future.