From cbb715a44df4c5a5d99d021a53969dfe131318a5 Mon Sep 17 00:00:00 2001 From: Nicolas Chang <25302138+NicolasCwy@users.noreply.github.com> Date: Tue, 27 Feb 2024 11:25:05 +0800 Subject: [PATCH 1/2] Amend docs to document gitgraph parallel commits --- docs/syntax/gitgraph.md | 57 ++++++++++++++++++++ packages/mermaid/src/docs/syntax/gitgraph.md | 33 ++++++++++++ 2 files changed, 90 insertions(+) diff --git a/docs/syntax/gitgraph.md b/docs/syntax/gitgraph.md index bf2927d39f..80c0e72fe6 100644 --- a/docs/syntax/gitgraph.md +++ b/docs/syntax/gitgraph.md @@ -419,6 +419,7 @@ In Mermaid, you have the option to configure the gitgraph diagram. You can confi - `showCommitLabel` : Boolean, default is `true`. If set to `false`, the commit labels are not shown in the diagram. - `mainBranchName` : String, default is `main`. The name of the default/root branch. - `mainBranchOrder` : Position of the main branch in the list of branches. default is `0`, meaning, by default `main` branch is the first in the order. +- `parallelCommits`: Boolean, default is `false`. If set to `true`, commits x distance away from the parent are shown at the same level in the diagram. Let's look at them one by one. @@ -915,6 +916,62 @@ Usage example: commit ``` +## Parallel commits (v10.8.0+) + +Commits in Mermaid display temporal information in gitgraph by default. For example if two commits are one commit away from its parent, the commit that was made earlier is rendered closer to its parent. You can turn this off by enabling the `parallelCommits` flag. + +### Temporal Commits (default, `parallelCommits: false`) + +```mermaid-example + %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': false}} }%% + gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit +``` + +```mermaid + %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': false}} }%% + gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit +``` + +### Parallel commits (`parallelCommits: true`) + +```mermaid-example + %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': true}} }%% + gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit +``` + +```mermaid + %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': true}} }%% + gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit +``` + ## Themes Mermaid supports a bunch of pre-defined themes which you can use to find the right one for you. PS: you can actually override an existing theme's variable to get your own custom theme going. Learn more about theming your diagram [here](../config/theming.md). diff --git a/packages/mermaid/src/docs/syntax/gitgraph.md b/packages/mermaid/src/docs/syntax/gitgraph.md index b09e1f1ab2..d8da3eb279 100644 --- a/packages/mermaid/src/docs/syntax/gitgraph.md +++ b/packages/mermaid/src/docs/syntax/gitgraph.md @@ -277,6 +277,7 @@ In Mermaid, you have the option to configure the gitgraph diagram. You can confi - `showCommitLabel` : Boolean, default is `true`. If set to `false`, the commit labels are not shown in the diagram. - `mainBranchName` : String, default is `main`. The name of the default/root branch. - `mainBranchOrder` : Position of the main branch in the list of branches. default is `0`, meaning, by default `main` branch is the first in the order. +- `parallelCommits`: Boolean, default is `false`. If set to `true`, commits x distance away from the parent are shown at the same level in the diagram. Let's look at them one by one. @@ -568,6 +569,38 @@ Usage example: commit ``` +## Parallel commits (v10.8.0+) + +Commits in Mermaid display temporal information in gitgraph by default. For example if two commits are one commit away from its parent, the commit that was made earlier is rendered closer to its parent. You can turn this off by enabling the `parallelCommits` flag. + +### Temporal Commits (default, `parallelCommits: false`) + +```mermaid-example + %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': false}} }%% + gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit +``` + +### Parallel commits (`parallelCommits: true`) + +```mermaid-example + %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': true}} }%% + gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit +``` + ## Themes Mermaid supports a bunch of pre-defined themes which you can use to find the right one for you. PS: you can actually override an existing theme's variable to get your own custom theme going. Learn more about theming your diagram [here](../config/theming.md). From 370cd98d2385068574484f1c71ce796ebd0d910a Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Tue, 27 Feb 2024 15:29:41 +0530 Subject: [PATCH 2/2] docs: Fix config --- docs/syntax/gitgraph.md | 88 ++++++++++++-------- packages/mermaid/src/docs/syntax/gitgraph.md | 44 ++++++---- 2 files changed, 78 insertions(+), 54 deletions(-) diff --git a/docs/syntax/gitgraph.md b/docs/syntax/gitgraph.md index 80c0e72fe6..099d90e5e2 100644 --- a/docs/syntax/gitgraph.md +++ b/docs/syntax/gitgraph.md @@ -923,53 +923,69 @@ Commits in Mermaid display temporal information in gitgraph by default. For exam ### Temporal Commits (default, `parallelCommits: false`) ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': false}} }%% - gitGraph: - commit - branch develop - commit - commit - checkout main - commit - commit +--- +config: + gitGraph: + parallelCommits: false +--- +gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit ``` ```mermaid - %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': false}} }%% - gitGraph: - commit - branch develop - commit - commit - checkout main - commit - commit +--- +config: + gitGraph: + parallelCommits: false +--- +gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit ``` ### Parallel commits (`parallelCommits: true`) ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': true}} }%% - gitGraph: - commit - branch develop - commit - commit - checkout main - commit - commit +--- +config: + gitGraph: + parallelCommits: true +--- +gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit ``` ```mermaid - %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': true}} }%% - gitGraph: - commit - branch develop - commit - commit - checkout main - commit - commit +--- +config: + gitGraph: + parallelCommits: true +--- +gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit ``` ## Themes diff --git a/packages/mermaid/src/docs/syntax/gitgraph.md b/packages/mermaid/src/docs/syntax/gitgraph.md index d8da3eb279..e7ffe6b8b7 100644 --- a/packages/mermaid/src/docs/syntax/gitgraph.md +++ b/packages/mermaid/src/docs/syntax/gitgraph.md @@ -576,29 +576,37 @@ Commits in Mermaid display temporal information in gitgraph by default. For exam ### Temporal Commits (default, `parallelCommits: false`) ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': false}} }%% - gitGraph: - commit - branch develop - commit - commit - checkout main - commit - commit +--- +config: + gitGraph: + parallelCommits: false +--- +gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit ``` ### Parallel commits (`parallelCommits: true`) ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'parallelCommits': true}} }%% - gitGraph: - commit - branch develop - commit - commit - checkout main - commit - commit +--- +config: + gitGraph: + parallelCommits: true +--- +gitGraph: + commit + branch develop + commit + commit + checkout main + commit + commit ``` ## Themes