diagram
A diagram block embeds structured visual syntax (for example Mermaid) that is rendered into a figure.
Diagrams are useful for architecture overviews, data-flow maps, and state transitions.
Mermaid example
graph TD
A[Input] --> B[Transform]
B --> C[Output]
Usage notes
Keep labels short so rendered nodes remain legible.
Prefer top-down (
TD) or left-right (LR) layouts for readability.Pair diagrams with a short explanatory paragraph.
Diagram support depends on the renderer configuration. If raw diagram text appears, enable diagram rendering in your documentation pipeline.