Add Mermaid Diagrams to Markdown
Mermaid is a low-friction way to add diagrams to markdown.
Unlike screenshots, Mermaid diagrams stay editable as text. That makes them useful for architecture notes, workflows, timelines, and sequence diagrams that will change over time.
Prompt examples
Section titled “Prompt examples”Create a Mermaid sequence diagram for the OAuth callback flow.Put it in docs/auth-flow.md and keep the labels short.Read the deployment workflow and add a Mermaid flowchart showing each step,including failure paths.Good uses
Section titled “Good uses”- Request flows.
- Data pipelines.
- Auth handshakes.
- Release processes.
- State machines.
- Dependency diagrams.
After Claude writes the diagram, preview the markdown to catch syntax or layout issues.