Visual explanations
Use diagrams, math, and images when the shape of an idea carries meaning that prose alone would hide.
Flow and sequence
These diagrams describe a documentation review and the exchange between an author and a build service.
flowchart LR
Draft --> Review
Review -->|Approved| Publish
Review -->|Changes requested| Draft
sequenceDiagram
participant Author
participant Build
Author->>Build: Submit documentation
Build-->>Author: Report results
Show Markdown source
Models and state
State, class, and entity relationships expose different aspects of the same workflow.
stateDiagram-v2
[*] --> Draft
Draft --> Review
Review --> Published
Review --> Draft
classDiagram
class Document {
+title
+status
}
class Reviewer {
+name
}
Reviewer --> Document : reviews
erDiagram
AUTHOR ||--o{ DOCUMENT : writes
DOCUMENT ||--o{ REVIEW : receives
Show Markdown source
```mermaid
stateDiagram-v2
[*] --> Draft
Draft --> Review
Review --> Published
Review --> Draft
```
```mermaid
classDiagram
class Document {
+title
+status
}
class Reviewer {
+name
}
Reviewer --> Document : reviews
```
```mermaid
erDiagram
AUTHOR ||--o{ DOCUMENT : writes
DOCUMENT ||--o{ REVIEW : receives
```
Mathematics
Inline notation keeps a variable in context; display notation gives a derivation room to breathe.
A sample mean is written as \(\bar{x}\), where \(n\) is the number of observations.
\[
\bar{x} = \frac{1}{n} \sum_{i=1}^{n} x_i
\]
For a right triangle, \(a^2 + b^2 = c^2\).
Show Markdown source
Images and captions
This local SVG provides an accessible, self-contained illustration.
Show Markdown source
Icons and emoji
Icons can signal intent; adjacent text carries the meaning.
Ready โ the example has been reviewed.
Hover for a short explanation.
The release is ready to launch.