mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-10-31 19:04:16 +01:00
60 lines
1.4 KiB
Markdown
60 lines
1.4 KiB
Markdown
> **Warning**
|
|
>
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
>
|
|
> ## Please edit the corresponding file in package/mermaid/src/docs.
|
|
|
|
# Module: defaultConfig
|
|
|
|
## Variables
|
|
|
|
### <a id="configkeys" name="configkeys"></a> configKeys
|
|
|
|
• `Const` **configKeys**: `string`\[]
|
|
|
|
#### Defined in
|
|
|
|
[defaultConfig.ts:1855](https://github.com/emersonbottero/mermaid/blob/c8b377bf/packages/mermaid/src/defaultConfig.ts#L1855)
|
|
|
|
---
|
|
|
|
### <a id="default" name="default"></a> default
|
|
|
|
• `Const` **default**: `Partial`<`MermaidConfig`>
|
|
|
|
**Configuration methods in Mermaid version 8.6.0 have been updated, to learn more\[[click
|
|
here](8.6.0_docs.md)].**
|
|
|
|
## **What follows are config instructions for older versions**
|
|
|
|
These are the default options which can be overridden with the initialization call like so:
|
|
|
|
**Example 1:**
|
|
|
|
```js
|
|
mermaid.initialize({ flowchart: { htmlLabels: false } });
|
|
```
|
|
|
|
**Example 2:**
|
|
|
|
```js
|
|
let config = {
|
|
startOnLoad: true,
|
|
flowchart: { useMaxWidth: true, htmlLabels: true, curve: 'cardinal' },
|
|
|
|
securityLevel: 'loose',
|
|
};
|
|
mermaid.initialize(config);
|
|
```
|
|
|
|
A summary of all options and their defaults is found [here](#mermaidapi-configuration-defaults).
|
|
A description of each option follows below.
|
|
|
|
**`Name`**
|
|
|
|
Configuration
|
|
|
|
#### Defined in
|
|
|
|
[defaultConfig.ts:31](https://github.com/emersonbottero/mermaid/blob/c8b377bf/packages/mermaid/src/defaultConfig.ts#L31)
|