Where it sits
| Body | In the body | Inside its texts |
|---|---|---|
| The store’s home | Yes | Yes |
| A custom page | Yes | Yes |
| A product’s page | Yes | Yes |
| An event’s page | Yes | Yes |
| A portfolio’s page | Yes | Yes |
| A lesson | Yes | Yes |
| An article | Yes | Yes |
A text holds it as a <block type="diagram" props="…"></block> element: its props are those below but type, which the element’s own type names.
See Bodies for how a body holds its blocks.
Props
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | The block’s id, unique within its body. |
type |
"diagram" |
Yes | The block’s type. |
source |
string |
No | The diagram in Mermaid syntax: a flowchart (flowchart LR), sequenceDiagram, stateDiagram-v2, classDiagram, erDiagram or an XY chart (xychart-beta), with no styling directives. Defaults to "". |
hidden |
boolean |
No | Whether the block is hidden: it, and every block it holds, doesn’t show. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The block's id, unique within its body."
},
"type": {
"type": "string",
"const": "diagram",
"description": "The block's type."
},
"source": {
"default": "",
"type": "string",
"description": "The diagram in Mermaid syntax: a flowchart (`flowchart LR`), `sequenceDiagram`, `stateDiagram-v2`, `classDiagram`, `erDiagram` or an XY chart (`xychart-beta`), with no styling directives."
},
"hidden": {
"type": "boolean",
"description": "Whether the block is hidden: it, and every block it holds, doesn't show."
}
},
"required": [
"id",
"type"
],
"description": "A diagram drawn from Mermaid source in the store's colors.",
"additionalProperties": false
}