references/diagram-mermaid.md

GitHub
namemermaid
descriptionCreate diagrams from text descriptions

Mermaid Diagrams

Create diagrams from text descriptions.

Basic Usage

```mermaid
sequenceDiagram
  Alice->John: Hello John, how are you?
  Note over Alice,John: A typical interaction
```

With Options

```mermaid {theme: 'neutral', scale: 0.8}
graph TD
B[Text] --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
```

Diagram Types

  • graph / flowchart - Flow diagrams
  • sequenceDiagram - Sequence diagrams
  • classDiagram - Class diagrams
  • stateDiagram - State diagrams
  • erDiagram - Entity relationship
  • gantt - Gantt charts
  • pie - Pie charts

Resources