Skip to content

Commit

Permalink
Update notes on orientation in GitGraph documentation
Browse files Browse the repository at this point in the history
Attempt to make the documentation around left-right and top-down orientation clearer than it currently is, addressing issue mermaid-js#4885.
  • Loading branch information
guypursey committed Oct 4, 2023
1 parent 1d9ce74 commit 395ee5e
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions packages/mermaid/src/docs/syntax/gitgraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -513,18 +513,19 @@ Here, we have changed the default main branch name to `MetroLine1`.

## 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:

```mermaid-example
gitGraph
gitGraph LR:
commit
commit
branch develop
commit
commit
commit
checkout main
commit
commit
Expand All @@ -533,9 +534,11 @@ Usage example:
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:

Expand All @@ -546,7 +549,6 @@ Usage example:
branch develop
commit
commit
commit
checkout main
commit
commit
Expand Down

0 comments on commit 395ee5e

Please sign in to comment.