mermaid/docs/config/setup/modules/defaultConfig.md

57 lines
1.4 KiB
Markdown
Raw Normal View History

2022-10-18 04:58:51 +02:00
> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
2022-10-28 21:16:25 +02:00
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/modules/defaultConfig.md](../../../../packages/mermaid/src/docs/config/setup/modules/defaultConfig.md).
2022-10-15 05:50:11 +02:00
# Module: defaultConfig
## Variables
2022-10-31 17:45:07 +01:00
### configKeys
2022-10-15 05:50:11 +02:00
`Const` **configKeys**: `string`\[]
#### Defined in
[defaultConfig.ts:1933](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L1933)
2022-10-15 05:50:11 +02:00
---
2022-10-31 17:45:07 +01:00
### default
2022-10-15 05:50:11 +02:00
`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:**
2022-10-25 22:54:07 +02:00
```html
<script>
2022-10-28 00:58:39 +02:00
const config = {
2022-10-25 22:54:07 +02:00
startOnLoad: true,
flowchart: { useMaxWidth: true, htmlLabels: true, curve: 'cardinal' },
securityLevel: 'loose',
};
mermaid.initialize(config);
</script>
2022-10-15 05:50:11 +02:00
```
A summary of all options and their defaults is found [here](#mermaidapi-configuration-defaults).
A description of each option follows below.
#### Defined in
2022-10-31 17:45:07 +01:00
[defaultConfig.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L33)