mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 21:54:24 +00:00
37 lines
734 B
Markdown
37 lines
734 B
Markdown
# mermaid-cli
|
|
|
|
CLI for mermaid. Takes a mermaid definition file as input and generates an `svg`, `png` or `pdf` file as output.
|
|
|
|
## Table of contents <!-- omit in toc -->
|
|
|
|
1. [TL;DR](#tldr)
|
|
1. [Further readings](#further-readings)
|
|
1. [Sources](#sources)
|
|
|
|
## TL;DR
|
|
|
|
```sh
|
|
# Installation.
|
|
npm install -g '@mermaid-js/mermaid-cli'
|
|
|
|
# Convert mermaid files to SVG.
|
|
mmdc -i 'input.mmd' -o 'output.svg'
|
|
```
|
|
|
|
## Further readings
|
|
|
|
- [mermaid.js]
|
|
|
|
## Sources
|
|
|
|
All the references in the [further readings] section, plus the following:
|
|
|
|
<!-- project's references -->
|
|
[github]: https://github.com/mermaid-js/mermaid-cli
|
|
|
|
<!-- internal references -->
|
|
[further readings]: #further-readings
|
|
[mermaid.js]: mermaid.js.md
|
|
|
|
<!-- external references -->
|