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

fix: Typo for documents and comments

Browse Source
This commit is contained in:
yutotnh
2022-06-22 12:39:10 +09:00
parent 566ec14648
commit ca909edbed
29 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Setup.md
View File

@@ -118,7 +118,7 @@ Default value: ['secure', 'securityLevel', 'startOnLoad', 'maxTextSize']
This option controls if the generated ids of nodes in the SVG are generated randomly or based
on a seed. If set to false, the IDs are generated based on the current date and thus are not
deterministic. This is the default behaviour.
deterministic. This is the default behavior.
**Notes**:

2
docs/c4c.md
View File

@@ -5,7 +5,7 @@
Mermaid's c4 diagram sytax is compatible with plantUML. See example below:
Mermaid's c4 diagram syntax is compatible with plantUML. See example below:
```mermaid-example
C4Context

6
docs/gitgraph.md
View File

@@ -189,12 +189,12 @@ To use the `cherry-pick` keyword, you must specify the id using the `id` attrib
`cherry-pick id: "your_custom_id"`
Here, a new commt representing the cherry pick is created on the current branch, and is visually highlighted in the diagram with a **cherry** and a tag depicting the commit id from which it is cherry picked from.
Here, a new commit representing the cherry pick is created on the current branch, and is visually highlighted in the diagram with a **cherry** and a tag depicting the commit id from which it is cherry picked from.
Few Important rules to note here are:
1. You need to provide the `id` for an existing commit to be cherry picked. If given commit id does not exist it will result in an error. For this make use of the `commit id:$value` format of declaring commits. See the examples from above.
2. The given commit must not exist on the current branch. Cherry picked commit must always be a different branch than the current branch.
3. Current branch must have atleast one commit, before you can cherry pick a commit, otherwise it will case an error is throw.
3. Current branch must have at least one commit, before you can cherry pick a commit, otherwise it will cause an error is throw.
Let see an example:
```mermaid-example
@@ -272,7 +272,7 @@ Usage example:
```
## Commit labels Layout: Rotated or Horizontal
Mermaid supports two types of commit labels layout. The default layout is **rotated**, which means the labels are placed below the commit circle, rotated at 45 degress for better readability. This is particularly useful for commits with long labels.
Mermaid supports two types of commit labels layout. The default layout is **rotated**, which means the labels are placed below the commit circle, rotated at 45 degrees for better readability. This is particularly useful for commits with long labels.
The other option is **horizontal**, which means the labels are placed below the commit circle centred horizontally, and are not rotated. This is particularly useful for commits with short labels.

6
docs/newDiagram.md
View File

@@ -110,7 +110,7 @@ Look at `graphDb.js` for more details on that object.
## Layout
If you are using a dagre based layout, please use flowchart-v2 as a template and by doing that you will be using dagre-wrapper instead of dagreD3 which we are m igrating away from.
If you are using a dagre based layout, please use flowchart-v2 as a template and by doing that you will be using dagre-wrapper instead of dagreD3 which we are migrating away from.
### Common parts of a diagram
@@ -129,7 +129,7 @@ Here is example handling from flowcharts:
Jison:
```jison
/* lexial grammar */
/* lexical grammar */
%lex
%x open_directive
%x type_directive
@@ -175,7 +175,7 @@ It is probably a good idea to keep the handling similar to this in your new diag
The syntax for adding title and description looks like this:
```
accTitle: The title
accDescr: The dsscription
accDescr: The description
accDescr {
Syntax for a description text