mermaid

name	mermaid
description	|- Use when this capability is needed.

Mermaid Diagrams for Chatbots

Use this skill to create Mermaid diagrams that render well in Markdown chat interfaces, validate their syntax locally, and render images without calling a web service.

Workflow

1. Identify the diagram type (flowchart, sequenceDiagram, stateDiagram-v2) based on the request.
2. Draft Mermaid code in a fenced Markdown block using mermaid.
3. Follow formatting conventions in references/chatbot-mermaid-guidelines.md.
4. Validate the diagram using scripts/validate_mermaid.py.
5. If the user wants an image file, render with scripts/render_mermaid.py.

Scripts

• scripts/validate_mermaid.py
  • Validate Mermaid code by invoking the local Mermaid CLI (mmdc).
  • Use when you need to check whether Mermaid parses without errors.
• scripts/render_mermaid.py
  • Render Mermaid to SVG/PNG/PDF using the local Mermaid CLI (mmdc).
  • Prefer SVG for Markdown renderers when image embedding is required.

Notes

• These scripts expect mmdc to be available on PATH (Mermaid CLI). If missing, instruct the user to install it locally; do not use the Mermaid web service.
• Dependencies are managed via inline uv script metadata in each Python script. Use --install-chromium to bootstrap the Chromium binary via pyppeteer when needed.
• Keep diagrams compact and readable in chat: avoid overly wide graphs, use short labels, and group related states.
• If the user asks for raw Markdown, return only the fenced mermaid block unless they ask for extra explanation.

---

Converted and distributed by TomeVault — claim your Tome and manage your conversions.