Skip to content

Commit

Permalink
update verbiage
Browse files Browse the repository at this point in the history
  • Loading branch information
huynhicode committed Dec 28, 2023
1 parent 44dcac7 commit 5cec92c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
6 changes: 5 additions & 1 deletion docs/syntax/flowchart.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ 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).
> If you are using the letter "o" or "x" as the first letter in a connecting Flowchart node, add a space before the letter or capitalize the letter (e.g., "dev--- ops", "dev---Ops").
>
> Typing "A---oB" will create a [circle edge](#circle-edge-example).
>
> Typing "A---xB" will create a [cross edge](#cross-edge-example).
### A node (default)

Expand Down
6 changes: 5 additions & 1 deletion packages/mermaid/src/docs/syntax/flowchart.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ If you are using the word "end" in a Flowchart node, capitalize the entire word
```

```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).
If you are using the letter "o" or "x" as the first letter in a connecting Flowchart node, add a space before the letter or capitalize the letter (e.g., "dev--- ops", "dev---Ops").
Typing "A---oB" will create a [circle edge](#circle-edge-example).
Typing "A---xB" will create a [cross edge](#cross-edge-example).
```

### A node (default)
Expand Down

0 comments on commit 5cec92c

Please # to comment.