Skip to content

Diagrams (Mermaid)

Use Mermaid in fenced code blocks for diagrams that render in the editor.

Supported types (examples)

Flow (graph / flowchart), sequence, Gantt, class, state, pie, Git graph—per current Mermaid support in the product.

Example — flowchart

markdown
```mermaid
graph TD
  A[Start] --> B{Condition?}
  B -->|Yes| C[Path 1]
  B -->|No| D[Path 2]
  C --> E[End]
  D --> E
```
mermaid
graph TD
  A[Start] --> B{Condition?}
  B -->|Yes| C[Path 1]
  B -->|No| D[Path 2]
  C --> E[End]
  D --> E

Tips

  • Prefer short labels for readability.
  • Match direction (TD, LR, etc.) to your slide or doc layout.
  • For very large diagrams, split into multiple figures.

See also