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

Merge pull request #4897 from guypursey/patch-1

Browse Source 
Update notes on orientation in GitGraph documentation
This commit is contained in:
Nikolay Rozhkov 2023-10-06 10:07:36 +00:00 committed by GitHub
commit 12a47076cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/syntax/gitgraph.md
View File

@ -827,18 +827,25 @@ 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. Mermaid supports two graph orientations: **Left-to-Right** (default) and **Top-to-Bottom**.
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: 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
@ -848,13 +855,12 @@ Usage example:
``` ```
```mermaid ```mermaid
gitGraph gitGraph LR:
commit commit
commit commit
branch develop branch develop
commit commit
commit commit
commit
checkout main checkout main
commit commit
commit commit
@ -863,9 +869,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**. ### Top to Bottom (`TB:`)
In order to change the orientation from top to bottom i.e. branches lined horizontally, you need to add `TB` along with `gitGraph`. 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 this way, you need to add `TB:` after gitGraph.
Usage example: Usage example:
@ -876,7 +884,6 @@ Usage example:
branch develop branch develop
commit commit
commit commit
commit
checkout main checkout main
commit commit
commit commit
@ -892,7 +899,6 @@ Usage example:
branch develop branch develop
commit commit
commit commit
commit
checkout main checkout main
commit commit
commit commit

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

@ -513,18 +513,25 @@ 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. Mermaid supports two graph orientations: **Left-to-Right** (default) and **Top-to-Bottom**.
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: 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 +540,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**. ### Top to Bottom (`TB:`)
In order to change the orientation from top to bottom i.e. branches lined horizontally, you need to add `TB` along with `gitGraph`. 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 this way, you need to add `TB:` after gitGraph.
Usage example: Usage example:
@ -546,7 +555,6 @@ Usage example:
branch develop branch develop
commit commit
commit commit
commit
checkout main checkout main
commit commit
commit commit