mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-21 00:09:51 +02:00
40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
> **Warning**
|
|
>
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
>
|
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/setConfig.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/setConfig.md).
|
|
|
|
[**mermaid**](../../README.md)
|
|
|
|
---
|
|
|
|
# Function: setConfig()
|
|
|
|
> **setConfig**(`conf`): [`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
|
|
Defined in: [packages/mermaid/src/config.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L113)
|
|
|
|
## setConfig
|
|
|
|
| Function | Description | Type | Values |
|
|
| ------------- | ------------------------------------- | ----------- | --------------------------------------- |
|
|
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
|
|
|
|
**Notes**: Sets the currentConfig. The parameter conf is sanitized based on the siteConfig.secure
|
|
keys. Any values found in conf with key found in siteConfig.secure will be replaced with the
|
|
corresponding siteConfig value.
|
|
|
|
## Parameters
|
|
|
|
### conf
|
|
|
|
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
|
|
The potential currentConfig
|
|
|
|
## Returns
|
|
|
|
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
|
|
The currentConfig merged with the sanitized conf
|