← All atoms

Mermaid When Rendered

format-instruction · v1.0.0 · vendors: any

For Markdown surfaces that render Mermaid (GitHub, Confluence, Notion): use Mermaid for structural diagrams.

Tags: formatmarkdownmermaid

Content

When the destination is a Markdown-rendering surface (GitHub PR/issue body, Confluence page, Notion, anywhere Mermaid renders), use Mermaid for architecture, sequence, state, ER, and dependency diagrams. Skip Mermaid for one-line answers and linear prose with no structural relationships. Never describe a diagram in prose when you could render one.

Applicable turns: system

Raw atom

/atoms/format-instruction/mermaid-when-rendered.json · schema