Skip to content
Readsmith

Diagrams

A fenced code block with the mermaid language renders as a diagram instead of highlighted code. It works in plain .md and .mdx alike, and the whole Mermaid grammar is available: flowcharts, sequence diagrams, state machines, ER diagrams, Gantt charts, and the rest.

Write a fence, get a diagram

```mermaid
flowchart LR
  a[Author] --> b[Build] --> c[Site]
```

This is the pipeline that built the page you are reading:

flowchart LR repo[Markdown / MDX repo] --> build[Deterministic build] build --> bundle[(Immutable bundle)] bundle --> site[Docs site] bundle --> agents[llms.txt · MCP · skill.md] site --> readers([Readers]) agents --> llms([Agents])

The rendered diagram is interactive: drag to pan, zoom with the wheel or the controls, open it fullscreen. The reading behavior is documented in the gallery, at Diagrams in the component library.

When a diagram beats an image

A Mermaid diagram is text: it diffs in review, updates without a design tool, and restyles itself when your site's theme changes. Reach for an image in a Frame instead when the visual is not a graph: screenshots, photography, hand-drawn art.

Was this page helpful?