marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-24 09:49:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: address review comments related to documentation

Browse Source 
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
This commit is contained in:
darshanr0107
2025-09-02 15:13:45 +05:30
parent fb20ee99eb
commit 494c7294cb
4 changed files with 85 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/config/layouts.md
View File

@@ -20,14 +20,20 @@ This page lists the available layout algorithms supported in Mermaid diagrams.
You can specify the layout in your diagram's YAML config or initialization options. For example: You can specify the layout in your diagram's YAML config or initialization options. For example:
```mermaid-example ```mermaid-example
%%{init: { 'layout': 'elk' }}%% ---
config:
layout: elk
---
graph TD; graph TD;
A-->B; A-->B;
B-->C; B-->C;
``` ```
```mermaid ```mermaid
%%{init: { 'layout': 'elk' }}%% ---
config:
layout: elk
---
graph TD; graph TD;
A-->B; A-->B;
B-->C; B-->C;

76
docs/config/tidy-tree.md
View File

@@ -16,7 +16,7 @@ The **tidy-tree** layout arranges nodes in a hierarchical, tree-like structure.
## Example Usage ## Example Usage
``` ```mermaid-example
--- ---
config: config:
layout: tidy-tree layout: tidy-tree
@@ -29,29 +29,59 @@ root((mindmap is a long thing))
D D
``` ```
```mermaid
---
config:
layout: tidy-tree
---
mindmap
root((mindmap is a long thing))
A
B
C
D
``` ```
---
config: ```mermaid-example
layout: tidy-tree ---
--- config:
mindmap layout: tidy-tree
root((mindmap)) ---
Origins mindmap
Long history root((mindmap))
::icon(fa fa-book) Origins
Popularisation Long history
British popular psychology author Tony Buzan ::icon(fa fa-book)
Research Popularisation
On effectiveness&lt;br/>and features British popular psychology author Tony Buzan
On Automatic creation Research
Uses On effectiveness<br/>and features
Creative techniques On Automatic creation
Strategic planning Uses
Argument mapping Creative techniques
Tools Strategic planning
id)I am a cloud( Argument mapping
id))I am a bang(( ```
Tools
```mermaid
---
config:
layout: tidy-tree
---
mindmap
root((mindmap))
Origins
Long history
::icon(fa fa-book)
Popularisation
British popular psychology author Tony Buzan
Research
On effectiveness<br/>and features
On Automatic creation
Uses
Creative techniques
Strategic planning
Argument mapping
``` ```
## Note ## Note

5
packages/mermaid/src/docs/config/layouts.md
View File

@@ -14,7 +14,10 @@ This page lists the available layout algorithms supported in Mermaid diagrams.
You can specify the layout in your diagram's YAML config or initialization options. For example: You can specify the layout in your diagram's YAML config or initialization options. For example:
```mermaid ```mermaid
%%{init: { 'layout': 'elk' }}%% ---
config:
layout: elk
---
graph TD; graph TD;
A-->B; A-->B;
B-->C; B-->C;

44
packages/mermaid/src/docs/config/tidy-tree.md
View File

@@ -10,7 +10,7 @@ The **tidy-tree** layout arranges nodes in a hierarchical, tree-like structure.
## Example Usage ## Example Usage
``` ```mermaid-example
--- ---
config: config:
layout: tidy-tree layout: tidy-tree
@@ -23,29 +23,25 @@ root((mindmap is a long thing))
D D
``` ```
``` ```mermaid-example
--- ---
config: config:
layout: tidy-tree layout: tidy-tree
--- ---
mindmap mindmap
root((mindmap)) root((mindmap))
Origins Origins
Long history Long history
::icon(fa fa-book) ::icon(fa fa-book)
Popularisation Popularisation
British popular psychology author Tony Buzan British popular psychology author Tony Buzan
Research Research
On effectiveness&lt;br/>and features On effectiveness<br/>and features
On Automatic creation On Automatic creation
Uses Uses
Creative techniques Creative techniques
Strategic planning Strategic planning
Argument mapping Argument mapping
Tools
id)I am a cloud(
id))I am a bang((
Tools
``` ```
## Note ## Note