From f56895832fb6081b0373e87c6fa1b65647e3e1f9 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Wed, 16 Apr 2025 20:46:18 +0000 Subject: [PATCH] [autofix.ci] apply automated fixes --- docs/syntax/gitgraph.md | 428 +++++++++++++++++++++++++++++----------- 1 file changed, 314 insertions(+), 114 deletions(-) diff --git a/docs/syntax/gitgraph.md b/docs/syntax/gitgraph.md index 340a31695..05f465358 100644 --- a/docs/syntax/gitgraph.md +++ b/docs/syntax/gitgraph.md @@ -432,7 +432,13 @@ Sometimes you may want to hide the branch names and lines from the diagram. You Usage example: ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': false}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: false +--- gitGraph commit branch hotfix @@ -478,7 +484,13 @@ Usage example: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': false}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: false +--- gitGraph commit branch hotfix @@ -534,7 +546,13 @@ You can change the layout of the commit labels by using the `rotateCommitLabel` Usage example: Rotated commit labels ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'rotateCommitLabel': true}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + rotateCommitLabel: true +--- gitGraph commit id: "feat(api): ..." commit id: "a" @@ -553,7 +571,13 @@ gitGraph ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'rotateCommitLabel': true}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + rotateCommitLabel: true +--- gitGraph commit id: "feat(api): ..." commit id: "a" @@ -574,7 +598,13 @@ gitGraph Usage example: Horizontal commit labels ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'rotateCommitLabel': false}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + rotateCommitLabel: false +--- gitGraph commit id: "feat(api): ..." commit id: "a" @@ -593,7 +623,13 @@ gitGraph ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'rotateCommitLabel': false}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + rotateCommitLabel: false +--- gitGraph commit id: "feat(api): ..." commit id: "a" @@ -618,7 +654,14 @@ Sometimes you may want to hide the commit labels from the diagram. You can do th Usage example: ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': false,'showCommitLabel': false}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: false + showCommitLabel: false +--- gitGraph commit branch hotfix @@ -664,7 +707,14 @@ Usage example: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': false,'showCommitLabel': false}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: false + showCommitLabel: false +--- gitGraph commit branch hotfix @@ -716,7 +766,15 @@ Sometimes you may want to customize the name of the main/default branch. You can Usage example: ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': 'MetroLine1'}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: true + showCommitLabel: true + mainBranchName: 'MetroLine1' +--- gitGraph commit id:"NewYork" commit id:"Dallas" @@ -740,7 +798,15 @@ Usage example: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': 'MetroLine1'}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: true + showCommitLabel: true + mainBranchName: 'MetroLine1' +--- gitGraph commit id:"NewYork" commit id:"Dallas" @@ -782,7 +848,14 @@ To fully control the order of all the branches, you must define `order` for all Usage example: ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: true + showCommitLabel: true +--- gitGraph commit branch test1 order: 3 @@ -792,7 +865,14 @@ Usage example: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: true + showCommitLabel: true +--- gitGraph commit branch test1 order: 3 @@ -806,7 +886,15 @@ Look at the diagram, all the branches are following the order defined. Usage example: ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchOrder': 2}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: true + showCommitLabel: true + mainBranchOrder: 2 +--- gitGraph commit branch test1 order: 3 @@ -817,7 +905,15 @@ Usage example: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchOrder': 2}} }%% +--- +config: + logLevel: 'debug' + theme: 'base' + gitGraph: + showBranches: true + showCommitLabel: true + mainBranchOrder: 2 +--- gitGraph commit branch test1 order: 3 @@ -1046,7 +1142,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ### Base Theme ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'base' } }%% +--- +config: + logLevel: 'debug' + theme: 'base' +--- gitGraph commit branch hotfix @@ -1092,7 +1192,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'base' } }%% +--- +config: + logLevel: 'debug' + theme: 'base' +--- gitGraph commit branch hotfix @@ -1140,7 +1244,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ### Forest Theme ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'forest' } }%% +--- +config: + logLevel: 'debug' + theme: 'forest' +--- gitGraph commit branch hotfix @@ -1186,7 +1294,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'forest' } }%% +--- +config: + logLevel: 'debug' + theme: 'forest' +--- gitGraph commit branch hotfix @@ -1234,7 +1346,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ### Default Theme ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'default' } }%% +--- +config: + logLevel: 'debug' + theme: 'default' +--- gitGraph commit type:HIGHLIGHT branch hotfix @@ -1280,7 +1396,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'default' } }%% +--- +config: + logLevel: 'debug' + theme: 'default' +--- gitGraph commit type:HIGHLIGHT branch hotfix @@ -1328,7 +1448,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ### Dark Theme ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'dark' } }%% +--- +config: + logLevel: 'debug' + theme: 'dark' +--- gitGraph commit branch hotfix @@ -1374,7 +1498,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'dark' } }%% +--- +config: + logLevel: 'debug' + theme: 'dark' +--- gitGraph commit branch hotfix @@ -1422,7 +1550,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ### Neutral Theme ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'neutral' } }%% +--- +config: + logLevel: 'debug' + theme: 'neutral' +--- gitGraph commit branch hotfix @@ -1468,7 +1600,11 @@ Let's put them to use, and see how our sample diagram looks in different themes: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'neutral' } }%% +--- +config: + logLevel: 'debug' + theme: 'neutral' +--- gitGraph commit branch hotfix @@ -1522,7 +1658,11 @@ For understanding let us take a sample diagram with theme `default`, the default See how the default theme is used to set the colors for the branches: ```mermaid-example -%%{init: { 'logLevel': 'debug', 'theme': 'default' } }%% +--- +config: + logLevel: 'debug' + theme: 'default' +--- gitGraph commit branch develop @@ -1538,7 +1678,11 @@ See how the default theme is used to set the colors for the branches: ``` ```mermaid -%%{init: { 'logLevel': 'debug', 'theme': 'default' } }%% +--- +config: + logLevel: 'debug' + theme: 'default' +--- gitGraph commit branch develop @@ -1569,16 +1713,20 @@ Example: Now let's override the default values for the `git0` to `git3` variables: ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'git0': '#ff0000', - 'git1': '#00ff00', - 'git2': '#0000ff', - 'git3': '#ff00ff', - 'git4': '#00ffff', - 'git5': '#ffff00', - 'git6': '#ff00ff', - 'git7': '#00ffff' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + 'git0': '#ff0000' + 'git1': '#00ff00' + 'git2': '#0000ff' + 'git3': '#ff00ff' + 'git4': '#00ffff' + 'git5': '#ffff00' + 'git6': '#ff00ff' + 'git7': '#00ffff' +--- gitGraph commit branch develop @@ -1595,16 +1743,20 @@ Now let's override the default values for the `git0` to `git3` variables: ``` ```mermaid - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'git0': '#ff0000', - 'git1': '#00ff00', - 'git2': '#0000ff', - 'git3': '#ff00ff', - 'git4': '#00ffff', - 'git5': '#ffff00', - 'git6': '#ff00ff', - 'git7': '#00ffff' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + 'git0': '#ff0000' + 'git1': '#00ff00' + 'git2': '#0000ff' + 'git3': '#ff00ff' + 'git4': '#00ffff' + 'git5': '#ffff00' + 'git6': '#ff00ff' + 'git7': '#00ffff' +--- gitGraph commit branch develop @@ -1631,18 +1783,22 @@ Lets see how the default theme is used to set the colors for the branch labels: Now let's override the default values for the `gitBranchLabel0` to `gitBranchLabel2` variables: ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'gitBranchLabel0': '#ffffff', - 'gitBranchLabel1': '#ffffff', - 'gitBranchLabel2': '#ffffff', - 'gitBranchLabel3': '#ffffff', - 'gitBranchLabel4': '#ffffff', - 'gitBranchLabel5': '#ffffff', - 'gitBranchLabel6': '#ffffff', - 'gitBranchLabel7': '#ffffff', - 'gitBranchLabel8': '#ffffff', - 'gitBranchLabel9': '#ffffff' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + 'gitBranchLabel0': '#ffffff' + 'gitBranchLabel1': '#ffffff' + 'gitBranchLabel2': '#ffffff' + 'gitBranchLabel3': '#ffffff' + 'gitBranchLabel4': '#ffffff' + 'gitBranchLabel5': '#ffffff' + 'gitBranchLabel6': '#ffffff' + 'gitBranchLabel7': '#ffffff' + 'gitBranchLabel8': '#ffffff' + 'gitBranchLabel9': '#ffffff' +--- gitGraph checkout main branch branch1 @@ -1659,18 +1815,22 @@ Now let's override the default values for the `gitBranchLabel0` to `gitBranchLab ``` ```mermaid - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'gitBranchLabel0': '#ffffff', - 'gitBranchLabel1': '#ffffff', - 'gitBranchLabel2': '#ffffff', - 'gitBranchLabel3': '#ffffff', - 'gitBranchLabel4': '#ffffff', - 'gitBranchLabel5': '#ffffff', - 'gitBranchLabel6': '#ffffff', - 'gitBranchLabel7': '#ffffff', - 'gitBranchLabel8': '#ffffff', - 'gitBranchLabel9': '#ffffff' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + 'gitBranchLabel0': '#ffffff' + 'gitBranchLabel1': '#ffffff' + 'gitBranchLabel2': '#ffffff' + 'gitBranchLabel3': '#ffffff' + 'gitBranchLabel4': '#ffffff' + 'gitBranchLabel5': '#ffffff' + 'gitBranchLabel6': '#ffffff' + 'gitBranchLabel7': '#ffffff' + 'gitBranchLabel8': '#ffffff' + 'gitBranchLabel9': '#ffffff' +--- gitGraph checkout main branch branch1 @@ -1696,10 +1856,14 @@ Example: Now let's override the default values for the `commitLabelColor` to `commitLabelBackground` variables: ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'commitLabelColor': '#ff0000', - 'commitLabelBackground': '#00ff00' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + commitLabelColor: '#ff0000' + commitLabelBackground: '#00ff00' +--- gitGraph commit branch develop @@ -1716,10 +1880,14 @@ Now let's override the default values for the `commitLabelColor` to `commitLabel ``` ```mermaid - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'commitLabelColor': '#ff0000', - 'commitLabelBackground': '#00ff00' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + commitLabelColor: '#ff0000' + commitLabelBackground: '#00ff00' +--- gitGraph commit branch develop @@ -1745,11 +1913,15 @@ Example: Now let's override the default values for the `commitLabelFontSize` variable: ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'commitLabelColor': '#ff0000', - 'commitLabelBackground': '#00ff00', - 'commitLabelFontSize': '16px' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + commitLabelColor: '#ff0000' + commitLabelBackground: '#00ff00' + commitLabelFontSize: '16px' +--- gitGraph commit branch develop @@ -1766,11 +1938,15 @@ Now let's override the default values for the `commitLabelFontSize` variable: ``` ```mermaid - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'commitLabelColor': '#ff0000', - 'commitLabelBackground': '#00ff00', - 'commitLabelFontSize': '16px' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + commitLabelColor: '#ff0000' + commitLabelBackground: '#00ff00' + commitLabelFontSize: '16px' +--- gitGraph commit branch develop @@ -1796,11 +1972,15 @@ Example: Now let's override the default values for the `tagLabelFontSize` variable: ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'commitLabelColor': '#ff0000', - 'commitLabelBackground': '#00ff00', - 'tagLabelFontSize': '16px' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + commitLabelColor: '#ff0000' + commitLabelBackground: '#00ff00' + tagLabelFontSize: '16px' +--- gitGraph commit branch develop @@ -1817,11 +1997,15 @@ Now let's override the default values for the `tagLabelFontSize` variable: ``` ```mermaid - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'commitLabelColor': '#ff0000', - 'commitLabelBackground': '#00ff00', - 'tagLabelFontSize': '16px' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + commitLabelColor: '#ff0000' + commitLabelBackground: '#00ff00' + tagLabelFontSize: '16px' +--- gitGraph commit branch develop @@ -1846,11 +2030,15 @@ Example: Now let's override the default values for the `tagLabelColor`, `tagLabelBackground` and to `tagLabelBorder` variables: ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'tagLabelColor': '#ff0000', - 'tagLabelBackground': '#00ff00', - 'tagLabelBorder': '#0000ff' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + tagLabelColor: '#ff0000' + tagLabelBackground: '#00ff00' + tagLabelBorder: '#0000ff' +--- gitGraph commit branch develop @@ -1867,11 +2055,15 @@ Now let's override the default values for the `tagLabelColor`, `tagLabelBackgrou ``` ```mermaid - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'tagLabelColor': '#ff0000', - 'tagLabelBackground': '#00ff00', - 'tagLabelBorder': '#0000ff' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + tagLabelColor: '#ff0000' + tagLabelBackground: '#00ff00' + tagLabelBorder: '#0000ff' +--- gitGraph commit branch develop @@ -1898,9 +2090,13 @@ Example: Now let's override the default values for the `git0` to `git3` variables: ```mermaid-example - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'gitInv0': '#ff0000' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + 'gitInv0': '#ff0000' +--- gitGraph commit branch develop @@ -1917,9 +2113,13 @@ Now let's override the default values for the `git0` to `git3` variables: ``` ```mermaid - %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': { - 'gitInv0': '#ff0000' - } } }%% +--- +config: + logLevel: 'debug' + theme: 'default' + themeVariables: + 'gitInv0': '#ff0000' +--- gitGraph commit branch develop