mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-25 10:20:06 +02:00
Merge branch 'master' into develop
This commit is contained in:
Knut Sveidqvist
@@ -52,14 +52,15 @@ A summary of all options and their defaults is found [here][5]. A description of
|
||||
|
||||
## theme
|
||||
|
||||
Theme , the CSS style sheet
|
||||
theme , the CSS style sheet
|
||||
|
||||
theme , the CSS style sheet
|
||||
|
||||
| Parameter | Description | Type | Required | Values |
|
||||
| --------- | --------------- | ------ | -------- | ---------------------------------------------------- |
|
||||
| Theme | Built in Themes | String | Optional | Values include, default, forest, dark, neutral, null |
|
||||
|
||||
**Notes:** To disable any pre-defined mermaid theme, use "null".
|
||||
**Notes:**To disable any pre-defined mermaid theme, use "null".
|
||||
|
||||
<pre>
|
||||
"theme": "forest",
|
||||
@@ -72,7 +73,7 @@ Theme , the CSS style sheet
|
||||
| ---------- | ------------------------------------------------------ | ------ | -------- | ---------------------------------------- |
|
||||
| fontFamily | specifies the font to be used in the rendered diagrams | String | Required | Trebuchet MS, Verdana, Arial, Sans-Serif |
|
||||
|
||||
**Default value is \\"trebuchet ms\\".
|
||||
\*\*notes: Default value is \\"trebuchet ms\\".
|
||||
|
||||
## logLevel
|
||||
|
||||
@@ -80,7 +81,7 @@ Theme , the CSS style sheet
|
||||
| --------- | ----------------------------------------------------- | ------ | -------- | ------------- |
|
||||
| logLevel | This option decides the amount of logging to be used. | String | Required | 1, 2, 3, 4, 5 |
|
||||
|
||||
**Values:**
|
||||
**Notes:**
|
||||
|
||||
- debug: 1.
|
||||
- info: 2.
|
||||
@@ -94,7 +95,7 @@ Theme , the CSS style sheet
|
||||
| ------------- | --------------------------------- | ------ | -------- | ------------------------- |
|
||||
| securitylevel | Level of trust for parsed diagram | String | Required | Strict, Loose, antiscript |
|
||||
|
||||
**Values:
|
||||
\*\*Notes:
|
||||
|
||||
- **strict**: (**default**) tags in text are encoded, click functionality is disabeled
|
||||
- **loose**: tags in text are allowed, click functionality is enabled
|
||||
@@ -115,7 +116,7 @@ Theme , the CSS style sheet
|
||||
| ------------------- | ---------------------------------------------------------------------------- | ------- | -------- | ----------- |
|
||||
| arrowMarkerAbsolute | Controls whether or arrow markers in html code are absolute paths or anchors | Boolean | Required | True, False |
|
||||
|
||||
**Notes : This matters if you are using base tag settings.**
|
||||
## Notes\*\*: This matters if you are using base tag settings.
|
||||
|
||||
**Default value: false**.
|
||||
|
||||
@@ -150,7 +151,7 @@ The object containing configurations specific for flowcharts
|
||||
| -------------- | ----------------------------------------------- | ------- | -------- | ------------------ |
|
||||
| diagramPadding | amount of padding around the diagram as a whole | Integer | Required | Any Positive Value |
|
||||
|
||||
**Notes: The amount of padding around the diagram as a whole so that embedded diagrams have margins, expressed in pixels**
|
||||
**Notes:**The amount of padding around the diagram as a whole so that embedded diagrams have margins, expressed in pixels
|
||||
**Default value: 8**.
|
||||
|
||||
### htmlLabels
|
||||
@@ -187,7 +188,7 @@ Pertains to horizontal spacing for TB (top to bottom) or BT (bottom to top) grap
|
||||
| curve | Defines how mermaid renders curves for flowcharts. | String | Required | Basis, Linear, Cardinal |
|
||||
|
||||
**Notes:
|
||||
Default Vaue: Linear**
|
||||
Default Vaue: monotoneX**
|
||||
|
||||
### useMaxWidth
|
||||
|
||||
@@ -206,7 +207,7 @@ The object containing configurations specific for sequence diagrams
|
||||
|
||||
### activationWidth
|
||||
|
||||
Width of the activation rect
|
||||
widt of the activation rect
|
||||
**Default value 10**.
|
||||
|
||||
### diagramMarginX
|
||||
@@ -374,7 +375,7 @@ This will display arrows that start and begin at the same node as right angles,
|
||||
### actorFontWeight
|
||||
|
||||
This sets the font weight of the actor's description
|
||||
Default value 400.
|
||||
\*\*Default value 400.
|
||||
|
||||
### noteFontSize
|
||||
|
||||
@@ -397,7 +398,7 @@ Default value 400.
|
||||
### noteFontWeight
|
||||
|
||||
This sets the font weight of the note's description
|
||||
**Default value 400.
|
||||
\*\*Default value 400.
|
||||
|
||||
### noteAlign
|
||||
|
||||
@@ -406,7 +407,7 @@ This sets the font weight of the note's description
|
||||
| noteAlign | This sets the text alignment of actor-attached notes. | string | required | left, center, right |
|
||||
|
||||
**Notes:**
|
||||
**Default value: center**.
|
||||
**Default value center**.
|
||||
|
||||
### messageFontSize
|
||||
|
||||
@@ -429,27 +430,27 @@ This sets the font weight of the note's description
|
||||
### messageFontWeight
|
||||
|
||||
This sets the font weight of the message's description
|
||||
Default value 400.
|
||||
\*\*Default value 400.
|
||||
|
||||
### wrap
|
||||
|
||||
This sets the auto-wrap state for the diagram
|
||||
Default value false.
|
||||
\*\*Default value false.
|
||||
|
||||
### wrapPadding
|
||||
|
||||
This sets the auto-wrap padding for the diagram (sides only)
|
||||
Default value 10.
|
||||
\*\*Default value 10.
|
||||
|
||||
### labelBoxWidth
|
||||
|
||||
This sets the width of the loop-box (loop, alt, opt, par)
|
||||
Default value 50.
|
||||
\*\*Default value 50.
|
||||
|
||||
### labelBoxHeight
|
||||
|
||||
This sets the height of the loop-box (loop, alt, opt, par)
|
||||
Default value 20.
|
||||
\*\*Default value 20.
|
||||
|
||||
## gantt
|
||||
|
||||
@@ -520,15 +521,14 @@ The object containing configurations specific for gantt diagrams\*
|
||||
**Notes:**
|
||||
**Default value 11**.
|
||||
|
||||
### fontFamily
|
||||
### sectionFontSize
|
||||
|
||||
| Parameter | Description | Type | Required | Values |
|
||||
| ---------- | ----------- | ------ | -------- | ------------------------- |
|
||||
| fontFamily | font Family | string | required | "Open-Sans", "sans-serif" |
|
||||
| Parameter | Description | Type | Required | Values |
|
||||
| --------------- | --------------------- | ------- | -------- | ------------------ |
|
||||
| sectionFontSize | Font size for secions | Integer | Required | Any Positive Value |
|
||||
|
||||
**Notes:**
|
||||
|
||||
**Default value '"Open-Sans", "sans-serif"'**.
|
||||
**Default value 11**.
|
||||
|
||||
### numberSectionStyles
|
||||
|
||||
@@ -556,8 +556,8 @@ This might need adjustment to match your locale and preferences
|
||||
| ----------- | ----------- | ------- | -------- | ----------- |
|
||||
| useMaxWidth | See notes | Boolean | 4 | True, False |
|
||||
|
||||
**Notes: when this flag is set the height and width is set to 100% and is then scaling with the
|
||||
available space if not the absolute space required is used.**
|
||||
**Notes:**when this flag is set the height and width is set to 100% and is then scaling with the
|
||||
available space if not the absolute space required is used.
|
||||
|
||||
**Default value true**.
|
||||
|
||||
@@ -583,7 +583,7 @@ The object containing configurations specific for journey diagrams
|
||||
**Notes:**
|
||||
**Default value 10**..
|
||||
|
||||
### actorMargin
|
||||
### leftMargin
|
||||
|
||||
| Parameter | Description | Type | Required | Values |
|
||||
| ----------- | ---------------------- | ------- | -------- | ------------------ |
|
||||
@@ -653,7 +653,7 @@ Space between messages.
|
||||
| ------------ | --------------------------- | ---- | -------- | ------------------- |
|
||||
| messageAlign | Multiline message alignment | 3 | 4 | left, center, right |
|
||||
|
||||
**Notes:** default:center
|
||||
**Notes:**default:center\*\*
|
||||
|
||||
### bottomMarginAdj
|
||||
|
||||
@@ -661,7 +661,7 @@ Space between messages.
|
||||
| --------------- | ------------------------------------------- | ------- | -------- | ------------------ |
|
||||
| bottomMarginAdj | Prolongs the edge of the diagram downwards. | Integer | 4 | Any Positive Value |
|
||||
|
||||
**Notes: Depending on css styling this might need adjustment.**
|
||||
**Notes:**Depending on css styling this might need adjustment.
|
||||
**Default value 1**.
|
||||
|
||||
### useMaxWidth
|
||||
@@ -681,7 +681,7 @@ available space if not the absolute space required is used.
|
||||
| ----------- | ---------------------------------- | ---- | -------- | ----------- |
|
||||
| rightAngles | Curved Arrows become Right Angles, | 3 | 4 | True, False |
|
||||
|
||||
**Notes:This will display arrows that start and begin at the same node as right angles, rather than a curves**
|
||||
**Notes:**This will display arrows that start and begin at the same node as right angles, rather than a curves
|
||||
**Default value false**.
|
||||
|
||||
## useMaxWidth
|
||||
@@ -690,13 +690,34 @@ available space if not the absolute space required is used.
|
||||
| ----------- | ----------- | ------- | -------- | ----------- |
|
||||
| useMaxWidth | See notes | Boolean | 4 | True, False |
|
||||
|
||||
**Notes: when this flag is set, the height and width is set to 100% and is then scaling with the
|
||||
available space if not the absolute space required is used.**
|
||||
**Notes:**when this flag is set the height and width is set to 100% and is then scaling with the
|
||||
available space if not the absolute space required is used.
|
||||
|
||||
**Default value true**.
|
||||
|
||||
## useMaxWidth
|
||||
|
||||
## ER Diagrams
|
||||
| Parameter | Description | Type | Required | Values |
|
||||
| ----------- | ----------- | ------- | -------- | ----------- |
|
||||
| useMaxWidth | See notes | Boolean | 4 | True, False |
|
||||
|
||||
**Notes:**when this flag is set the height and width is set to 100% and is then scaling with the
|
||||
available space if not the absolute space required is used.
|
||||
|
||||
**Default value true**.
|
||||
|
||||
## useMaxWidth
|
||||
|
||||
| Parameter | Description | Type | Required | Values |
|
||||
| ----------- | ----------- | ------- | -------- | ----------- |
|
||||
| useMaxWidth | See notes | Boolean | 4 | True, False |
|
||||
|
||||
**Notes:**when this flag is set the height and width is set to 100% and is then scaling with the
|
||||
available space if not the absolute space required is used.
|
||||
|
||||
**Default value true**.
|
||||
|
||||
## er
|
||||
|
||||
The object containing configurations specific for entity relationship diagrams
|
||||
|
||||
@@ -735,7 +756,7 @@ T = top, B = bottom, L = left, and R = right.
|
||||
| --------------- | ------------------------------------ | ------- | -------- | ------------------ |
|
||||
| minEntityHeight | The minimum height of an entity box, | Integer | 4 | Any Positive Value |
|
||||
|
||||
**Notes: expressed in pixels**
|
||||
**Notes:**expressed in pixels
|
||||
**Default value: 75 **
|
||||
|
||||
### entityPadding
|
||||
@@ -744,7 +765,7 @@ T = top, B = bottom, L = left, and R = right.
|
||||
| ------------- | ------------------------------------------------------------ | ------- | -------- | ------------------ |
|
||||
| entityPadding | minimum internal padding betweentext in box and box borders | Integer | 4 | Any Positive Value |
|
||||
|
||||
**Notes: The minimum internal padding betweentext in an entity box and the enclosing box borders, expressed in pixels.**
|
||||
**Notes:**The minimum internal padding betweentext in an entity box and the enclosing box borders, expressed in pixels.
|
||||
**Default value: 15 **
|
||||
|
||||
### stroke
|
||||
@@ -770,7 +791,7 @@ T = top, B = bottom, L = left, and R = right.
|
||||
| --------- | ------------------- | ------- | -------- | ------------------ |
|
||||
| fontSize | Font Size in pixels | Integer | | Any Positive Value |
|
||||
|
||||
**Notes: Font size (expressed as an integer representing a number of pixels)**
|
||||
**Notes:**Font size (expressed as an integer representing a number of pixels)
|
||||
**Default value: 12 **
|
||||
|
||||
### useMaxWidth
|
||||
|
||||
Reference in New Issue
Block a user