GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-14 06:43:25 +08:00
Code Issues Projects Releases Wiki Activity

update verbiage

Browse Source
This commit is contained in:
Steph 2023-12-28 11:34:46 -08:00
parent 60280361b0
commit 44dcac7501
2 changed files with 42 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/syntax/flowchart.md
View File

@ -11,6 +11,9 @@ Flowcharts are composed of **nodes** (geometric shapes) and **edges** (arrows or
> **Warning**
> If you are using the word "end" in a Flowchart node, capitalize the entire word or any of the letters (e.g., "End" or "END"), or apply this [workaround](https://github.com/mermaid-js/mermaid/issues/1444#issuecomment-639528897). Typing "end" in all lowercase letters will break the Flowchart.
> **Warning**
> If you are using the letter "o" as the first letter in a connecting Flowchart node, add a space before the letter or capitalize the letter "o" (e.g., "dev--- ops", "dev---Ops"). Typing "dev---ops" will create a [circle edge](#circle-edge-example). [Live Editor example](https://mermaid.live/edit#pako:eNpFjrEOwjAMRH-l8tz8QGbYYIENZbESh0ZK4ih1qFDVfycUEDf57p6lW8GyI9DgIy92wirD6WLy0OXooZTiMsMIiWrC4Dq3vksDMlEiA7qfjjy2KAZM3jqKTfj6zBa01EYjtOJQ6BDwXjGB9hjnnhbMN-a_JxeE6_mzZZ_0-zzuzRfcXhKpO50).
### A node (default)
```mermaid-example
@ -488,23 +491,38 @@ flowchart TB
B --> D
```
### New arrow types
## New arrow types
There are new types of arrows supported as per below:
There are new types of arrows supported:
- circle edge
- cross edge
### Circle edge example
```mermaid-example
flowchart LR
A --o B
B --x C
```
```mermaid
flowchart LR
A --o B
B --x C
```
### Multi directional arrows
### Cross edge example
```mermaid-example
flowchart LR
A --x B
```
```mermaid
flowchart LR
A --x B
```
## Multi directional arrows
There is the possibility to use multidirectional arrows.

23
packages/mermaid/src/docs/syntax/flowchart.md
View File

@ -11,6 +11,10 @@ Flowcharts are composed of **nodes** (geometric shapes) and **edges** (arrows or
If you are using the word "end" in a Flowchart node, capitalize the entire word or any of the letters (e.g., "End" or "END"), or apply this [workaround](https://github.com/mermaid-js/mermaid/issues/1444#issuecomment-639528897). Typing "end" in all lowercase letters will break the Flowchart.
```
```warning
If you are using the letter "o" as the first letter in a connecting Flowchart node, add a space before the letter or capitalize the letter "o" (e.g., "dev--- ops", "dev---Ops"). Typing "dev---ops" will create a [circle edge](#circle-edge-example). [Live Editor example](https://mermaid.live/edit#pako:eNpFjrEOwjAMRH-l8tz8QGbYYIENZbESh0ZK4ih1qFDVfycUEDf57p6lW8GyI9DgIy92wirD6WLy0OXooZTiMsMIiWrC4Dq3vksDMlEiA7qfjjy2KAZM3jqKTfj6zBa01EYjtOJQ6BDwXjGB9hjnnhbMN-a_JxeE6_mzZZ_0-zzuzRfcXhKpO50).
```
### A node (default)
```mermaid-example
@ -306,17 +310,28 @@ flowchart TB
B --> D
```
### New arrow types
## New arrow types
There are new types of arrows supported as per below:
There are new types of arrows supported:
- circle edge
- cross edge
### Circle edge example
```mermaid-example
flowchart LR
A --o B
B --x C
```
### Multi directional arrows
### Cross edge example
```mermaid-example
flowchart LR
A --x B
```
## Multi directional arrows
There is the possibility to use multidirectional arrows.