AI/ML

mermaid

markdown-viewer/skills · updated Apr 8, 2026

$npx skills add https://github.com/markdown-viewer/skills --skill mermaid
summary

Quick Start: Identify diagram type (flowchart/sequence/state/class/ER/gantt/mindmap) → Define nodes with shapes → Connect with arrows → Wrap in ```mermaid fence. Default: top-to-bottom (TD), use flowchart over graph, Unicode supported.

skill.md

Mermaid Diagram Visualizer

Quick Start: Identify diagram type (flowchart/sequence/state/class/ER/gantt/mindmap) → Define nodes with shapes → Connect with arrows → Wrap in ```mermaid fence. Default: top-to-bottom (TD), use flowchart over graph, Unicode supported.


Critical Syntax Rules

Rule 1: List Syntax Conflicts

❌ [1. Item]     → "Unsupported markdown: list"
✅ [1.Item]      → Remove space after period
✅ [① Item]      → Use circled numbers ①②③④⑤⑥⑦⑧⑨⑩
✅ [(1) Item]    → Use parentheses

Rule 2: Subgraph Naming

❌ subgraph AI Agent Core    → Space without quotes
✅ subgraph agent["AI Agent Core"]  → ID with display name
✅ subgraph agent            → Simple ID only

Rule 3: Node References in Subgraphs

❌ Title --> AI Agent Core   → Reference display name
✅ Title --> agent           → Reference subgraph ID

Rule 4: Special Characters in Node Text

✅ ["Text with spaces"]       → Quotes for spaces
✅ Use 『』 instead of ""     → Avoid quotation marks
✅ Use 「」 instead of ()     → Avoid parentheses

Rule 5: Use flowchart over graph

❌ graph TD      → Outdated
✅ flowchart TD  → Supports subgraph directions, more features

Common Pitfalls

Issue Solution
Diagram won't render Check unmatched brackets, quotes
List syntax error [1.Item] not [1. Item]
Subgraph reference fails Use ID not display name
Too crowded Split into multiple diagrams
Crossing connections Use different layout direction or invisible edges ~~~

Output Format

```mermaid
[diagram code]
```

Related Files

For diagram-specific syntax and advanced features, refer to references below:

  • syntax.md — Detailed syntax for all 14+ diagram types: flowchart shapes, sequence actors, class relationships, state transitions, ER cardinality, Gantt tasks, and more
general reviews

Ratings

4.510 reviews
  • Shikha Mishra· Oct 10, 2024

    mermaid is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.

  • Piyush G· Sep 9, 2024

    Keeps context tight: mermaid is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • Chaitanya Patil· Aug 8, 2024

    Registry listing for mermaid matched our evaluation — installs cleanly and behaves as described in the markdown.

  • Sakshi Patil· Jul 7, 2024

    mermaid reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Ganesh Mohane· Jun 6, 2024

    I recommend mermaid for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • Oshnikdeep· May 5, 2024

    Useful defaults in mermaid — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • Dhruvi Jain· Apr 4, 2024

    mermaid has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Rahul Santra· Mar 3, 2024

    Solid pick for teams standardizing on skills: mermaid is focused, and the summary matches what you get after install.

  • Pratham Ware· Feb 2, 2024

    We added mermaid from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

  • Yash Thakker· Jan 1, 2024

    mermaid fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.