1.2.0 ⢠Published 3 years ago
@defaude/ningyo v1.2.0
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 --> eatinto 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.mdBy 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-optimizeFurther 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.