marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-10-02 13:49:37 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update 8.6.0_docs.md

Browse Source
This commit is contained in:
Neil Cuzon
2020-07-23 18:33:11 -07:00
committed by GitHub
parent c6a1f42c44
commit 52c30e588c
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/8.6.0_docs.md
View File

@@ -42,9 +42,9 @@ Implementors can only modify configurations using directives, but cannot change
# Modifying Configurations and directives:
The Two types of directives: are “init” or “initialize” and “wrap”.
**Notes**: All directives are enclosed in %%{ }%%.
**Notes**: All directives are enclosed in `%%{ }%%.`
Older versions of mermaid will not parse directives because %% will comment out the directive.
Older versions of mermaid will not parse directives because `%%` will comment out the directive.
# Init
init, or initialize: the init or initialize directive gives the user the ability to overwrite and change the values for configuration parameters, with respect to the secure array that is in effect.
@@ -55,17 +55,18 @@ init, or initialize: the init or initialize directive gives the user the ability
**Notes:**
init would be an argument-directive: %%{init: { **insert argument here**}}%%
init would be an argument-directive: `%%{init: { **insert argument here**}}%%`
The json object that is passed as {**argument** } must be valid, quoted json or it will be ignored.
**for example**:
%%{init: {"theme": default, "logLevel": 1 }}%%
`%%{init: {"theme": default, "logLevel": 1 }}%%`
Configurations that are passed through init cannot change the parameters in secure arrays of higher levels. In the event of a conflict, mermaid will give priority to secure arrays and parse the request, without changing the values of the parameters in conflict.
When deployed within code, init is called before the graph/diagram description.
**for example**:
```
%%{init: {"theme": "default", "logLevel": 1 }}%%
graph LR
a-->b
@@ -75,7 +76,7 @@ When deployed within code, init is called before the graph/diagram description.
e-->f
f-->g
g-->
```
# Wrap
| Parameter | Description |Type | Required | Values|
| --- | --- | --- | --- | --- |
@@ -89,7 +90,7 @@ wrap respects manually added <br\> so if the user wants to break up their text,
It is a non-argument directive and can be executed thusly:
%%{wrap}%%.
`%%{wrap}%%` .
**an example of text wrapping in a sequence diagram**: