marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-25 18:30:10 +02: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

16
src/defaultConfig.js
View File

@@ -59,7 +59,7 @@ const config = {
/**
* | 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;'.
@@ -98,7 +98,7 @@ const config = {
/**
* | Parameter | Description | Type | Required | Values |
* | --- | --- | --- | --- | --- |
* | startOnLoad | Dictates whether mermaind starts on Page load | boolean | Required | true, false |
* | startOnLoad | Dictates whether mermaid starts on Page load | boolean | Required | true, false |
*
* **Notes:** Default value: true
*/
@@ -207,7 +207,7 @@ const config = {
*
* **Notes:**
*
* Default Vaue: 'basis'
* Default Value: 'basis'
*/
curve: 'basis',
// Only used in new experimental rendering
@@ -439,7 +439,7 @@ const config = {
/**
* | 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"'
@@ -467,7 +467,7 @@ const config = {
/**
* | 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'
@@ -505,7 +505,7 @@ const config = {
/**
* | 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'
@@ -664,7 +664,7 @@ const config = {
/**
* | Parameter | Description | Type | Required | Values|
* | --- | --- | --- | --- | --- |
* | sectionFontSize | Font size for secions| Integer | Required | Any Positive Value |
* | sectionFontSize | Font size for sections| Integer | Required | Any Positive Value |
*
* **Notes:**
* Default value: 11
@@ -1015,7 +1015,7 @@ top of the chart
/**
* | 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.

6
src/diagrams/flowchart/parser/flow-style.spec.js
View File

@@ -61,7 +61,7 @@ describe('[Style] when parsing', () => {
expect(vert['T'].styles[1]).toBe('border:1px solid red');
});
it('should handle styles and graph definitons in a graph', function() {
it('should handle styles and graph definitions in a graph', function() {
const res = flow.parser.parse(
'graph TD;S-->T;\nstyle S background:#aaa;\nstyle T background:#bbb,border:1px solid red;'
);
@@ -76,7 +76,7 @@ describe('[Style] when parsing', () => {
expect(vert['T'].styles[1]).toBe('border:1px solid red');
});
it('should handle styles and graph definitons in a graph', function() {
it('should handle styles and graph definitions in a graph', function() {
const res = flow.parser.parse('graph TD;style T background:#bbb,border:1px solid red;');
// const res = flow.parser.parse('graph TD;style T background: #bbb;');
@@ -277,7 +277,7 @@ describe('[Style] when parsing', () => {
expect(edges[0].type).toBe('arrow_point');
});
it('should handle multi-numbered style definitons with more then 1 digit in a row', function() {
it('should handle multi-numbered style definitions with more then 1 digit in a row', function() {
const res = flow.parser.parse(
'graph TD\n' +
'A-->B1\n' +

6
src/diagrams/git/gitGraphParser.spec
View File

@@ -21,7 +21,7 @@ describe('when parsing a gitGraph', function() {
afterEach(function() {
cryptoRandomString.mockReset();
});
it('should handle a gitGraph defintion', function() {
it('should handle a gitGraph definition', function() {
const str = 'gitGraph:\n' + 'commit\n';
parser.parse(str);
@@ -33,7 +33,7 @@ describe('when parsing a gitGraph', function() {
expect(Object.keys(parser.yy.getBranches()).length).toBe(1);
});
it('should handle a gitGraph defintion with empty options', function() {
it('should handle a gitGraph definition with empty options', function() {
const str = 'gitGraph:\n' + 'options\n' + 'end\n' + 'commit\n';
parser.parse(str);
@@ -46,7 +46,7 @@ describe('when parsing a gitGraph', function() {
expect(Object.keys(parser.yy.getBranches()).length).toBe(1);
});
it('should handle a gitGraph defintion with valid options', function() {
it('should handle a gitGraph definition with valid options', function() {
const str = 'gitGraph:\n' + 'options\n' + '{"key": "value"}\n' + 'end\n' + 'commit\n';
parser.parse(str);