| 1 | --- |
| 2 | name: mermaid |
| 3 | description: Create diagrams from text descriptions |
| 4 | --- |
| 5 | |
| 6 | # Mermaid Diagrams |
| 7 | |
| 8 | Create diagrams from text descriptions. |
| 9 | |
| 10 | ## Basic Usage |
| 11 | |
| 12 | ````md |
| 13 | ```mermaid |
| 14 | sequenceDiagram |
| 15 | Alice->John: Hello John, how are you? |
| 16 | Note over Alice,John: A typical interaction |
| 17 | ``` |
| 18 | ```` |
| 19 | |
| 20 | ## With Options |
| 21 | |
| 22 | ````md |
| 23 | ```mermaid {theme: 'neutral', scale: 0.8} |
| 24 | graph TD |
| 25 | B[Text] --> C{Decision} |
| 26 | C -->|One| D[Result 1] |
| 27 | C -->|Two| E[Result 2] |
| 28 | ``` |
| 29 | ```` |
| 30 | |
| 31 | ## Diagram Types |
| 32 | |
| 33 | - `graph` / `flowchart` - Flow diagrams |
| 34 | - `sequenceDiagram` - Sequence diagrams |
| 35 | - `classDiagram` - Class diagrams |
| 36 | - `stateDiagram` - State diagrams |
| 37 | - `erDiagram` - Entity relationship |
| 38 | - `gantt` - Gantt charts |
| 39 | - `pie` - Pie charts |
| 40 | |
| 41 | ## Resources |
| 42 | |
| 43 | - Mermaid docs: https://mermaid.js.org/ |
| 44 | - Live editor: https://mermaid.live/ |
| 45 |