Skip to main content

Module config

Module config 

Source
Expand description

Pipeline-level configuration. Compiled unconditionally so callers can describe the pipeline (themes, copy-linked-files paths, gfm switch, …) whether or not the matching feature flags are enabled.

When a config field describes a transformer whose feature is off, Pipeline::with_defaults_for silently skips it – the field is still allowed in the config so user settings round-trip cleanly across builds with different feature sets.

Structs§

CopyLinkedFilesOptions
Paths consumed by the copy-linked-files transformer.
MermaidArchitectureConfig
MermaidBlockConfig
MermaidC4Config
MermaidErConfig
MermaidFlowchartConfig
MermaidGanttConfig
MermaidGitGraphConfig
MermaidJourneyConfig
MermaidMindmapConfig
MermaidNodeRendererConfig
MermaidOptions
Top-level mermaid configuration. Single flat object - every mermaid.initialize() knob (themeVariables, flowchart, sequence, gantt, look, layout, …) lives at the same level as the dmc-side rendering knobs (responsiveSvg, centerLabels, outputDir, …). All fields are typed end-to-end; no serde_json::Value catch-all.
MermaidPieConfig
MermaidRadarConfig
MermaidRequirementConfig
MermaidSankeyConfig
MermaidSequenceConfig
MermaidThemeVariables
MermaidTimelineConfig
MermaidTreemapConfig
MermaidXyChartConfig
PipelineConfig
Top-level config consumed by crate::Pipeline::with_defaults_for. All fields are optional; the empty config (PipelineConfig::default()) reproduces the historical Pipeline::with_defaults() behavior.
PrettyCodeOptions
Top-level pretty-code configuration. Stored on CompileConfig as Option<PrettyCodeOptions>; None means “use built-in defaults”.

Enums§

CssDimension
CSS dimension that mermaid accepts as either a numeric pixel value (e.g. 14) or a string with units (e.g. "14px", "1.2em").
CssFontWeight
CSS font-weight: numeric (400, 700) or named string ("normal", "bold").
MathEngine
Which engine renders $...$ / $$...$$ math.
MermaidAlign
MermaidErLayoutDirection
MermaidFlowchartCurve
MermaidFlowchartRenderer
MermaidGanttDisplayMode
MermaidGanttWeekday
MermaidLayout
MermaidLogLevel
MermaidLook
MermaidSankeyAlignment
MermaidSecurityLevel
MermaidThemeMode
Mermaid theme spec. Either a single theme name (renders once, attaches one chartSvg attr) or a map of mode -> theme name that renders per-mode and attaches one ${mode}Svg attr per entry.
MultiThemeStrategy
How multi-theme pretty-code output is laid out in the DOM.
PrettyCodeTheme
Pretty-code theme spec.