mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-18 23:09:49 +02:00
Update docs
This commit is contained in:
@@ -827,18 +827,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
|
||||||
@@ -848,13 +849,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 +863,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:
|
||||||
|
|
||||||
@@ -876,7 +878,6 @@ Usage example:
|
|||||||
branch develop
|
branch develop
|
||||||
commit
|
commit
|
||||||
commit
|
commit
|
||||||
commit
|
|
||||||
checkout main
|
checkout main
|
||||||
commit
|
commit
|
||||||
commit
|
commit
|
||||||
@@ -892,7 +893,6 @@ Usage example:
|
|||||||
branch develop
|
branch develop
|
||||||
commit
|
commit
|
||||||
commit
|
commit
|
||||||
commit
|
|
||||||
checkout main
|
checkout main
|
||||||
commit
|
commit
|
||||||
commit
|
commit
|
||||||
|
Reference in New Issue
Block a user