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

Updated GitGraph doc amendment based on feedback in PR.

Browse Source
This commit is contained in:
Guy Pursey
2023-10-05 12:13:12 +01:00
parent 80af0e7ec7
commit 97487acbc3
2 changed files with 22 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/syntax/gitgraph.md
View File

@@ -827,9 +827,15 @@ Here, we have changed the default main branch name to `MetroLine1`.
## Orientation (v10.3.0+)
In Mermaid, the default orientation is for commits to run from **left to right** and for branches to be stacked on top of one another.
Mermaid supports two graph orientations: **Left-to-Right** (default) and **Top-to-Bottom**.
You can set this explicitly with `LR:` after `gitGraph`.
You can set this with either `LR:` (for [**Left-to-Right**](#left-to-right-default-lr)) or `TB:` (for [**Top-to-Bottom**](#top-to-bottom-tb)) after `gitGraph`.
### Left to Right (default, `LR:`)
In Mermaid, the default orientation is for commits to run from left to right and for branches to be stacked on top of one another.
However, you can set this explicitly with `LR:` after `gitGraph`.
Usage example:
@@ -863,11 +869,11 @@ Usage example:
commit
```
Sometimes, we may want to change the orientation of the graph.
### Top to Bottom (`TB:`)
Mermaid also supports a **top to bottom** orientation. In this mode, the commits run from top to bottom of the graph and branches are arranged side-by-side.
In `TB` (**Top-to-Bottom**) orientation, the commits run from top to bottom of the graph and branches are arranged side-by-side.
To orient the graph in this way, you need to add `TB:` after gitGraph.
To orient the graph this way, you need to add `TB:` after gitGraph.
Usage example:

16
packages/mermaid/src/docs/syntax/gitgraph.md
View File

@@ -513,9 +513,15 @@ Here, we have changed the default main branch name to `MetroLine1`.
## Orientation (v10.3.0+)
In Mermaid, the default orientation is for commits to run from **left to right** and for branches to be stacked on top of one another.
Mermaid supports two graph orientations: **Left-to-Right** (default) and **Top-to-Bottom**.
You can set this explicitly with `LR:` after `gitGraph`.
You can set this with either `LR:` (for [**Left-to-Right**](#left-to-right-default-lr)) or `TB:` (for [**Top-to-Bottom**](#top-to-bottom-tb)) after `gitGraph`.
### Left to Right (default, `LR:`)
In Mermaid, the default orientation is for commits to run from left to right and for branches to be stacked on top of one another.
However, you can set this explicitly with `LR:` after `gitGraph`.
Usage example:
@@ -534,11 +540,11 @@ Usage example:
commit
```
Sometimes, we may want to change the orientation of the graph.
### Top to Bottom (`TB:`)
Mermaid also supports a **top to bottom** orientation. In this mode, the commits run from top to bottom of the graph and branches are arranged side-by-side.
In `TB` (**Top-to-Bottom**) orientation, the commits run from top to bottom of the graph and branches are arranged side-by-side.
To orient the graph in this way, you need to add `TB:` after gitGraph.
To orient the graph this way, you need to add `TB:` after gitGraph.
Usage example: