| 1 | > **Warning** |
| 2 | > |
| 3 | > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. |
| 4 | > |
| 5 | > ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/tidy-tree.md](../../packages/mermaid/src/docs/config/tidy-tree.md). |
| 6 | |
| 7 | # Tidy-tree Layout |
| 8 | |
| 9 | The **tidy-tree** layout arranges nodes in a hierarchical, tree-like structure. It is especially useful for diagrams where parent-child relationships are important, such as mindmaps. |
| 10 | |
| 11 | ## Features |
| 12 | |
| 13 | - Organizes nodes in a tidy, non-overlapping tree |
| 14 | - Ideal for mindmaps and hierarchical data |
| 15 | - Automatically adjusts spacing for readability |
| 16 | |
| 17 | ## Example Usage |
| 18 | |
| 19 | ```mermaid-example |
| 20 | --- |
| 21 | config: |
| 22 | layout: tidy-tree |
| 23 | --- |
| 24 | mindmap |
| 25 | root((mindmap is a long thing)) |
| 26 | A |
| 27 | B |
| 28 | C |
| 29 | D |
| 30 | ``` |
| 31 | |
| 32 | ```mermaid |
| 33 | --- |
| 34 | config: |
| 35 | layout: tidy-tree |
| 36 | --- |
| 37 | mindmap |
| 38 | root((mindmap is a long thing)) |
| 39 | A |
| 40 | B |
| 41 | C |
| 42 | D |
| 43 | ``` |
| 44 | |
| 45 | ```mermaid-example |
| 46 | --- |
| 47 | config: |
| 48 | layout: tidy-tree |
| 49 | --- |
| 50 | mindmap |
| 51 | root((mindmap)) |
| 52 | Origins |
| 53 | Long history |
| 54 | ::icon(fa fa-book) |
| 55 | Popularisation |
| 56 | British popular psychology author Tony Buzan |
| 57 | Research |
| 58 | On effectiveness<br/>and features |
| 59 | On Automatic creation |
| 60 | Uses |
| 61 | Creative techniques |
| 62 | Strategic planning |
| 63 | Argument mapping |
| 64 | ``` |
| 65 | |
| 66 | ```mermaid |
| 67 | --- |
| 68 | config: |
| 69 | layout: tidy-tree |
| 70 | --- |
| 71 | mindmap |
| 72 | root((mindmap)) |
| 73 | Origins |
| 74 | Long history |
| 75 | ::icon(fa fa-book) |
| 76 | Popularisation |
| 77 | British popular psychology author Tony Buzan |
| 78 | Research |
| 79 | On effectiveness<br/>and features |
| 80 | On Automatic creation |
| 81 | Uses |
| 82 | Creative techniques |
| 83 | Strategic planning |
| 84 | Argument mapping |
| 85 | ``` |
| 86 | |
| 87 | ## Note |
| 88 | |
| 89 | - Currently, tidy-tree is primarily supported for mindmap diagrams. |
| 90 | |