markmaid

CLI tool to parse markdown files and renders Mermaid snippets as images.

Requires Node 4.0 or greater.

How it works

1. Create a readme file with mermaid code snippet (for example, see the readme source for this project).
2. Run markmaid [filename] | xargs git add
3. Commit and push
4. View the rendered result in your Github docs

As flow chart | As sequence diagram --- | --- |

It even works in tables!

Installation

Install the markmaid command line tool with npm:

npm install -g markmaid