mirror of
				https://github.com/mermaid-js/mermaid.git
				synced 2025-11-03 20:34:20 +01:00 
			
		
		
		
	chore: address review comments related to documentation
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
This commit is contained in:
		@@ -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:
 | 
			
		||||
 | 
			
		||||
```mermaid-example
 | 
			
		||||
%%{init: { 'layout': 'elk' }}%%
 | 
			
		||||
---
 | 
			
		||||
config:
 | 
			
		||||
  layout: elk
 | 
			
		||||
---
 | 
			
		||||
graph TD;
 | 
			
		||||
  A-->B;
 | 
			
		||||
  B-->C;
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```mermaid
 | 
			
		||||
%%{init: { 'layout': 'elk' }}%%
 | 
			
		||||
---
 | 
			
		||||
config:
 | 
			
		||||
  layout: elk
 | 
			
		||||
---
 | 
			
		||||
graph TD;
 | 
			
		||||
  A-->B;
 | 
			
		||||
  B-->C;
 | 
			
		||||
 
 | 
			
		||||
@@ -16,7 +16,7 @@ The **tidy-tree** layout arranges nodes in a hierarchical, tree-like structure.
 | 
			
		||||
 | 
			
		||||
## Example Usage
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
```mermaid-example
 | 
			
		||||
---
 | 
			
		||||
config:
 | 
			
		||||
  layout: tidy-tree
 | 
			
		||||
@@ -29,29 +29,59 @@ root((mindmap is a long thing))
 | 
			
		||||
  D
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```mermaid
 | 
			
		||||
---
 | 
			
		||||
config:
 | 
			
		||||
  layout: tidy-tree
 | 
			
		||||
---
 | 
			
		||||
mindmap
 | 
			
		||||
root((mindmap is a long thing))
 | 
			
		||||
  A
 | 
			
		||||
  B
 | 
			
		||||
  C
 | 
			
		||||
  D
 | 
			
		||||
```
 | 
			
		||||
 ---
 | 
			
		||||
      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
 | 
			
		||||
        Tools
 | 
			
		||||
              id)I am a cloud(
 | 
			
		||||
                  id))I am a bang((
 | 
			
		||||
                    Tools
 | 
			
		||||
 | 
			
		||||
```mermaid-example
 | 
			
		||||
---
 | 
			
		||||
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
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```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
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user