GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-28 07:03:17 +08:00
Code Issues Projects Releases Wiki Activity

Update notes on orientation in GitGraph documentation

Browse Source 
Attempt to make the documentation around left-right and top-down orientation clearer than it currently is, addressing issue #4885.
This commit is contained in:
Guy Pursey 2023-10-03 17:53:46 +01:00
parent 1d9ce74f64
commit 395ee5ef06
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -513,18 +513,19 @@ Here, we have changed the default main branch name to `MetroLine1`.
## Orientation (v10.3.0+) ## Orientation (v10.3.0+)
In Mermaid, the default orientation is Left to Right. The branches are lined vertically. 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.
You can set this explicitly with `LR:` after `gitGraph`.
Usage example: Usage example:
```mermaid-example ```mermaid-example
gitGraph gitGraph LR:
commit commit
commit commit
branch develop branch develop
commit commit
commit commit
commit
checkout main checkout main
commit commit
commit commit
@ -533,9 +534,11 @@ Usage example:
commit commit
``` ```
Sometimes we may want to change the orientation. Currently, Mermaid supports two orientations: **Left to Right**(default) and **Top to Bottom**. Sometimes, we may want to change the orientation of the graph.
In order to change the orientation from top to bottom i.e. branches lined horizontally, you need to add `TB` along with `gitGraph`. 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.
To orient the graph in this way, you need to add `TB:` after gitGraph.
Usage example: Usage example:
@ -546,7 +549,6 @@ Usage example:
branch develop branch develop
commit commit
commit commit
commit
checkout main checkout main
commit commit
commit commit