Mermaid logo

Mermaid

Community
WH-2099
mermaid

Generate Mermaid diagrams from user requirements. Supports flowcharts, sequence diagrams, class diagrams, ER diagrams, Gantt charts, and 18 more diagram types.

Overview

PublisherWH-2099
Repositorymermaid-skill
Skill namemermaid
Stars
295
Forks
35
Bundled files
38
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 38 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by WH-2099 on GitHub. Read the source before you install it.

Installation

Install the Mermaid AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/WH-2099/mermaid-skill/tree/main/.claude/skills/mermaid
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/WH-2099/mermaid-skill.git /tmp/mermaid-skill
mkdir -p .claude/skills
cp -r /tmp/mermaid-skill/.claude/skills/mermaid .claude/skills/mermaid
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Mermaid in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Mermaid on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Mermaid is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Mermaid Diagram Generator

Generate high-quality Mermaid diagram code based on user requirements.

Workflow

  1. Understand Requirements: Analyze user description to determine the most suitable diagram type
  2. Read Documentation: Read the corresponding syntax reference for the diagram type
  3. Generate Code: Generate Mermaid code following the specification
  4. Apply Styling: Apply appropriate themes and style configurations

Diagram Type Reference

Select the appropriate diagram type and read the corresponding documentation:

TypeDocumentationUse Cases
Flowchartflowchart.mdProcesses, decisions, steps
Sequence DiagramsequenceDiagram.mdInteractions, messaging, API calls
Class DiagramclassDiagram.mdClass structure, inheritance, associations
State DiagramstateDiagram.mdState machines, state transitions
ER DiagramentityRelationshipDiagram.mdDatabase design, entity relationships
Gantt Chartgantt.mdProject planning, timelines
Pie Chartpie.mdProportions, distributions
Mindmapmindmap.mdHierarchical structures, knowledge graphs
Timelinetimeline.mdHistorical events, milestones
Git Graphgitgraph.mdBranches, merges, versions
Quadrant ChartquadrantChart.mdFour-quadrant analysis
Requirement DiagramrequirementDiagram.mdRequirements traceability
C4 Diagramc4.mdSystem architecture (C4 model)
Sankey Diagramsankey.mdFlow, conversions
XY ChartxyChart.mdLine charts, bar charts
Block Diagramblock.mdSystem components, modules
Packet Diagrampacket.mdNetwork protocols, data structures
Kanbankanban.mdTask management, workflows
Architecture Diagramarchitecture.mdSystem architecture
Radar Chartradar.mdMulti-dimensional comparison
Treemaptreemap.mdHierarchical data visualization
User JourneyuserJourney.mdUser experience flows
ZenUMLzenuml.mdSequence diagrams (code style)

Configuration & Themes

Output Specification

Generated Mermaid code should:

  1. Be wrapped in ```mermaid code blocks
  2. Have correct syntax that renders directly
  3. Have clear structure with proper line breaks and indentation
  4. Use semantic node naming
  5. Include styling when needed to improve visual appearance

Example Output


User requirements: $ARGUMENTS

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Mermaid AI skill do?

Generate Mermaid diagrams from user requirements. Supports flowcharts, sequence diagrams, class diagrams, ER diagrams, Gantt charts, and 18 more diagram types.

Why use Mermaid on TypingMind?

Because you install it once and use it with any model. Mermaid is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Mermaid in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/WH-2099/mermaid-skill/tree/main/.claude/skills/mermaid. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Mermaid?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Mermaid?

As many as you like. As long as a model supports skills, you can use Mermaid with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Mermaid AI skill free?

Yes. It is published on GitHub by WH-2099 under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇