okforest/mermaid-syntax

errorOKForest conventions

mermaid code blocks are valid Mermaid (diagrams as code).

Mermaid is a language for writing diagrams as text. The check parses each ```mermaid block with Mermaid’s own parser and reports the first syntax error with its line. The syntax reference covers every diagram type.

Some Mermaid diagram types (pie, gitGraph, and others) need a browser to parse, so they are reported as okforest/diagram-unchecked instead. The CLI checks Mermaid only when mermaid is installed alongside it (see diagram checks); the GitHub Action always checks it.