Blocks

Compatibility: GitHub, GitLab, Obsidian, Notion

A fenced block is three backticks with a name after them. For code that name is the language and the block shows as highlighted text. For a diagram the name is the diagram type, and the block renders as a picture wherever that block type is supported. Mermaid, for example, renders on GitHub, GitLab and Notion. You write the diagram once as text and it travels with your document.

You write
```mermaid
flowchart LR
  Start --> Stop
```
You get
Start Stop

Block types

The name after the opening fence sets the block type. These are the diagram block types, including ones we do not have an editor for yet.

Block Type Editor
Available now
```mermaidMermaid diagramsSee types below
```dotGraphviz graph / networkOpen
```vega-liteVega-Lite data chartOpen
```wavedromWaveDrom waveformOpen
```bpmnBPMN processOpen
```railroadRailroad / syntaxOpen
```smilesChemical structure (SMILES)Open
```abcMusic notation (ABC)Open
```pikchrPikchrOpen
```newickPhylogenetic tree (Newick)Open
```nomnomlNomnoml (UML)Open
```d2D2 diagramsOpen
```markmapMarkmap (mind map from Markdown)Open
```ditaaditaa (ASCII art to diagram)Open
```blockdiagblockdiag block diagramOpen
```seqdiagseqdiag sequence diagramOpen
```actdiagactdiag swimlane activity diagramOpen
```nwdiagnwdiag network diagramOpen
```rackdiagrackdiag server rackOpen
```packetdiagpacketdiag packet layoutOpen
```tikzTikZ / PGF drawingOpen
```plantumlPlantUML (UML, C4 and more)Open
```svgbobSvgbob (ASCII to SVG)Open
```mathMaths (LaTeX)Open
```freeformFreeform shapesOpen
```floorplanFloor planOpen
```circuitCircuitOpen
```vennVenn diagramOpen
```chessChessboard (FEN)Open
```asciiASCII paintOpen
```qrQR codeOpen
```barcodeBarcodeOpen
No editor here yet
```vegaVega (full spec)—

Mermaid diagram types

Mermaid packs many diagrams into the one ```mermaid block. You choose which by the first line inside the block. These are the first lines.

First line Diagram Editor
Available now
flowchart TDFlowchartOpen
sequenceDiagramSequence diagramOpen
classDiagramClass (UML) diagramOpen
stateDiagram-v2State diagramOpen
erDiagramER / database diagramOpen
ganttGantt chartOpen
timelineTimelineOpen
mindmapMind mapOpen
journeyUser journeyOpen
gitGraphGit graphOpen
requirementDiagramRequirement diagramOpen
kanbanKanban boardOpen
architecture-betaArchitecture diagramOpen
piePie chartOpen
quadrantChartQuadrant chartOpen
sankey-betaSankey diagramOpen
xychart-betaXY / bar / line chartOpen
block-betaBlock diagramOpen
packet-betaPacket diagramOpen
radar-betaRadar chartOpen
treemap-betaTreemapOpen
C4ContextC4 modelOpen
zenumlZenUML sequenceOpen

Spotted a mistake? Let us know.