mermaid-diagrams
Master Mermaid's text-based diagramming to visualize software architecture, data flows, and system design. This skill covers class diagrams for domain modeling, sequence diagrams for API interactions, flowcharts for processes, entity relationship diagrams for databases, and C4 architecture diagrams for system structure. Learn syntax fundamentals, diagram selection, best practices, and export options for GitHub, VS Code, and other platforms.
Mermaid Diagrams helps you create professional software visualizations from text-based syntax for architecture, flows, and schemas.
AI-generated summary based on this skill's SKILL.md
Install
softaworks/agent-toolkit/mermaid-diagrams · repository language: Python
git clone https://github.com/softaworks/agent-toolkit
cp -r agent-toolkit/skills/mermaid-diagrams ~/.claude/skills/mermaid-diagramsFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How to create mermaid diagrams for software documentation?
mermaid-diagrams enables you to build software visualizations using simple text syntax. Write diagram code directly in markdown files, VS Code, or the Mermaid live editor, then render it as SVG or PNG. mermaid-diagrams supports flowcharts, sequence diagrams, class diagrams, entity relationship diagrams, C4 architecture models, state machines, Gantt charts, and git graphs—all without leaving your text editor. Export to GitHub, documentation sites, or image files for sharing.
What mermaid syntax should I use for flowcharts?
mermaid-diagrams flowchart syntax uses simple node and arrow declarations. Start with `flowchart TD` (top-down) or `LR` (left-right), then define nodes with labels and connect them using arrows. For example: `A[Start] --> B{Decision} --> C[Process] --> D[End]`. mermaid-diagrams handles styling, alignment, and rendering automatically. Refer to the diagram types reference to choose between flowchart, graph, or state machine syntax based on your process modeling needs.
How do I make a sequence diagram with mermaid?
mermaid-diagrams sequence diagrams model interactions between actors and systems. Use `sequenceDiagram` syntax to declare participants, then define message flows with `->` or `-->` arrows. Example: `Alice->>Bob: Hello` shows a message from Alice to Bob. mermaid-diagrams automatically handles lifelines and timing. This is ideal for documenting API interactions, microservice communication, and request-response flows in your system architecture.
Can mermaid-diagrams create entity relationship diagrams?
Yes, mermaid-diagrams includes ERD (entity relationship diagram) support for database schema visualization. Use `erDiagram` syntax to define entities and their relationships with cardinality notation. mermaid-diagrams renders tables, columns, and relationship lines automatically. This is perfect for documenting database design, domain modeling, and data structure before implementation. Export the diagram for architecture documentation or GitHub wikis.
What are mermaid C4 architecture diagrams used for?
mermaid-diagrams C4 diagrams visualize system architecture at multiple levels: context (system boundary), containers (applications/services), components (internal building blocks), and code (classes/functions). Use C4 syntax to show how systems interact, dependencies, and technology choices. mermaid-diagrams renders these hierarchically, making them ideal for communicating architecture to stakeholders, documenting microservices, and planning system design before development.
How do I export mermaid diagrams for GitHub and documentation?
mermaid-diagrams renders natively in GitHub markdown files—paste your diagram code in a markdown code block with the `mermaid` language tag and GitHub displays it automatically. For VS Code, use Mermaid extensions to preview and export as PNG or SVG. The Mermaid live editor also supports direct export. mermaid-diagrams diagrams work in any platform supporting SVG or markdown rendering, making them ideal for documentation sites, wikis, and version control.
SKILL.md
rendered from the published skill — quoted content, verbatim
Mermaid Diagramming
Create professional software diagrams using Mermaid's text-based syntax. Mermaid renders diagrams from simple text definitions, making diagrams version-controllable, easy to update, and maintainable alongside code.
Core Syntax Structure
All Mermaid diagrams follow this pattern:
diagramType
definition content
Key principles: - First line declares diagram type (e.g.,
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 9 files
skills/mermaid-diagrams/README.md
skills/mermaid-diagrams/SKILL.md
skills/mermaid-diagrams/references/advanced-features.md
skills/mermaid-diagrams/references/architecture-diagrams.md
skills/mermaid-diagrams/references/c4-diagrams.md
skills/mermaid-diagrams/references/class-diagrams.md
skills/mermaid-diagrams/references/erd-diagrams.md
skills/mermaid-diagrams/references/flowcharts.md
skills/mermaid-diagrams/references/sequence-diagrams.md