IMermaidPluginOptions

Defined in: index.ts:16

PropertiesCopy Anchor Link

autoFix?Copy Anchor Link

Defined in: index.ts:36

Whether to automatically attempt best-effort repair of common Mermaid syntax errors (e.g. unquoted labels containing special characters like @, :, /, parentheses).

DefaultCopy Anchor Link

true

cache?Copy Anchor Link

Defined in: index.ts:41

In-memory cache object, useful for cache sharing across plugins/tabs.

cacheConfig?Copy Anchor Link

Defined in: index.ts:44

Configure caching

fixMermaid?Copy Anchor Link

Defined in: index.ts:29

Optional fixer function to repair invalid Mermaid code before retrying render.

ParametersCopy Anchor Link

mermaidCodeCopy Anchor Link

string

errorCopy Anchor Link

Error

ReturnsCopy Anchor Link

string

maxAgeMinutes?Copy Anchor Link

Defined in: index.ts:47

Clean up the entries that are not used for following minutes.

DefaultCopy Anchor Link

30 * 24 * 60 -- that is 30 days

mermaidConfig?Copy Anchor Link

Defined in: index.ts:24

Options for configuring Mermaid rendering.

Pass a partial MermaidConfig object to customize behavior. Refer to the Mermaid documentation for full configuration options:

SeeCopy Anchor Link

https://mermaid.js.org/configuration.html