
Mermaid | Diagramming and charting tool
The Mermaid ecosystem — including the open-source diagramming library and our commercial platform for teams — now lives at mermaid.ai. This legacy site will remain available.
The Official Guide to Mermaid.js
Next, the book introduces Mermaid and establishes how to use it to create effective documentation. By using different tools, editors, or a custom documentation platform, you’ll also learn how to use …
Flowcharts Syntax | Mermaid
Mermaid introduces 30 new shapes to enhance the flexibility and precision of flowchart creation. These new shapes provide more options to represent processes, decisions, events, data storage visually, …
Interface: LayoutData | Mermaid
Properties config config: MermaidConfig Defined in: packages/mermaid/src/rendering-util/types.ts:171
Interface: Mermaid | Mermaid
This is provided for environments where the mermaid object can't directly have a new member added to it (eg. dart interop wrapper). (Initially there is no parseError member of mermaid).
Type Alias: ParseErrorFunction () | Mermaid
ParseErrorFunction: (err, hash?) => void Defined in: packages/mermaid/src/Diagram.ts:10
Tidy-tree Layout | Mermaid
The tidy-tree layout arranges nodes in a hierarchical, tree-like structure. It is especially useful for diagrams where parent-child relationships are important, such as mindmaps.
Function: getUserDefinedConfig () | Mermaid
Create diagrams and visualizations using text and code.
Type Alias: SVG | Mermaid
SVG = d3.Selection < SVGSVGElement, unknown, Element | null, unknown > Defined in: packages/mermaid/src/diagram-api/types.ts:128 Edit this page on GitHub
Interface: ExternalDiagramDefinition | Mermaid
Properties detector detector: DiagramDetector Defined in: packages/mermaid/src/diagram-api/types.ts:96