marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-12-04 19:44:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Corrected typos in documentation

Browse Source
This commit is contained in:
AlwinW
2021-10-23 22:57:24 +11:00
parent f8c01acd18
commit 8b35745928
13 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/Setup.md
View File

@@ -70,7 +70,7 @@ theme , the CSS style sheet
| Parameter | Description | Type | Required | Values |
| ---------- | ------------------------------------------------------ | ------ | -------- | --------------------------- |
| fontFamily | specifies the font to be used in the rendered diagrams | string | Required | Any Posiable CSS FontFamily |
| fontFamily | specifies the font to be used in the rendered diagrams | string | Required | Any Possible CSS FontFamily |
**Notes:**
Default value: '"trebuchet ms", verdana, arial, sans-serif;'.
@@ -103,9 +103,9 @@ Default value: '"trebuchet ms", verdana, arial, sans-serif;'.
## startOnLoad
| Parameter | Description | Type | Required | Values |
| ----------- | --------------------------------------------- | ------- | -------- | ----------- |
| startOnLoad | Dictates whether mermaind starts on Page load | boolean | Required | true, false |
| Parameter | Description | Type | Required | Values |
| ----------- | -------------------------------------------- | ------- | -------- | ----------- |
| startOnLoad | Dictates whether mermaid starts on Page load | boolean | Required | true, false |
**Notes:** Default value: true
@@ -204,7 +204,7 @@ Default value 50
**Notes:**
Default Vaue: 'basis'
Default Value: 'basis'
### useMaxWidth
@@ -411,7 +411,7 @@ Default value: false
| Parameter | Description | Type | Required | Values |
| --------------- | ---------------------------------------------------- | ------ | -------- | --------------------------- |
| actorFontFamily | This sets the font family of the actor's description | string | Required | Any Posiable CSS FontFamily |
| actorFontFamily | This sets the font family of the actor's description | string | Required | Any Possible CSS FontFamily |
**Notes:**
Default value: "'Open-Sans", "sans-serif"'
@@ -436,7 +436,7 @@ Default value: 14
| Parameter | Description | Type | Required | Values |
| -------------- | -------------------------------------------------- | ------ | -------- | --------------------------- |
| noteFontFamily | This sets the font family of actor-attached notes. | string | Required | Any Posiable CSS FontFamily |
| noteFontFamily | This sets the font family of actor-attached notes. | string | Required | Any Possible CSS FontFamily |
**Notes:**
Default value: ''"trebuchet ms", verdana, arial, sans-serif'
@@ -470,7 +470,7 @@ Default value: 16
| Parameter | Description | Type | Required | Values |
| ----------------- | ------------------------------------------- | ------ | -------- | --------------------------- |
| messageFontFamily | This sets the font family of actor messages | string | Required | Any Posiable CSS FontFamily |
| messageFontFamily | This sets the font family of actor messages | string | Required | Any Possible CSS FontFamily |
**Notes:**
Default value: '"trebuchet ms", verdana, arial, sans-serif'
@@ -590,9 +590,9 @@ Default value: 11
### sectionFontSize
| Parameter | Description | Type | Required | Values |
| --------------- | --------------------- | ------- | -------- | ------------------ |
| sectionFontSize | Font size for secions | Integer | Required | Any Positive Value |
| Parameter | Description | Type | Required | Values |
| --------------- | ---------------------- | ------- | -------- | ------------------ |
| sectionFontSize | Font size for sections | Integer | Required | Any Positive Value |
**Notes:**
Default value: 11
@@ -879,7 +879,7 @@ Default value: 'TB'
| Parameter | Description | Type | Required | Values |
| -------------- | ---------------------------------- | ------- | -------- | ------------------ |
| minEntityWidth | The mimimum width of an entity box | Integer | Required | Any Positive Value |
| minEntityWidth | The minimum width of an entity box | Integer | Required | Any Positive Value |
**Notes:**
Expressed in pixels.