Skip to content

MermaidConfig

Unofficial

Configuration options for Mermaid diagram rendering.

Import:

import type { MermaidConfig } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface MermaidConfig

Properties

Property Type Description
architecture? Record<string, unknown> Architecture diagram configuration.
arrowMarkerAbsolute? boolean Whether to use absolute arrow markers.
block? Record<string, unknown> Block diagram configuration.
c4? Record<string, unknown> C4 diagram configuration.
class? Record<string, unknown> Class diagram configuration.
deterministicIds? boolean Whether to use deterministic IDs.
deterministicIDSeed? string Seed for deterministic ID generation.
er? Record<string, unknown> Entity relationship diagram configuration.
flowchart? Record<string, unknown> Flowchart diagram configuration.
fontFamily? string Font family for the diagrams.
fontSize? number Font size for the diagrams.
gantt? Record<string, unknown> Gantt chart configuration.
gitGraph? Record<string, unknown> Git graph configuration.
journey? Record<string, unknown> Journey diagram configuration.
kanban? Record<string, unknown> Kanban board configuration.
logLevel? number | string Log level for Mermaid.
maxEdges? number Maximum number of edges allowed.
maxTextSize? number Maximum text size allowed.
mindmap? Record<string, unknown> Mindmap diagram configuration.
packet? Record<string, unknown> Packet diagram configuration.
pie? Record<string, unknown> Pie chart configuration.
quadrantChart? Record<string, unknown> Quadrant chart configuration.
requirement? Record<string, unknown> Requirement diagram configuration.
sankey? Record<string, unknown> Sankey diagram configuration.
secure? string[] List of secure keys.
securityLevel? 'antiscript' | 'loose' | 'sandbox' | 'strict' Security level for rendering.
sequence? Record<string, unknown> Sequence diagram configuration.
startOnLoad? boolean Whether to start rendering on page load.
state? Record<string, unknown> State diagram configuration.
suppressErrorRendering? boolean Whether to suppress error rendering.
theme? string Custom theme name.
themeCSS? string Custom theme CSS.
themeVariables? Record<string, string> Custom theme variables.
timeline? Record<string, unknown> Timeline diagram configuration.
wrap? boolean Whether to enable text wrapping.
xy? Record<string, unknown> XY chart configuration.