Mermaid

Author Mermaid diagrams that render correctly on GitHub (the strictest common target). GitHub renders Mermaid in a sandboxed, sanitized context — several constructs that work in mermaid.live fail or render as raw text on GitHub. Apply these rules to every mermaid block.

When to Use

• Writing or editing any ```mermaid fenced block in a .md file.
• A flowchart, sequence, class, state, or ER diagram in a README, spec, or doc.
• Auto-invoke before emitting any mermaid block; defer broad markdown formatting (headings, width, link checks) to wk-markdown.

Step 1: Pick a supported diagram type

GitHub supports a subset. Match content to type: