Jerod Santo changelog.com/posts

This mermaid generates diagrams and flowcharts from plain text

Mermaid's author, Knut Sveidqvist, asks:

Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code?

Answer "yes"? He goes on:

This is why mermaid was born, a simple markdown-like script language for generating charts from text via javascript.

A graph example:

graph LR;
    A[Hard edge]-->|Link text|B(Round edge);
    B-->C{Decision};
    C-->|One|D[Result one];
    C-->|Two|E[Result two];

mermaid-example

Markdown's primary purpose is to look great as plain text and be transformable in to HTML. In that way, I think mermaid slightly misses the mark. But it succeeds at making diagram/flowchart generation easy!


Discussion

Sign in or Join to comment or subscribe

Player art
  0:00 / 0:00