Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: update Flowchart page #5169

Merged
merged 2 commits into from
Jan 11, 2024
Merged

DOCS: update Flowchart page #5169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44dcac7
update verbiage
huynhicode Dec 28, 2023
5cec92c
update verbiage
huynhicode Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions docs/syntax/flowchart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ 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" 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)

```mermaid-example
Expand Down Expand Up @@ -488,23 +495,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.

Expand Down
27 changes: 23 additions & 4 deletions packages/mermaid/src/docs/syntax/flowchart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ 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" 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)

```mermaid-example
Expand Down Expand Up @@ -306,17 +314,28 @@ flowchart TB
B --> D
```

### New arrow types
## New arrow types

There are new types of arrows supported:

There are new types of arrows supported as per below:
- 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.

Expand Down
Loading