mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-05 16:46:43 +02:00
41 lines
1.5 KiB
Markdown
41 lines
1.5 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/setSiteConfig.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/setSiteConfig.md).
|
|
|
|
[**mermaid**](../../README.md)
|
|
|
|
---
|
|
|
|
# Function: setSiteConfig()
|
|
|
|
> **setSiteConfig**(`conf`): [`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
|
|
Defined in: [packages/mermaid/src/config.ts:61](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L61)
|
|
|
|
## setSiteConfig
|
|
|
|
| Function | Description | Type | Values |
|
|
| ------------- | ------------------------------------- | ----------- | --------------------------------------- |
|
|
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
|
|
|
|
**Notes:** Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls
|
|
to reset() will reset the currentConfig to siteConfig. Calls to reset(configApi.defaultConfig)
|
|
will reset siteConfig and currentConfig to the defaultConfig Note: currentConfig is set in this
|
|
function _Default value: At default, will mirror Global Config_
|
|
|
|
## Parameters
|
|
|
|
### conf
|
|
|
|
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
|
|
The base currentConfig to use as siteConfig
|
|
|
|
## Returns
|
|
|
|
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
|
|
The new siteConfig
|