mermaid-diagram

Generate and verify Mermaid diagrams from user requirements.

Updated Apr 29, 2026
One-click install
npx skills add https://github.com/jkfee/Auto-Research --skill mermaid-diagram-jkfee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mermaid-diagram
Source: https://github.com/jkfee/Auto-Research/tree/main/skills/mermaid-diagram
Command: npx skills add https://github.com/jkfee/Auto-Research --skill mermaid-diagram-jkfee

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enables you to transform user requirements into Mermaid diagrams, automatically generating code, saving outputs, and validating syntax to prevent broken visuals.

Core Features & Use Cases

  • Determine the diagram type from your input (flowchart, sequence, class, ER, Gantt, mindmap, and more)
  • Generate clean Mermaid code and provide a Markdown preview in tandem
  • Verify syntax with the Mermaid CLI and save both raw .mmd and .md files under figures/ for easy versioning and sharing
  • Render a PNG preview when tooling is available and guide end-to-end diagram creation for documentation or planning

Quick Start

Provide diagram requirements and the tool will generate Mermaid code, save it to figures/, verify syntax, and render a preview.

Frequently Asked Questions about mermaid-diagram

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate architecture diagrams from text requirements?

You can generate architecture diagrams by providing text requirements to a tool that produces Mermaid code, verifies syntax, and saves both .mmd and .md files for immediate use in documentation.

What types of diagrams can I create using Mermaid?

Mermaid supports creating flowcharts, sequence diagrams, class diagrams, ER diagrams, Gantt charts, and mindmaps from text prompts, covering most software engineering visualization needs.

Do I need the Mermaid CLI to validate diagram syntax?

Yes, the Mermaid CLI or compatible tooling is required to validate syntax, enforce the fixed refinement loop, and render a PNG preview if rendering capabilities are available.

How do I save Mermaid diagrams for version control?

Mermaid diagrams are saved as raw .mmd files and Markdown .md previews in the figures/ directory, ensuring generated code and text visualizations are version-controlled and easily shared.

Why does my Mermaid diagram fail to render correctly?

Diagram rendering fails when syntax is invalid; applying a fixed refinement loop verifies Mermaid syntax through the CLI to detect and correct structural errors before saving outputs.

Can I use this for generating ER diagrams and Gantt charts together?

Yes, the diagram generation process determines the diagram type from your input, supporting ER diagrams, Gantt charts, and other formats based on the specific requirements provided.