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

docs: update defaultConfig docs

Browse Source
This commit is contained in:
Mr.Hope
2021-04-24 15:56:26 +08:00
parent 68d0002d6b
commit 97563c1f2a
1 changed files with 18 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/defaultConfig.js
View File

@@ -3,6 +3,7 @@ import theme from './themes';
* **Configuration methods in Mermaid version 8.6.0 have been updated, to learn more[[click here](8.6.0_docs.md)].** * **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** * ## **What follows are config instructions for older versions**
*
* These are the default options which can be overridden with the initialization call like so: * These are the default options which can be overridden with the initialization call like so:
* *
* **Example 1:** * **Example 1:**
@@ -58,9 +59,10 @@ const config = {
/** /**
* | Parameter | Description | Type | Required | Values | * | Parameter | Description | Type | Required | Values |
* | --- | --- | --- | --- | --- | * | --- | --- | --- | --- | --- |
* | fontFamily | specifies the font to be used in the rendered diagrams| string | Required | 'Trebuchet MS', 'Verdana', 'Arial', 'Sans-Serif' | * | fontFamily | specifies the font to be used in the rendered diagrams| string | Required | Any Posiable CSS FontFamily |
* *
* **Notes:** Default value is 'trebuchet ms'. * **Notes:**
* Default value: '"trebuchet ms", verdana, arial, sans-serif;'.
*/ */
fontFamily: '"trebuchet ms", verdana, arial, sans-serif;', fontFamily: '"trebuchet ms", verdana, arial, sans-serif;',
@@ -175,7 +177,7 @@ const config = {
/** /**
* | Parameter | Description | Type | Required | Values | * | Parameter | Description | Type | Required | Values |
* | --- | --- | --- | --- | --- | * | --- | --- | --- | --- | --- |
* | nodeSpacing | Defines the spacing between nodes on the same level | Integer | Required | Any positive Numbers | * | nodeSpacing | Defines the spacing between nodes on the same level | Integer | Required | Any positive Number |
* *
* **Notes:** * **Notes:**
* *
@@ -188,7 +190,7 @@ const config = {
/** /**
* | Parameter | Description | Type | Required | Values | * | Parameter | Description | Type | Required | Values |
* | --- | --- | --- | --- | --- | * | --- | --- | --- | --- | --- |
* | rankSpacing | Defines the spacing between nodes on different levels | Integer | Required | Any Positive Numbers | * | rankSpacing | Defines the spacing between nodes on different levels | Integer | Required | Any Positive Number |
* *
* **Notes**: * **Notes**:
* *
@@ -244,7 +246,7 @@ const config = {
/** /**
* | Parameter | Description | Type | Required | Values | * | Parameter | Description | Type | Required | Values |
* | --- | --- | --- | --- | --- | * | --- | --- | --- | --- | --- |
* | diagramMarginX | Margin to the right and left of the sequence diagram | Integer | Required | Any Positive Values | * | diagramMarginX | Margin to the right and left of the sequence diagram | Integer | Required | Any Positive Value |
* *
* **Notes:** Default value: 50 * **Notes:** Default value: 50
*/ */
@@ -253,7 +255,7 @@ const config = {
/** /**
*| Parameter | Description | Type | Required | Values | *| Parameter | Description | Type | Required | Values |
*| --- | --- | --- | --- | --- | *| --- | --- | --- | --- | --- |
*| diagramMarginY | Margin to the over and under the sequence diagram | Integer | Required | Any Positive Values| *| diagramMarginY | Margin to the over and under the sequence diagram | Integer | Required | Any Positive Value |
* *
* **Notes:** Default value: 10 * **Notes:** Default value: 10
*/ */
@@ -411,7 +413,7 @@ const config = {
/** /**
* | Parameter | Description | Type | Required | Values | * | Parameter | Description | Type | Required | Values |
* | --- | --- | --- | --- | --- | * | --- | --- | --- | --- | --- |
* | actorFontFamily |This sets the font family of the actor's description | string | Required | Open-Sans, Sans-Serif | * | actorFontFamily |This sets the font family of the actor's description | string | Required | Any Posiable CSS FontFamily |
* *
* **Notes:** * **Notes:**
* Default value: "'Open-Sans", "sans-serif"' * Default value: "'Open-Sans", "sans-serif"'
@@ -439,7 +441,7 @@ const config = {
/** /**
* | Parameter | Description | Type | Required | Values | * | Parameter | Description | Type | Required | Values |
* | --- | --- | --- | --- | --- | * | --- | --- | --- | --- | --- |
* | noteFontFamily| This sets the font family of actor-attached notes. | string | Required | Any Positive Value | * | noteFontFamily| This sets the font family of actor-attached notes. | string | Required | Any Posiable CSS FontFamily |
* *
* **Notes:** * **Notes:**
* Default value: ''"trebuchet ms", verdana, arial, sans-serif' * Default value: ''"trebuchet ms", verdana, arial, sans-serif'
@@ -477,7 +479,7 @@ const config = {
/** /**
* | Parameter | Description | Type | Required | Values | * | Parameter | Description | Type | Required | Values |
* | --- | --- | --- | --- | --- | * | --- | --- | --- | --- | --- |
* | messageFontFamily | This sets the font family of actor messages | string | Required | Any Positive Value | * | messageFontFamily | This sets the font family of actor messages | string | Required | Any Posiable CSS FontFamily |
* *
* **Notes:** * **Notes:**
* Default value: '"trebuchet ms", verdana, arial, sans-serif' * Default value: '"trebuchet ms", verdana, arial, sans-serif'