Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 1.76 KB

File metadata and controls

38 lines (30 loc) · 1.76 KB

Use "Mermaid" For Flow Diagrams

Mermaid is a markdown dialetc and a JavaScript library that is just a fantastic toolkit. It supports creating diagrams as code. When you host your markdown on github.com or use Visual Studio Code it renders well using the approach below (and there are an increasing number of integrations with other platforms). It has features to support a range of diagramming types.

Here is a Mermaid block:

code

'''mermaid
graph TD;
  Root-->Node1;
  Node1-->Node3;
  Node1-->Node2;
  Root-->Node2;
  Node2-->Node3;
'''

renders as

graph TD;
  Root-->Node1;
  Node1-->Node3;
  Node1-->Node2;
  Root-->Node2;
  Node2-->Node3;
Loading

There are a broad spectrum of use cases where diagramming with Marmaid is a good fit.

There is also some alternative tooling: