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.