chore: Update typedoc-plugin-markdown

2025-09-22 08:50:13 +02:00 · 2025-02-21 16:02:03 +05:30
parent 78c1d97f0f
commit 2c22e80dba
57 changed files with 1999 additions and 1939 deletions
--- a/docs/config/setup/mermaid/README.md
+++ b/docs/config/setup/mermaid/README.md
@@ -0,0 +1,40 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/README.md](../../../../packages/mermaid/src/docs/config/setup/mermaid/README.md).
+
+[**mermaid**](../README.md)
+
+---
+
+# mermaid
+
+## Classes
+
+- [UnknownDiagramError](classes/UnknownDiagramError.md)
+
+## Interfaces
+
+- [DetailedError](interfaces/DetailedError.md)
+- [ExternalDiagramDefinition](interfaces/ExternalDiagramDefinition.md)
+- [LayoutData](interfaces/LayoutData.md)
+- [LayoutLoaderDefinition](interfaces/LayoutLoaderDefinition.md)
+- [Mermaid](interfaces/Mermaid.md)
+- [MermaidConfig](interfaces/MermaidConfig.md)
+- [ParseOptions](interfaces/ParseOptions.md)
+- [ParseResult](interfaces/ParseResult.md)
+- [RenderOptions](interfaces/RenderOptions.md)
+- [RenderResult](interfaces/RenderResult.md)
+- [RunOptions](interfaces/RunOptions.md)
+
+## Type Aliases
+
+- [InternalHelpers](type-aliases/InternalHelpers.md)
+- [ParseErrorFunction](type-aliases/ParseErrorFunction.md)
+- [SVG](type-aliases/SVG.md)
+- [SVGGroup](type-aliases/SVGGroup.md)
+
+## Variables
+
+- [default](variables/default.md)
--- a/docs/config/setup/mermaid/classes/UnknownDiagramError.md
+++ b/docs/config/setup/mermaid/classes/UnknownDiagramError.md
@@ -0,0 +1,159 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/classes/UnknownDiagramError.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/classes/UnknownDiagramError.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Class: UnknownDiagramError
+
+Defined in: [packages/mermaid/src/errors.ts:1](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/errors.ts#L1)
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### new UnknownDiagramError()
+
+> **new UnknownDiagramError**(`message`): [`UnknownDiagramError`](UnknownDiagramError.md)
+
+Defined in: [packages/mermaid/src/errors.ts:2](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/errors.ts#L2)
+
+#### Parameters
+
+##### message
+
+`string`
+
+#### Returns
+
+[`UnknownDiagramError`](UnknownDiagramError.md)
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: node_modules/.pnpm/typescript\@5.7.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+#### Inherited from
+
+`Error.cause`
+
+---
+
+### message
+
+> **message**: `string`
+
+Defined in: node_modules/.pnpm/typescript\@5.7.3/node_modules/typescript/lib/lib.es5.d.ts:1077
+
+#### Inherited from
+
+`Error.message`
+
+---
+
+### name
+
+> **name**: `string`
+
+Defined in: node_modules/.pnpm/typescript\@5.7.3/node_modules/typescript/lib/lib.es5.d.ts:1076
+
+#### Inherited from
+
+`Error.name`
+
+---
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: node_modules/.pnpm/typescript\@5.7.3/node_modules/typescript/lib/lib.es5.d.ts:1078
+
+#### Inherited from
+
+`Error.stack`
+
+---
+
+### prepareStackTrace()?
+
+> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
+
+Defined in: node_modules/.pnpm/@types+node\@20.17.19/node_modules/@types/node/globals.d.ts:98
+
+Optional override for formatting stack traces
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`\[]
+
+#### Returns
+
+`any`
+
+#### See
+
+<https://v8.dev/docs/stack-trace-api#customizing-stack-traces>
+
+#### Inherited from
+
+`Error.prepareStackTrace`
+
+---
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: node_modules/.pnpm/@types+node\@20.17.19/node_modules/@types/node/globals.d.ts:100
+
+#### Inherited from
+
+`Error.stackTraceLimit`
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
+
+Defined in: node_modules/.pnpm/@types+node\@20.17.19/node_modules/@types/node/globals.d.ts:91
+
+Create .stack property on a target object
+
+#### Parameters
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Error.captureStackTrace`
--- a/docs/config/setup/mermaid/interfaces/DetailedError.md
+++ b/docs/config/setup/mermaid/interfaces/DetailedError.md
@@ -0,0 +1,45 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/DetailedError.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/DetailedError.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: DetailedError
+
+Defined in: [packages/mermaid/src/utils.ts:780](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L780)
+
+## Properties
+
+### error?
+
+> `optional` **error**: `any`
+
+Defined in: [packages/mermaid/src/utils.ts:785](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L785)
+
+---
+
+### hash
+
+> **hash**: `any`
+
+Defined in: [packages/mermaid/src/utils.ts:783](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L783)
+
+---
+
+### message?
+
+> `optional` **message**: `string`
+
+Defined in: [packages/mermaid/src/utils.ts:786](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L786)
+
+---
+
+### str
+
+> **str**: `string`
+
+Defined in: [packages/mermaid/src/utils.ts:781](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L781)
--- a/docs/config/setup/mermaid/interfaces/ExternalDiagramDefinition.md
+++ b/docs/config/setup/mermaid/interfaces/ExternalDiagramDefinition.md
@@ -0,0 +1,37 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/ExternalDiagramDefinition.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/ExternalDiagramDefinition.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: ExternalDiagramDefinition
+
+Defined in: [packages/mermaid/src/diagram-api/types.ts:99](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L99)
+
+## Properties
+
+### detector
+
+> **detector**: `DiagramDetector`
+
+Defined in: [packages/mermaid/src/diagram-api/types.ts:101](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L101)
+
+---
+
+### id
+
+> **id**: `string`
+
+Defined in: [packages/mermaid/src/diagram-api/types.ts:100](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L100)
+
+---
+
+### loader
+
+> **loader**: `DiagramLoader`
+
+Defined in: [packages/mermaid/src/diagram-api/types.ts:102](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L102)
--- a/docs/config/setup/mermaid/interfaces/LayoutData.md
+++ b/docs/config/setup/mermaid/interfaces/LayoutData.md
@@ -0,0 +1,41 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutData.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutData.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: LayoutData
+
+Defined in: [packages/mermaid/src/rendering-util/types.ts:145](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L145)
+
+## Indexable
+
+\[`key`: `string`]: `any`
+
+## Properties
+
+### config
+
+> **config**: [`MermaidConfig`](MermaidConfig.md)
+
+Defined in: [packages/mermaid/src/rendering-util/types.ts:148](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L148)
+
+---
+
+### edges
+
+> **edges**: `Edge`\[]
+
+Defined in: [packages/mermaid/src/rendering-util/types.ts:147](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L147)
+
+---
+
+### nodes
+
+> **nodes**: `Node`\[]
+
+Defined in: [packages/mermaid/src/rendering-util/types.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L146)
--- a/docs/config/setup/mermaid/interfaces/LayoutLoaderDefinition.md
+++ b/docs/config/setup/mermaid/interfaces/LayoutLoaderDefinition.md
@@ -0,0 +1,37 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutLoaderDefinition.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutLoaderDefinition.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: LayoutLoaderDefinition
+
+Defined in: [packages/mermaid/src/rendering-util/render.ts:21](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L21)
+
+## Properties
+
+### algorithm?
+
+> `optional` **algorithm**: `string`
+
+Defined in: [packages/mermaid/src/rendering-util/render.ts:24](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L24)
+
+---
+
+### loader
+
+> **loader**: `LayoutLoader`
+
+Defined in: [packages/mermaid/src/rendering-util/render.ts:23](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L23)
+
+---
+
+### name
+
+> **name**: `string`
+
+Defined in: [packages/mermaid/src/rendering-util/render.ts:22](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L22)
--- a/docs/config/setup/mermaid/interfaces/Mermaid.md
+++ b/docs/config/setup/mermaid/interfaces/Mermaid.md
@@ -0,0 +1,427 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/Mermaid.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/Mermaid.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: Mermaid
+
+Defined in: [packages/mermaid/src/mermaid.ts:418](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L418)
+
+## Properties
+
+### contentLoaded()
+
+> **contentLoaded**: () => `void`
+
+Defined in: [packages/mermaid/src/mermaid.ts:436](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L436)
+
+\##contentLoaded Callback function that is called when page is loaded. This functions fetches
+configuration for mermaid rendering and calls init for rendering the mermaid diagrams on the
+page.
+
+#### Returns
+
+`void`
+
+---
+
+### detectType()
+
+> **detectType**: (`text`, `config`?) => `string`
+
+Defined in: [packages/mermaid/src/mermaid.ts:438](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L438)
+
+Detects the type of the graph text.
+
+Takes into consideration the possible existence of an `%%init` directive
+
+#### Parameters
+
+##### text
+
+`string`
+
+The text defining the graph. For example:
+
+```mermaid-example
+  %%{initialize: {"startOnLoad": true, logLevel: "fatal" }}%%
+  graph LR
+   a-->b
+   b-->c
+   c-->d
+   d-->e
+   e-->f
+   f-->g
+   g-->h
+```
+
+```mermaid
+  %%{initialize: {"startOnLoad": true, logLevel: "fatal" }}%%
+  graph LR
+   a-->b
+   b-->c
+   c-->d
+   d-->e
+   e-->f
+   f-->g
+   g-->h
+```
+
+##### config?
+
+[`MermaidConfig`](MermaidConfig.md)
+
+The mermaid config.
+
+#### Returns
+
+`string`
+
+A graph definition key
+
+---
+
+### ~~init()~~
+
+> **init**: (`config`?, `nodes`?, `callback`?) => `Promise`<`void`>
+
+Defined in: [packages/mermaid/src/mermaid.ts:431](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L431)
+
+## init
+
+#### Parameters
+
+##### config?
+
+[`MermaidConfig`](MermaidConfig.md)
+
+**Deprecated**, please set configuration in [initialize](Mermaid.md#initialize).
+
+##### nodes?
+
+**Default**: `.mermaid`. One of the following:
+
+- A DOM Node
+- An array of DOM nodes (as would come from a jQuery selector)
+- A W3C selector, a la `.mermaid`
+
+`string` | `HTMLElement` | `NodeListOf`<`HTMLElement`>
+
+##### callback?
+
+(`id`) => `unknown`
+
+Called once for each rendered diagram's id.
+
+#### Returns
+
+`Promise`<`void`>
+
+#### Deprecated
+
+Use [initialize](Mermaid.md#initialize) and [run](Mermaid.md#run) instead.
+
+Renders the mermaid diagrams
+
+#### Deprecated
+
+Use [initialize](Mermaid.md#initialize) and [run](Mermaid.md#run) instead.
+
+---
+
+### initialize()
+
+> **initialize**: (`config`) => `void`
+
+Defined in: [packages/mermaid/src/mermaid.ts:435](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L435)
+
+Used to set configurations for mermaid.
+This function should be called before the run function.
+
+#### Parameters
+
+##### config
+
+[`MermaidConfig`](MermaidConfig.md)
+
+Configuration object for mermaid.
+
+#### Returns
+
+`void`
+
+---
+
+### ~~mermaidAPI~~
+
+> **mermaidAPI**: `Readonly`<{ `defaultConfig`: [`MermaidConfig`](MermaidConfig.md); `getConfig`: () => [`MermaidConfig`](MermaidConfig.md); `getDiagramFromText`: (`text`, `metadata`) => `Promise`<`Diagram`>; `getSiteConfig`: () => [`MermaidConfig`](MermaidConfig.md); `globalReset`: () => `void`; `initialize`: (`userOptions`) => `void`; `parse`: (`text`, `parseOptions`) => `Promise`<`false` | [`ParseResult`](ParseResult.md)>(`text`, `parseOptions`?) => `Promise`<[`ParseResult`](ParseResult.md)>; `render`: (`id`, `text`, `svgContainingElement`?) => `Promise`<[`RenderResult`](RenderResult.md)>; `reset`: () => `void`; `setConfig`: (`conf`) => [`MermaidConfig`](MermaidConfig.md); `updateSiteConfig`: (`conf`) => [`MermaidConfig`](MermaidConfig.md); }>
+
+Defined in: [packages/mermaid/src/mermaid.ts:425](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L425)
+
+**`Internal`**
+
+#### Deprecated
+
+Use [parse](Mermaid.md#parse) and [render](Mermaid.md#render) instead. Please [open a discussion](https://github.com/mermaid-js/mermaid/discussions) if your use case does not fit the new API.
+
+---
+
+### parse()
+
+> **parse**: (`text`, `parseOptions`) => `Promise`<`false` | [`ParseResult`](ParseResult.md)>(`text`, `parseOptions`?) => `Promise`<[`ParseResult`](ParseResult.md)>
+
+Defined in: [packages/mermaid/src/mermaid.ts:426](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L426)
+
+Parse the text and validate the syntax.
+
+#### Parameters
+
+##### text
+
+`string`
+
+The mermaid diagram definition.
+
+##### parseOptions
+
+[`ParseOptions`](ParseOptions.md) & `object`
+
+Options for parsing.
+
+#### Returns
+
+`Promise`<`false` | [`ParseResult`](ParseResult.md)>
+
+An object with the `diagramType` set to type of the diagram if valid. Otherwise `false` if parseOptions.suppressErrors is `true`.
+
+#### See
+
+[ParseOptions](ParseOptions.md)
+
+#### Throws
+
+Error if the diagram is invalid and parseOptions.suppressErrors is false or not set.
+
+Parse the text and validate the syntax.
+
+#### Parameters
+
+##### text
+
+`string`
+
+The mermaid diagram definition.
+
+##### parseOptions?
+
+[`ParseOptions`](ParseOptions.md)
+
+Options for parsing.
+
+#### Returns
+
+`Promise`<[`ParseResult`](ParseResult.md)>
+
+An object with the `diagramType` set to type of the diagram if valid. Otherwise `false` if parseOptions.suppressErrors is `true`.
+
+#### See
+
+[ParseOptions](ParseOptions.md)
+
+#### Throws
+
+Error if the diagram is invalid and parseOptions.suppressErrors is false or not set.
+
+---
+
+### parseError?
+
+> `optional` **parseError**: [`ParseErrorFunction`](../type-aliases/ParseErrorFunction.md)
+
+Defined in: [packages/mermaid/src/mermaid.ts:420](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L420)
+
+---
+
+### registerExternalDiagrams()
+
+> **registerExternalDiagrams**: (`diagrams`, `opts`) => `Promise`<`void`>
+
+Defined in: [packages/mermaid/src/mermaid.ts:434](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L434)
+
+Used to register external diagram types.
+
+#### Parameters
+
+##### diagrams
+
+[`ExternalDiagramDefinition`](ExternalDiagramDefinition.md)\[]
+
+Array of [ExternalDiagramDefinition](ExternalDiagramDefinition.md).
+
+##### opts
+
+If opts.lazyLoad is false, the diagrams will be loaded immediately.
+
+###### lazyLoad?
+
+`boolean` = `true`
+
+#### Returns
+
+`Promise`<`void`>
+
+---
+
+### registerIconPacks()
+
+> **registerIconPacks**: (`iconLoaders`) => `void`
+
+Defined in: [packages/mermaid/src/mermaid.ts:439](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L439)
+
+#### Parameters
+
+##### iconLoaders
+
+`IconLoader`\[]
+
+#### Returns
+
+`void`
+
+---
+
+### registerLayoutLoaders()
+
+> **registerLayoutLoaders**: (`loaders`) => `void`
+
+Defined in: [packages/mermaid/src/mermaid.ts:433](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L433)
+
+#### Parameters
+
+##### loaders
+
+[`LayoutLoaderDefinition`](LayoutLoaderDefinition.md)\[]
+
+#### Returns
+
+`void`
+
+---
+
+### render()
+
+> **render**: (`id`, `text`, `svgContainingElement`?) => `Promise`<[`RenderResult`](RenderResult.md)>
+
+Defined in: [packages/mermaid/src/mermaid.ts:427](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L427)
+
+#### Parameters
+
+##### id
+
+`string`
+
+##### text
+
+`string`
+
+##### svgContainingElement?
+
+`Element`
+
+#### Returns
+
+`Promise`<[`RenderResult`](RenderResult.md)>
+
+#### Deprecated
+
+- use the `mermaid.render` function instead of `mermaid.mermaidAPI.render`
+
+Deprecated for external use.
+
+---
+
+### run()
+
+> **run**: (`options`) => `Promise`<`void`>
+
+Defined in: [packages/mermaid/src/mermaid.ts:432](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L432)
+
+## run
+
+Function that goes through the document to find the chart definitions in there and render them.
+
+The function tags the processed attributes with the attribute data-processed and ignores found
+elements with the attribute already set. This way the init function can be triggered several
+times.
+
+```mermaid-example
+graph LR;
+ a(Find elements)-->b{Processed}
+ b-->|Yes|c(Leave element)
+ b-->|No |d(Transform)
+```
+
+```mermaid
+graph LR;
+ a(Find elements)-->b{Processed}
+ b-->|Yes|c(Leave element)
+ b-->|No |d(Transform)
+```
+
+Renders the mermaid diagrams
+
+#### Parameters
+
+##### options
+
+[`RunOptions`](RunOptions.md) = `...`
+
+Optional runtime configs
+
+#### Returns
+
+`Promise`<`void`>
+
+---
+
+### setParseErrorHandler()
+
+> **setParseErrorHandler**: (`parseErrorHandler`) => `void`
+
+Defined in: [packages/mermaid/src/mermaid.ts:437](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L437)
+
+## setParseErrorHandler Alternative to directly setting parseError using:
+
+```js
+mermaid.parseError = function (err, hash) {
+  forExampleDisplayErrorInGui(err); // do something with the error
+};
+```
+
+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).
+
+#### Parameters
+
+##### parseErrorHandler
+
+(`err`, `hash`) => `void`
+
+New parseError() callback.
+
+#### Returns
+
+`void`
+
+---
+
+### startOnLoad
+
+> **startOnLoad**: `boolean`
+
+Defined in: [packages/mermaid/src/mermaid.ts:419](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L419)
--- a/docs/config/setup/mermaid/interfaces/MermaidConfig.md
+++ b/docs/config/setup/mermaid/interfaces/MermaidConfig.md
@@ -0,0 +1,461 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/MermaidConfig.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/MermaidConfig.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: MermaidConfig
+
+Defined in: [packages/mermaid/src/config.type.ts:58](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L58)
+
+## Properties
+
+### altFontFamily?
+
+> `optional` **altFontFamily**: `string`
+
+Defined in: [packages/mermaid/src/config.type.ts:122](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L122)
+
+---
+
+### architecture?
+
+> `optional` **architecture**: `ArchitectureDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:194](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L194)
+
+---
+
+### arrowMarkerAbsolute?
+
+> `optional` **arrowMarkerAbsolute**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:141](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L141)
+
+Controls whether or arrow markers in html code are absolute paths or anchors.
+This matters if you are using base tag settings.
+
+---
+
+### block?
+
+> `optional` **block**: `BlockDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:201](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L201)
+
+---
+
+### c4?
+
+> `optional` **c4**: `C4DiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:198](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L198)
+
+---
+
+### class?
+
+> `optional` **class**: `ClassDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:187](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L187)
+
+---
+
+### darkMode?
+
+> `optional` **darkMode**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L113)
+
+---
+
+### deterministicIds?
+
+> `optional` **deterministicIds**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:174](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L174)
+
+This option controls if the generated ids of nodes in the SVG are
+generated randomly or based on a seed.
+If set to `false`, the IDs are generated based on the current date and
+thus are not deterministic. This is the default behavior.
+
+This matters if your files are checked into source control e.g. git and
+should not change unless content is changed.
+
+---
+
+### deterministicIDSeed?
+
+> `optional` **deterministicIDSeed**: `string`
+
+Defined in: [packages/mermaid/src/config.type.ts:181](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L181)
+
+This option is the optional seed for deterministic ids.
+If set to `undefined` but deterministicIds is `true`, a simple number iterator is used.
+You can set this attribute to base the seed on a static string.
+
+---
+
+### dompurifyConfig?
+
+> `optional` **dompurifyConfig**: `Config`
+
+Defined in: [packages/mermaid/src/config.type.ts:202](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L202)
+
+---
+
+### elk?
+
+> `optional` **elk**: `object`
+
+Defined in: [packages/mermaid/src/config.type.ts:91](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L91)
+
+#### cycleBreakingStrategy?
+
+> `optional` **cycleBreakingStrategy**: `"GREEDY"` | `"DEPTH_FIRST"` | `"INTERACTIVE"` | `"MODEL_ORDER"` | `"GREEDY_MODEL_ORDER"`
+
+This strategy decides how to find cycles in the graph and deciding which edges need adjustment to break loops.
+
+#### mergeEdges?
+
+> `optional` **mergeEdges**: `boolean`
+
+Elk specific option that allows edges to share path where it convenient. It can make for pretty diagrams but can also make it harder to read the diagram.
+
+#### nodePlacementStrategy?
+
+> `optional` **nodePlacementStrategy**: `"SIMPLE"` | `"NETWORK_SIMPLEX"` | `"LINEAR_SEGMENTS"` | `"BRANDES_KOEPF"`
+
+Elk specific option affecting how nodes are placed.
+
+---
+
+### er?
+
+> `optional` **er**: `ErDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:189](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L189)
+
+---
+
+### flowchart?
+
+> `optional` **flowchart**: `FlowchartDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:182](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L182)
+
+---
+
+### fontFamily?
+
+> `optional` **fontFamily**: `string`
+
+Defined in: [packages/mermaid/src/config.type.ts:121](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L121)
+
+Specifies the font to be used in the rendered diagrams.
+Can be any possible CSS `font-family`.
+See <https://developer.mozilla.org/en-US/docs/Web/CSS/font-family>
+
+---
+
+### fontSize?
+
+> `optional` **fontSize**: `number`
+
+Defined in: [packages/mermaid/src/config.type.ts:204](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L204)
+
+---
+
+### forceLegacyMathML?
+
+> `optional` **forceLegacyMathML**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:163](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L163)
+
+This option forces Mermaid to rely on KaTeX's own stylesheet for rendering MathML. Due to differences between OS
+fonts and browser's MathML implementation, this option is recommended if consistent rendering is important.
+If set to true, ignores legacyMathML.
+
+---
+
+### gantt?
+
+> `optional` **gantt**: `GanttDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:184](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L184)
+
+---
+
+### gitGraph?
+
+> `optional` **gitGraph**: `GitGraphDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:197](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L197)
+
+---
+
+### handDrawnSeed?
+
+> `optional` **handDrawnSeed**: `number`
+
+Defined in: [packages/mermaid/src/config.type.ts:76](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L76)
+
+Defines the seed to be used when using handDrawn look. This is important for the automated tests as they will always find differences without the seed. The default value is 0 which gives a random seed.
+
+---
+
+### htmlLabels?
+
+> `optional` **htmlLabels**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:114](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L114)
+
+---
+
+### journey?
+
+> `optional` **journey**: `JourneyDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:185](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L185)
+
+---
+
+### kanban?
+
+> `optional` **kanban**: `KanbanDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:196](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L196)
+
+---
+
+### layout?
+
+> `optional` **layout**: `string`
+
+Defined in: [packages/mermaid/src/config.type.ts:81](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L81)
+
+Defines which layout algorithm to use for rendering the diagram.
+
+---
+
+### legacyMathML?
+
+> `optional` **legacyMathML**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:156](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L156)
+
+This option specifies if Mermaid can expect the dependent to include KaTeX stylesheets for browsers
+without their own MathML implementation. If this option is disabled and MathML is not supported, the math
+equations are replaced with a warning. If this option is enabled and MathML is not supported, Mermaid will
+fall back to legacy rendering for KaTeX.
+
+---
+
+### logLevel?
+
+> `optional` **logLevel**: `0` | `2` | `1` | `"trace"` | `"debug"` | `"info"` | `"warn"` | `"error"` | `"fatal"` | `3` | `4` | `5`
+
+Defined in: [packages/mermaid/src/config.type.ts:127](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L127)
+
+This option decides the amount of logging to be used by mermaid.
+
+---
+
+### look?
+
+> `optional` **look**: `"classic"` | `"handDrawn"`
+
+Defined in: [packages/mermaid/src/config.type.ts:71](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L71)
+
+Defines which main look to use for the diagram.
+
+---
+
+### markdownAutoWrap?
+
+> `optional` **markdownAutoWrap**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:205](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L205)
+
+---
+
+### maxEdges?
+
+> `optional` **maxEdges**: `number`
+
+Defined in: [packages/mermaid/src/config.type.ts:90](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L90)
+
+Defines the maximum number of edges that can be drawn in a graph.
+
+---
+
+### maxTextSize?
+
+> `optional` **maxTextSize**: `number`
+
+Defined in: [packages/mermaid/src/config.type.ts:85](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L85)
+
+The maximum allowed size of the users text diagram
+
+---
+
+### mindmap?
+
+> `optional` **mindmap**: `MindmapDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:195](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L195)
+
+---
+
+### packet?
+
+> `optional` **packet**: `PacketDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:200](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L200)
+
+---
+
+### pie?
+
+> `optional` **pie**: `PieDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:190](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L190)
+
+---
+
+### quadrantChart?
+
+> `optional` **quadrantChart**: `QuadrantChartConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:191](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L191)
+
+---
+
+### requirement?
+
+> `optional` **requirement**: `RequirementDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:193](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L193)
+
+---
+
+### sankey?
+
+> `optional` **sankey**: `SankeyDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:199](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L199)
+
+---
+
+### secure?
+
+> `optional` **secure**: `string`\[]
+
+Defined in: [packages/mermaid/src/config.type.ts:148](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L148)
+
+This option controls which `currentConfig` keys are considered secure and
+can only be changed via call to `mermaid.initialize`.
+This prevents malicious graph directives from overriding a site's default security.
+
+---
+
+### securityLevel?
+
+> `optional` **securityLevel**: `"strict"` | `"loose"` | `"antiscript"` | `"sandbox"`
+
+Defined in: [packages/mermaid/src/config.type.ts:131](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L131)
+
+Level of trust for parsed diagram
+
+---
+
+### sequence?
+
+> `optional` **sequence**: `SequenceDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:183](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L183)
+
+---
+
+### startOnLoad?
+
+> `optional` **startOnLoad**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:135](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L135)
+
+Dictates whether mermaid starts on Page load
+
+---
+
+### state?
+
+> `optional` **state**: `StateDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:188](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L188)
+
+---
+
+### suppressErrorRendering?
+
+> `optional` **suppressErrorRendering**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:211](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L211)
+
+Suppresses inserting 'Syntax error' diagram in the DOM.
+This is useful when you want to control how to handle syntax errors in your application.
+
+---
+
+### theme?
+
+> `optional` **theme**: `"default"` | `"base"` | `"dark"` | `"forest"` | `"neutral"` | `"null"`
+
+Defined in: [packages/mermaid/src/config.type.ts:64](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L64)
+
+Theme, the CSS style sheet.
+You may also use `themeCSS` to override this value.
+
+---
+
+### themeCSS?
+
+> `optional` **themeCSS**: `string`
+
+Defined in: [packages/mermaid/src/config.type.ts:66](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L66)
+
+---
+
+### themeVariables?
+
+> `optional` **themeVariables**: `any`
+
+Defined in: [packages/mermaid/src/config.type.ts:65](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L65)
+
+---
+
+### timeline?
+
+> `optional` **timeline**: `TimelineDiagramConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:186](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L186)
+
+---
+
+### wrap?
+
+> `optional` **wrap**: `boolean`
+
+Defined in: [packages/mermaid/src/config.type.ts:203](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L203)
+
+---
+
+### xyChart?
+
+> `optional` **xyChart**: `XYChartConfig`
+
+Defined in: [packages/mermaid/src/config.type.ts:192](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L192)
--- a/docs/config/setup/mermaid/interfaces/ParseOptions.md
+++ b/docs/config/setup/mermaid/interfaces/ParseOptions.md
@@ -0,0 +1,24 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/ParseOptions.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/ParseOptions.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: ParseOptions
+
+Defined in: [packages/mermaid/src/types.ts:59](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L59)
+
+## Properties
+
+### suppressErrors?
+
+> `optional` **suppressErrors**: `boolean`
+
+Defined in: [packages/mermaid/src/types.ts:64](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L64)
+
+If `true`, parse will return `false` instead of throwing error when the diagram is invalid.
+The `parseError` function will not be called.
--- a/docs/config/setup/mermaid/interfaces/ParseResult.md
+++ b/docs/config/setup/mermaid/interfaces/ParseResult.md
@@ -0,0 +1,33 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/ParseResult.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/ParseResult.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: ParseResult
+
+Defined in: [packages/mermaid/src/types.ts:67](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L67)
+
+## Properties
+
+### config
+
+> **config**: [`MermaidConfig`](MermaidConfig.md)
+
+Defined in: [packages/mermaid/src/types.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L75)
+
+The config passed as YAML frontmatter or directives
+
+---
+
+### diagramType
+
+> **diagramType**: `string`
+
+Defined in: [packages/mermaid/src/types.ts:71](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L71)
+
+The diagram type, e.g. 'flowchart', 'sequence', etc.
--- a/docs/config/setup/mermaid/interfaces/RenderOptions.md
+++ b/docs/config/setup/mermaid/interfaces/RenderOptions.md
@@ -0,0 +1,21 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/RenderOptions.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/RenderOptions.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: RenderOptions
+
+Defined in: [packages/mermaid/src/rendering-util/render.ts:7](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L7)
+
+## Properties
+
+### algorithm?
+
+> `optional` **algorithm**: `string`
+
+Defined in: [packages/mermaid/src/rendering-util/render.ts:8](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L8)
--- a/docs/config/setup/mermaid/interfaces/RenderResult.md
+++ b/docs/config/setup/mermaid/interfaces/RenderResult.md
@@ -0,0 +1,60 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/RenderResult.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/RenderResult.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: RenderResult
+
+Defined in: [packages/mermaid/src/types.ts:85](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L85)
+
+## Properties
+
+### bindFunctions()?
+
+> `optional` **bindFunctions**: (`element`) => `void`
+
+Defined in: [packages/mermaid/src/types.ts:103](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L103)
+
+Bind function to be called after the svg has been inserted into the DOM.
+This is necessary for adding event listeners to the elements in the svg.
+
+```js
+const { svg, bindFunctions } = await mermaid.render('id1', 'graph TD;A-->B');
+div.innerHTML = svg;
+bindFunctions?.(div); // To call bindFunctions only if it's present.
+```
+
+#### Parameters
+
+##### element
+
+`Element`
+
+#### Returns
+
+`void`
+
+---
+
+### diagramType
+
+> **diagramType**: `string`
+
+Defined in: [packages/mermaid/src/types.ts:93](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L93)
+
+The diagram type, e.g. 'flowchart', 'sequence', etc.
+
+---
+
+### svg
+
+> **svg**: `string`
+
+Defined in: [packages/mermaid/src/types.ts:89](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L89)
+
+The svg code for the rendered graph.
--- a/docs/config/setup/mermaid/interfaces/RunOptions.md
+++ b/docs/config/setup/mermaid/interfaces/RunOptions.md
@@ -0,0 +1,63 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/RunOptions.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/RunOptions.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Interface: RunOptions
+
+Defined in: [packages/mermaid/src/mermaid.ts:41](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L41)
+
+## Properties
+
+### nodes?
+
+> `optional` **nodes**: `ArrayLike`<`HTMLElement`>
+
+Defined in: [packages/mermaid/src/mermaid.ts:49](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L49)
+
+The nodes to render. If this is set, `querySelector` will be ignored.
+
+---
+
+### postRenderCallback()?
+
+> `optional` **postRenderCallback**: (`id`) => `unknown`
+
+Defined in: [packages/mermaid/src/mermaid.ts:53](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L53)
+
+A callback to call after each diagram is rendered.
+
+#### Parameters
+
+##### id
+
+`string`
+
+#### Returns
+
+`unknown`
+
+---
+
+### querySelector?
+
+> `optional` **querySelector**: `string`
+
+Defined in: [packages/mermaid/src/mermaid.ts:45](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L45)
+
+The query selector to use when finding elements to render. Default: `".mermaid"`.
+
+---
+
+### suppressErrors?
+
+> `optional` **suppressErrors**: `boolean`
+
+Defined in: [packages/mermaid/src/mermaid.ts:57](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L57)
+
+If `true`, errors will be logged to the console, but not thrown. Default: `false`
--- a/docs/config/setup/mermaid/type-aliases/InternalHelpers.md
+++ b/docs/config/setup/mermaid/type-aliases/InternalHelpers.md
@@ -0,0 +1,15 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/type-aliases/InternalHelpers.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/type-aliases/InternalHelpers.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Type Alias: InternalHelpers
+
+> **InternalHelpers**: _typeof_ `internalHelpers`
+
+Defined in: [packages/mermaid/src/internals.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/internals.ts#L33)
--- a/docs/config/setup/mermaid/type-aliases/ParseErrorFunction.md
+++ b/docs/config/setup/mermaid/type-aliases/ParseErrorFunction.md
@@ -0,0 +1,29 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/type-aliases/ParseErrorFunction.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/type-aliases/ParseErrorFunction.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Type Alias: ParseErrorFunction()
+
+> **ParseErrorFunction**: (`err`, `hash`?) => `void`
+
+Defined in: [packages/mermaid/src/Diagram.ts:10](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/Diagram.ts#L10)
+
+## Parameters
+
+### err
+
+`string` | [`DetailedError`](../interfaces/DetailedError.md) | `unknown`
+
+### hash?
+
+`any`
+
+## Returns
+
+`void`
--- a/docs/config/setup/mermaid/type-aliases/SVG.md
+++ b/docs/config/setup/mermaid/type-aliases/SVG.md
@@ -0,0 +1,15 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/type-aliases/SVG.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/type-aliases/SVG.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Type Alias: SVG
+
+> **SVG**: `d3.Selection`<`SVGSVGElement`, `unknown`, `Element` | `null`, `unknown`>
+
+Defined in: [packages/mermaid/src/diagram-api/types.ts:130](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L130)
--- a/docs/config/setup/mermaid/type-aliases/SVGGroup.md
+++ b/docs/config/setup/mermaid/type-aliases/SVGGroup.md
@@ -0,0 +1,15 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/type-aliases/SVGGroup.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/type-aliases/SVGGroup.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Type Alias: SVGGroup
+
+> **SVGGroup**: `d3.Selection`<`SVGGElement`, `unknown`, `Element` | `null`, `unknown`>
+
+Defined in: [packages/mermaid/src/diagram-api/types.ts:132](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L132)
--- a/docs/config/setup/mermaid/variables/default.md
+++ b/docs/config/setup/mermaid/variables/default.md
@@ -0,0 +1,15 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/variables/default.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/variables/default.md).
+
+[**mermaid**](../../README.md)
+
+---
+
+# Variable: default
+
+> `const` **default**: [`Mermaid`](../interfaces/Mermaid.md)
+
+Defined in: [packages/mermaid/src/mermaid.ts:442](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L442)