CLI tool to parse markdown files and renders Mermaid snippets as images.
Requires Node 4.0 or greater.
- Create a readme file with mermaid code snippet (for example, see the readme source for this project).
- Run
markmaid [filename] | xargs git add
- Commit and push
- View the rendered result in your Github docs
As flow chart | As sequence diagram |
---|---|
It even works in tables!
Install the markmaid command line tool with npm:
npm install -g markmaid