mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-01-28 07:03:17 +08:00
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
|
> **Warning**
|
||
|
|
>
|
||
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||
|
|
>
|
||
|
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/modules/defaultConfig.md](../../../../packages/mermaid/src/docs/config/setup/modules/defaultConfig.md).
|
||
|
|
|
||
|
|
# Module: defaultConfig
|
||
|
|
|
||
|
|
## Variables
|
||
|
|
|
||
|
|
### configKeys
|
||
|
|
|
||
|
|
• `Const` **configKeys**: `string`\[]
|
||
|
|
|
||
|
|
#### Defined in
|
||
|
|
|
||
|
|
[defaultConfig.ts:1881](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L1881)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### 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:**
|
||
|
|
|
||
|
|
```html
|
||
|
|
<script>
|
||
|
|
const config = {
|
||
|
|
startOnLoad: true,
|
||
|
|
flowchart: { useMaxWidth: true, htmlLabels: true, curve: 'cardinal' },
|
||
|
|
securityLevel: 'loose',
|
||
|
|
};
|
||
|
|
mermaid.initialize(config);
|
||
|
|
</script>
|
||
|
|
```
|
||
|
|
|
||
|
|
A summary of all options and their defaults is found [here](#mermaidapi-configuration-defaults).
|
||
|
|
A description of each option follows below.
|
||
|
|
|
||
|
|
#### Defined in
|
||
|
|
|
||
|
|
[defaultConfig.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L33)
|