Skip to content

What is Mermaid?

Mermaid is a pseudo-code way of generating diagrams quickly without worrying about pixel-positioning that traditional drag and drop diagram creation requires. It lets you take pseudo code like this:

    Terry -->> Jody : Hello()
    Jody -->> Terry: returns "hello yourself""

And auto-generate a diagram like this:

Mermaid handles a huge number of diagram types:

  • Sequence Diagrams
  • Flowchart Diagrams
  • Class Diagrams
  • State Diagrams
  • … and so much more – check out the Mermaid site for more details.