Skip to content

tlemaire/mermaid-skill

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Mermaid Skill for Claude Code

A Claude Code skill for generating Mermaid diagrams. Supports 23 diagram types including flowcharts, sequence diagrams, class diagrams, ER diagrams, Gantt charts, and more.

Installation

Copy the skill folder to your project:

git clone https://github.com/WH-2099/mermaid-skill.git
cp -r mermaid-skill/.claude/skills/mermaid /path/to/your/project/.claude/skills/

Or add as a git submodule:

git submodule add https://github.com/WH-2099/mermaid-skill.git .claude/skills/mermaid-skill
ln -s mermaid-skill/.claude/skills/mermaid .claude/skills/mermaid

Usage

In Claude Code, use the /mermaid command:

/mermaid create a flowchart for user login process
/mermaid draw a sequence diagram for API authentication
/mermaid ER diagram for an e-commerce database

Supported Diagrams

Category Diagram Types
Flow & Process Flowchart, State Diagram, User Journey
Structural Class Diagram, ER Diagram, C4 Diagram, Architecture Diagram
Temporal Sequence Diagram, Gantt Chart, Timeline, Git Graph
Data Visualization Pie Chart, XY Chart, Sankey Diagram, Quadrant Chart, Radar Chart, Treemap
Organization Mindmap, Kanban, Block Diagram, Requirement Diagram
Technical Packet Diagram, ZenUML

Project Structure

.claude/skills/mermaid/
├── SKILL.md           # Skill definition and instructions
└── references/        # Mermaid syntax documentation
    ├── flowchart.md
    ├── sequenceDiagram.md
    ├── classDiagram.md
    └── ...

Documentation Sync

This skill includes a GitHub Action that automatically syncs documentation from the official mermaid-js/mermaid repository weekly.

License

MIT

About

A Claude Code skill for generating Mermaid diagrams with all diagram types supported.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors