mermaid.md

Mermaid support

Mermaid is a DSL for different types of diagrams.

Notably, its rendering engine is based in JavaScript and is supported in GitHub's UI.

Supported diagram types

• ✅ Flowchart
  • ✅ Diagram direction
  • ✅ Node shapes
  • ✅ Links between nodes
    • ✅ Multi-source links
    • ✅ Chained links
    • ✅ Arrow styling
  • ✅ Subgraphs
  • ✅ Link styling
  • ✅ Node styling by ID
  • ✅ Node classes

Viewing Mermaid

With GitHub

Since 2022, GitHub can automatically render Mermaid code blocks.

  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;

Loading

With IntelliJ

Install the plugin Mermaid

Installing this plugin will enable:

• The rendering of *.mmd and *.mermaid files
• The rendering of Mermaid diagrams in Markdown documents (with the Markdown plug-in)