mermaid-check

Fix Mermaid diagrams that fail to parse on GitHub and Azure DevOps.

Updated Jun 25, 2026
One-click install
npx skills add https://github.com/aniryou/drawing-skills --skill mermaid-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mermaid-check
Source: https://github.com/aniryou/drawing-skills/tree/main/mermaid-check
Command: npx skills add https://github.com/aniryou/drawing-skills --skill mermaid-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Mermaid diagrams often render without errors locally but fail to parse or display with overlapping, unreadable elements on stricter platforms like GitHub, Azure DevOps, and Confluence, requiring time-consuming manual debugging to resolve.

Core Features & Use Cases

  • Render & Visual Inspection: Renders Mermaid diagrams from markdown files or raw snippets using mermaid-cli, then visually checks the output for parse errors, overlapping nodes, and layout issues.
  • Automated Syntax & Layout Fixes: Applies proven authoring and layout rules to resolve common failures like unquoted line breaks in edge labels and poorly structured subgraphs that break on target renderers.
  • Use Case: If you have a flowchart in a project README that renders incorrectly on GitHub with overlapping boxes, this skill will adjust the syntax and layout to make it display properly for all viewers.

Quick Start

Use the mermaid-check skill to render, inspect, and fix the Mermaid diagram in your project's architecture.md file so it displays correctly on GitHub.

Frequently Asked Questions about mermaid-check

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

FAQPage Schema
Why do my Mermaid diagrams render locally but fail on GitHub and Azure DevOps?

Mermaid diagrams fail on strict platforms like GitHub and Azure DevOps due to syntax rules. This skill renders diagrams locally and applies strict authoring rules to fix unquoted line breaks and subgraph overlaps for target renderers.

How do I fix overlapping nodes and layout issues in a Mermaid flowchart?

To fix overlapping nodes in a Mermaid flowchart, you need to adjust subgraph layout and apply proven authoring rules. This skill renders your diagram and automatically adjusts syntax and layout to eliminate overlaps and illegible text.

Can I use mermaid-cli to validate sequence diagrams and ER diagrams embedded in markdown?

Yes, you can use mermaid-cli to validate sequence diagrams, ER diagrams, and Gantt charts embedded in markdown files. This skill renders the raw snippets locally to visually check for parse errors and layout issues across all common Mermaid types.

What is the best way to debug a Mermaid diagram that displays incorrectly in a project README?

The best way to debug an incorrectly displaying Mermaid diagram is to render it locally for visual inspection. This skill uses mermaid-cli to render markdown snippets and automatically applies layout fixes to ensure proper display for all viewers.

Does automated Mermaid syntax fixing support Gantt charts and sequence diagrams?

Yes, automated Mermaid syntax fixing supports Gantt charts and sequence diagrams. It applies proven layout rules to all common Mermaid diagram types to resolve parse errors and poorly structured subgraphs that break on target renderers.