mermaid-knowledge

Generate and validate Mermaid diagrams for knowledge documentation.

Updated Dec 24, 2025

Search Tags:#documentation #knowledge management #mermaid #code generation #validation #diagrams

Ready to run

npx skills add https://github.com/MakotoUwaya/dotfiles --skill mermaid-knowledge

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mermaid-knowledge
Source: https://github.com/MakotoUwaya/dotfiles/tree/main/.config/claude-code/skills/mermaid-knowledge
Command: npx skills add https://github.com/MakotoUwaya/dotfiles --skill mermaid-knowledge

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation and validation of Mermaid diagrams for knowledge documents, ensuring they are correctly formatted and free of parsing errors before insertion.

Core Features & Use Cases

Diagram Generation: Creates various diagram types (flowcharts, sequence diagrams, etc.) based on user requests.
Syntax Validation: Uses Mermaid CLI to verify diagram code, preventing rendering issues.
Error Correction: Identifies and fixes common parsing errors, especially with Japanese text and special characters.
Use Case: When documenting a complex system architecture, use this Skill to generate a clear, validated block diagram that accurately represents the components and their interactions.

Quick Start

Generate a flowchart diagram for the user authentication process.

Frequently Asked Questions about mermaid-knowledge

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

FAQPage Schema

How do I generate Mermaid diagrams for knowledge documentation?▼

Mermaid diagram generation for knowledge documentation works by creating diagram code from your text description. It supports flowcharts, sequence diagrams, and ER diagrams to accurately represent components and interactions.

Why do my Mermaid diagrams fail to render with Japanese text and special characters?▼

Mermaid diagrams often fail to render with Japanese text and special characters due to parsing errors. This tool identifies and fixes these common syntax issues, ensuring correct parsing and insertion into your documents.

Can I validate Mermaid syntax to prevent rendering issues before insertion?▼

Yes, you can validate Mermaid syntax to prevent rendering issues before insertion. The tool uses Mermaid CLI to verify diagram code, checking for correct parsing and formatting errors before finalizing the output.

What is the best way to document system architecture using flowcharts and ER diagrams?▼

The best way to document system architecture using flowcharts and ER diagrams is to generate and validate Mermaid code. This ensures the visual representation is clear, accurately maps component interactions, and is free of parsing errors.

Does Mermaid validation support sequence diagrams and ER diagrams?▼

Yes, Mermaid validation supports sequence diagrams and ER diagrams. The validation process checks various diagram types generated for your knowledge documents to ensure they are correctly formatted and free of parsing errors.