GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-28 07:03:17 +08:00
Code Issues Projects Releases Wiki Activity

Updated after 8.6.4 merge

Browse Source
This commit is contained in:
Knut Sveidqvist 2020-07-26 22:38:55 +02:00
parent 1c06e9d683
commit 4e12f959fc
7 changed files with 14 additions and 249 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

165
dist/mermaid.core.js vendored
View File

File diff suppressed because one or more lines are too long

6
dist/mermaid.core.js.map vendored
View File

File diff suppressed because one or more lines are too long

30
dist/mermaid.js vendored
View File

File diff suppressed because one or more lines are too long

6
dist/mermaid.js.map vendored
View File

File diff suppressed because one or more lines are too long

16
dist/mermaid.min.js vendored
View File

File diff suppressed because one or more lines are too long

6
dist/mermaid.min.js.map vendored
View File

File diff suppressed because one or more lines are too long

34
docs/Setup.md
View File

@ -13,7 +13,7 @@ In addition to the render function, a number of behavioral configuration options
## Configuration
**Configuration methods in Mermaid version 8.6.0 have been updated to include `directives`, to learn more\[[click here][2]].**
**Configuration methods in Mermaid version 8.6.0 have been updated, to learn more\[[click here][2]].**
## **What follows are config instructions for older versions**
@ -48,31 +48,6 @@ mermaid.initialize({
A summary of all options and their defaults is found [here][3]. A description of each option follows below.
| Parameter | Description | Type | Required | Values |
| ---------- | ------------------------------------------------------ | ------ | -------- | ----------------------------- |
| config | current mermaid configurations | Object | Required | All parameters and values, except where prohibited by `secure`. |
**Notes:**
**config here is an object that can be created either through `const` or `var` and is loaded by `mermaidAPI.initialize`.
config, can be overriden using the `%%init%%` directive, after [Version 8.6.0](./8.6.0_docs.md) was introduced.
## secure
This option controls which currentConfig keys are considered _secure_ and can only be changed via
call to mermaidAPI.initialize. Calls to `mermaidAPI.reinitialize` cannot make changes to
the `secure` keys in the current currentConfig. This prevents malicious graph directives from
overriding a site's default security.
| Parameter | Description |Type | Required | Values|
| --- | --- | --- | --- | --- |
| secure | Array of parameters that cannot be changed the `init` directive| Array | Required | Any parameters|
The modifiable parts of the Configuration are limited by the secure array, which is an array of immutable parameters, this array can be expanded by site owners.
**Notes**: `secure` arrays work like nesting dolls, with the Global Configurations’ secure array being the default and immutable list of immutable parameters, or the smallest doll, to which site owners may add to, but implementors may not modify it.
## theme
theme , the CSS style sheet
@ -143,6 +118,13 @@ theme , the CSS style sheet
**Default value: false**.
## secure
This option controls which currentConfig keys are considered _secure_ and can only be changed via
call to mermaidAPI.initialize. Calls to mermaidAPI.reinitialize cannot make changes to
the `secure` keys in the current currentConfig. This prevents malicious graph directives from
overriding a site's default security.
## flowchart
The object containing configurations specific for flowcharts