mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-02-04 07:13:25 +08:00
chore: Ignore packages/mermaid/src/docs/config/setup
This commit is contained in:
Sidharth Vinod
parent
85444dbee9
commit
d1e235a08b
2
.gitignore
vendored
2
.gitignore
vendored
@ -32,5 +32,3 @@ cypress/snapshots/
|
|||||||
.eslintcache
|
.eslintcache
|
||||||
.tsbuildinfo
|
.tsbuildinfo
|
||||||
tsconfig.tsbuildinfo
|
tsconfig.tsbuildinfo
|
||||||
|
|
||||||
packages/mermaid/src/vitepress
|
|
||||||
2
packages/mermaid/.gitignore
vendored
Normal file
2
packages/mermaid/.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
src/vitepress
|
||||||
|
src/docs/config/setup
|
||||||
@ -1,7 +0,0 @@
|
|||||||
# mermaid
|
|
||||||
|
|
||||||
## Modules
|
|
||||||
|
|
||||||
- [config](modules/config.md)
|
|
||||||
- [defaultConfig](modules/defaultConfig.md)
|
|
||||||
- [mermaidAPI](modules/mermaidAPI.md)
|
|
||||||
@ -1,270 +0,0 @@
|
|||||||
# Module: config
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
### <a id="defaultconfig" name="defaultconfig"></a> defaultConfig
|
|
||||||
|
|
||||||
• `Const` **defaultConfig**: `MermaidConfig`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:7
|
|
||||||
|
|
||||||
## Functions
|
|
||||||
|
|
||||||
### <a id="adddirective" name="adddirective"></a> addDirective
|
|
||||||
|
|
||||||
▸ **addDirective**(`directive`): `void`
|
|
||||||
|
|
||||||
Pushes in a directive to the configuration
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
| :---------- | :---- | :----------------------- |
|
|
||||||
| `directive` | `any` | The directive to push in |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:191
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="getconfig" name="getconfig"></a> getConfig
|
|
||||||
|
|
||||||
▸ **getConfig**(): `MermaidConfig`
|
|
||||||
|
|
||||||
## getConfig
|
|
||||||
|
|
||||||
| Function | Description | Type | Return Values |
|
|
||||||
| --------- | ------------------------- | ----------- | ------------------------------ |
|
|
||||||
| getConfig | Obtains the currentConfig | Get Request | Any Values from current Config |
|
|
||||||
|
|
||||||
**Notes**: Returns **any** the currentConfig
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`MermaidConfig`
|
|
||||||
|
|
||||||
The currentConfig
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:136
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="getsiteconfig" name="getsiteconfig"></a> getSiteConfig
|
|
||||||
|
|
||||||
▸ **getSiteConfig**(): `MermaidConfig`
|
|
||||||
|
|
||||||
## getSiteConfig
|
|
||||||
|
|
||||||
| Function | Description | Type | Values |
|
|
||||||
| ------------- | ------------------------------------------------- | ----------- | -------------------------------- |
|
|
||||||
| setSiteConfig | Returns the current siteConfig base configuration | Get Request | Returns Any Values in siteConfig |
|
|
||||||
|
|
||||||
**Notes**: Returns **any** values in siteConfig.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`MermaidConfig`
|
|
||||||
|
|
||||||
The siteConfig
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:96
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="reset" name="reset"></a> reset
|
|
||||||
|
|
||||||
▸ **reset**(`config?`): `void`
|
|
||||||
|
|
||||||
## reset
|
|
||||||
|
|
||||||
| Function | Description | Type | Required | Values |
|
|
||||||
| -------- | ---------------------------- | ----------- | -------- | ------ |
|
|
||||||
| reset | Resets currentConfig to conf | Put Request | Required | None |
|
|
||||||
|
|
||||||
## conf
|
|
||||||
|
|
||||||
| Parameter | Description | Type | Required | Values |
|
|
||||||
| --------- | -------------------------------------------------------------- | ---------- | -------- | -------------------------------------------- |
|
|
||||||
| conf | base set of values, which currentConfig could be **reset** to. | Dictionary | Required | Any Values, with respect to the secure Array |
|
|
||||||
|
|
||||||
**Notes**: (default: current siteConfig ) (optional, default `getSiteConfig()`)
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
|
||||||
| :------- | :-------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `config` | `MermaidConfig` | `siteConfig` | base set of values, which currentConfig could be **reset** to. Defaults to the current siteConfig (e.g returned by [getSiteConfig](config.md#getsiteconfig)). |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:223
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="sanitize" name="sanitize"></a> sanitize
|
|
||||||
|
|
||||||
▸ **sanitize**(`options`): `void`
|
|
||||||
|
|
||||||
## sanitize
|
|
||||||
|
|
||||||
| Function | Description | Type | Values |
|
|
||||||
| -------- | -------------------------------------- | ----------- | ------ |
|
|
||||||
| sanitize | Sets the siteConfig to desired values. | Put Request | None |
|
|
||||||
|
|
||||||
Ensures options parameter does not attempt to override siteConfig secure keys **Notes**: modifies
|
|
||||||
options in-place
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
| :-------- | :---- | :-------------------------------- |
|
|
||||||
| `options` | `any` | The potential setConfig parameter |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:151
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="saveconfigfrominitialize" name="saveconfigfrominitialize"></a> saveConfigFromInitialize
|
|
||||||
|
|
||||||
▸ **saveConfigFromInitialize**(`conf`): `void`
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :----- | :-------------- |
|
|
||||||
| `conf` | `MermaidConfig` |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:75
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="setconfig" name="setconfig"></a> setConfig
|
|
||||||
|
|
||||||
▸ **setConfig**(`conf`): `MermaidConfig`
|
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
| :----- | :-------------- | :-------------------------- |
|
|
||||||
| `conf` | `MermaidConfig` | The potential currentConfig |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`MermaidConfig`
|
|
||||||
|
|
||||||
The currentConfig merged with the sanitized conf
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:113
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="setsiteconfig" name="setsiteconfig"></a> setSiteConfig
|
|
||||||
|
|
||||||
▸ **setSiteConfig**(`conf`): `MermaidConfig`
|
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
| :----- | :-------------- | :------------------------------------------ |
|
|
||||||
| `conf` | `MermaidConfig` | The base currentConfig to use as siteConfig |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`MermaidConfig`
|
|
||||||
|
|
||||||
The new siteConfig
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:61
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="updatecurrentconfig" name="updatecurrentconfig"></a> updateCurrentConfig
|
|
||||||
|
|
||||||
▸ **updateCurrentConfig**(`siteCfg`, `_directives`): `MermaidConfig`
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :------------ | :-------------- |
|
|
||||||
| `siteCfg` | `MermaidConfig` |
|
|
||||||
| `_directives` | `any`[] |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`MermaidConfig`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:14
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="updatesiteconfig" name="updatesiteconfig"></a> updateSiteConfig
|
|
||||||
|
|
||||||
▸ **updateSiteConfig**(`conf`): `MermaidConfig`
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :----- | :-------------- |
|
|
||||||
| `conf` | `MermaidConfig` |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`MermaidConfig`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
config.ts:79
|
|
||||||
@ -1,50 +0,0 @@
|
|||||||
# Module: defaultConfig
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
### <a id="configkeys" name="configkeys"></a> configKeys
|
|
||||||
|
|
||||||
• `Const` **configKeys**: `string`[]
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
defaultConfig.ts:1869
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <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:**
|
|
||||||
|
|
||||||
```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
|
|
||||||
@ -1,117 +0,0 @@
|
|||||||
# Module: mermaidAPI
|
|
||||||
|
|
||||||
## References
|
|
||||||
|
|
||||||
### <a id="default" name="default"></a> default
|
|
||||||
|
|
||||||
Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi)
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
### <a id="mermaidapi" name="mermaidapi"></a> mermaidAPI
|
|
||||||
|
|
||||||
• `Const` **mermaidAPI**: `Readonly`<{ `defaultConfig`: `MermaidConfig` = configApi.defaultConfig; `getConfig`: () => `MermaidConfig` = configApi.getConfig; `getSiteConfig`: () => `MermaidConfig` = configApi.getSiteConfig; `globalReset`: () => `void` ; `initialize`: (`options`: `MermaidConfig`) => `Promise`<`void`\> ; `parse`: (`text`: `string`, `parseError?`: `ParseErrorFunction`) => `boolean` ; `parseDirective`: (`p`: `any`, `statement`: `string`, `context`: `string`, `type`: `string`) => `void` ; `render`: (`id`: `string`, `text`: `string`, `cb`: (`svgCode`: `string`, `bindFunctions?`: (`element`: `Element`) => `void`) => `void`, `container?`: `Element`) => `Promise`<`void`\> ; `reset`: () => `void` ; `setConfig`: (`conf`: `MermaidConfig`) => `MermaidConfig` = configApi.setConfig; `updateSiteConfig`: (`conf`: `MermaidConfig`) => `MermaidConfig` = configApi.updateSiteConfig }\>
|
|
||||||
|
|
||||||
## mermaidAPI configuration defaults
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const config = {
|
|
||||||
theme: 'default',
|
|
||||||
logLevel: 'fatal',
|
|
||||||
securityLevel: 'strict',
|
|
||||||
startOnLoad: true,
|
|
||||||
arrowMarkerAbsolute: false,
|
|
||||||
|
|
||||||
er: {
|
|
||||||
diagramPadding: 20,
|
|
||||||
layoutDirection: 'TB',
|
|
||||||
minEntityWidth: 100,
|
|
||||||
minEntityHeight: 75,
|
|
||||||
entityPadding: 15,
|
|
||||||
stroke: 'gray',
|
|
||||||
fill: 'honeydew',
|
|
||||||
fontSize: 12,
|
|
||||||
useMaxWidth: true,
|
|
||||||
},
|
|
||||||
flowchart: {
|
|
||||||
diagramPadding: 8,
|
|
||||||
htmlLabels: true,
|
|
||||||
curve: 'basis',
|
|
||||||
},
|
|
||||||
sequence: {
|
|
||||||
diagramMarginX: 50,
|
|
||||||
diagramMarginY: 10,
|
|
||||||
actorMargin: 50,
|
|
||||||
width: 150,
|
|
||||||
height: 65,
|
|
||||||
boxMargin: 10,
|
|
||||||
boxTextMargin: 5,
|
|
||||||
noteMargin: 10,
|
|
||||||
messageMargin: 35,
|
|
||||||
messageAlign: 'center',
|
|
||||||
mirrorActors: true,
|
|
||||||
bottomMarginAdj: 1,
|
|
||||||
useMaxWidth: true,
|
|
||||||
rightAngles: false,
|
|
||||||
showSequenceNumbers: false,
|
|
||||||
},
|
|
||||||
gantt: {
|
|
||||||
titleTopMargin: 25,
|
|
||||||
barHeight: 20,
|
|
||||||
barGap: 4,
|
|
||||||
topPadding: 50,
|
|
||||||
leftPadding: 75,
|
|
||||||
gridLineStartPadding: 35,
|
|
||||||
fontSize: 11,
|
|
||||||
fontFamily: '"Open Sans", sans-serif',
|
|
||||||
numberSectionStyles: 4,
|
|
||||||
axisFormat: '%Y-%m-%d',
|
|
||||||
topAxis: false,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
mermaid.initialize(config);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
mermaidAPI.ts:546
|
|
||||||
|
|
||||||
## Functions
|
|
||||||
|
|
||||||
### <a id="decodeentities" name="decodeentities"></a> decodeEntities
|
|
||||||
|
|
||||||
▸ **decodeEntities**(`text`): `string`
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :----- | :------- |
|
|
||||||
| `text` | `string` |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
mermaidAPI.ts:72
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### <a id="encodeentities" name="encodeentities"></a> encodeEntities
|
|
||||||
|
|
||||||
▸ **encodeEntities**(`text`): `string`
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :----- | :------- |
|
|
||||||
| `text` | `string` |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
mermaidAPI.ts:46
|
|
||||||
Loading…
x
Reference in New Issue
Block a user