markdown-mermaid

name

markdown-mermaid

description

Craft Mermaid diagrams within Markdown for flowcharts, ERDs, sequence diagrams, state machines, Gantt charts, and mindmaps. Includes validated syntax templates, layout optimization, and cross-platform rendering for GitHub, GitLab, VS Code, and Obsidian. Use when: creating diagrams in markdown files, debugging "diagram not rendering" errors, selecting diagram types for docs, visualizing database schemas or API flows, or fixing Mermaid syntax issues.

Mermaid in Markdown

Create diagrams using fenced code blocks:

```mermaid
flowchart TB
    A[Start] --> B[End]
```

Reference Files (Load Only What You Need)

Core Diagrams

Diagram Type	Load this file
Flowchart - processes, workflows	flowchart.md
Sequence - API interactions	sequence.md
Class - OOP structures	class.md
State - lifecycles, FSM	state.md
ERD - database schemas	erd.md
Gantt - project timelines	gantt.md

Charts & Data Visualization

Diagram Type	Load this file
Pie - proportional data