| 6dd74de | | | 1 | > **Warning** |
| 6dd74de | | | 2 | > |
| 6dd74de | | | 3 | > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. |
| 6dd74de | | | 4 | > |
| 6dd74de | | | 5 | > ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/mindmap.md](../../packages/mermaid/src/docs/syntax/mindmap.md). |
| 6dd74de | | | 6 | |
| 6dd74de | | | 7 | # Mindmap |
| 6dd74de | | | 8 | |
| 6dd74de | | | 9 | > Mindmap: This is an experimental diagram for now. The syntax and properties can change in future releases. The syntax is stable except for the icon integration which is the experimental part. |
| 6dd74de | | | 10 | |
| 6dd74de | | | 11 | "A mind map is a diagram used to visually organize information into a hierarchy, showing relationships among pieces of the whole. It is often created around a single concept, drawn as an image in the center of a blank page, to which associated representations of ideas such as images, words and parts of words are added. Major ideas are connected directly to the central concept, and other ideas branch out from those major ideas." Wikipedia |
| 6dd74de | | | 12 | |
| 6dd74de | | | 13 | ### An example of a mindmap. |
| 6dd74de | | | 14 | |
| 6dd74de | | | 15 | ```mermaid-example |
| 6dd74de | | | 16 | mindmap |
| 6dd74de | | | 17 | root((mindmap)) |
| 6dd74de | | | 18 | Origins |
| 6dd74de | | | 19 | Long history |
| 6dd74de | | | 20 | ::icon(fa fa-book) |
| 6dd74de | | | 21 | Popularisation |
| 6dd74de | | | 22 | British popular psychology author Tony Buzan |
| 6dd74de | | | 23 | Research |
| 6dd74de | | | 24 | On effectiveness<br/>and features |
| 6dd74de | | | 25 | On Automatic creation |
| 6dd74de | | | 26 | Uses |
| 6dd74de | | | 27 | Creative techniques |
| 6dd74de | | | 28 | Strategic planning |
| 6dd74de | | | 29 | Argument mapping |
| 6dd74de | | | 30 | Tools |
| 6dd74de | | | 31 | Pen and paper |
| 6dd74de | | | 32 | Mermaid |
| 6dd74de | | | 33 | |
| 6dd74de | | | 34 | ``` |
| 6dd74de | | | 35 | |
| 6dd74de | | | 36 | ```mermaid |
| 6dd74de | | | 37 | mindmap |
| 6dd74de | | | 38 | root((mindmap)) |
| 6dd74de | | | 39 | Origins |
| 6dd74de | | | 40 | Long history |
| 6dd74de | | | 41 | ::icon(fa fa-book) |
| 6dd74de | | | 42 | Popularisation |
| 6dd74de | | | 43 | British popular psychology author Tony Buzan |
| 6dd74de | | | 44 | Research |
| 6dd74de | | | 45 | On effectiveness<br/>and features |
| 6dd74de | | | 46 | On Automatic creation |
| 6dd74de | | | 47 | Uses |
| 6dd74de | | | 48 | Creative techniques |
| 6dd74de | | | 49 | Strategic planning |
| 6dd74de | | | 50 | Argument mapping |
| 6dd74de | | | 51 | Tools |
| 6dd74de | | | 52 | Pen and paper |
| 6dd74de | | | 53 | Mermaid |
| 6dd74de | | | 54 | |
| 6dd74de | | | 55 | ``` |
| 6dd74de | | | 56 | |
| 6dd74de | | | 57 | ## Syntax |
| 6dd74de | | | 58 | |
| 6dd74de | | | 59 | The syntax for creating Mindmaps is simple and relies on indentation for setting the levels in the hierarchy. |
| 6dd74de | | | 60 | |
| 6dd74de | | | 61 | In the following example you can see how there are 3 different levels. One with starting at the left of the text and another level with two rows starting at the same column, defining the node A. At the end there is one more level where the text is indented further than the previous lines defining the nodes B and C. |
| 6dd74de | | | 62 | |
| 6dd74de | | | 63 | ``` |
| 6dd74de | | | 64 | mindmap |
| 6dd74de | | | 65 | Root |
| 6dd74de | | | 66 | A |
| 6dd74de | | | 67 | B |
| 6dd74de | | | 68 | C |
| 6dd74de | | | 69 | ``` |
| 6dd74de | | | 70 | |
| 6dd74de | | | 71 | In summary is a simple text outline where there is one node at the root level called `Root` which has one child `A`. `A` in turn has two children `B`and `C`. In the diagram below we can see this rendered as a mindmap. |
| 6dd74de | | | 72 | |
| 6dd74de | | | 73 | ```mermaid-example |
| 6dd74de | | | 74 | mindmap |
| 6dd74de | | | 75 | Root |
| 6dd74de | | | 76 | A |
| 6dd74de | | | 77 | B |
| 6dd74de | | | 78 | C |
| 6dd74de | | | 79 | ``` |
| 6dd74de | | | 80 | |
| 6dd74de | | | 81 | ```mermaid |
| 6dd74de | | | 82 | mindmap |
| 6dd74de | | | 83 | Root |
| 6dd74de | | | 84 | A |
| 6dd74de | | | 85 | B |
| 6dd74de | | | 86 | C |
| 6dd74de | | | 87 | ``` |
| 6dd74de | | | 88 | |
| 6dd74de | | | 89 | In this way we can use a text outline to generate a hierarchical mindmap. |
| 6dd74de | | | 90 | |
| 6dd74de | | | 91 | ## Different shapes |
| 6dd74de | | | 92 | |
| 6dd74de | | | 93 | Mermaid mindmaps can show nodes using different shapes. When specifying a shape for a node the syntax is similar to flowchart nodes, with an id followed by the shape definition and with the text within the shape delimiters. Where possible we try/will try to keep the same shapes as for flowcharts, even though they are not all supported from the start. |
| 6dd74de | | | 94 | |
| 6dd74de | | | 95 | Mindmap can show the following shapes: |
| 6dd74de | | | 96 | |
| 6dd74de | | | 97 | ### Square |
| 6dd74de | | | 98 | |
| 6dd74de | | | 99 | ```mermaid-example |
| 6dd74de | | | 100 | mindmap |
| 6dd74de | | | 101 | id[I am a square] |
| 6dd74de | | | 102 | ``` |
| 6dd74de | | | 103 | |
| 6dd74de | | | 104 | ```mermaid |
| 6dd74de | | | 105 | mindmap |
| 6dd74de | | | 106 | id[I am a square] |
| 6dd74de | | | 107 | ``` |
| 6dd74de | | | 108 | |
| 6dd74de | | | 109 | ### Rounded square |
| 6dd74de | | | 110 | |
| 6dd74de | | | 111 | ```mermaid-example |
| 6dd74de | | | 112 | mindmap |
| 6dd74de | | | 113 | id(I am a rounded square) |
| 6dd74de | | | 114 | ``` |
| 6dd74de | | | 115 | |
| 6dd74de | | | 116 | ```mermaid |
| 6dd74de | | | 117 | mindmap |
| 6dd74de | | | 118 | id(I am a rounded square) |
| 6dd74de | | | 119 | ``` |
| 6dd74de | | | 120 | |
| 6dd74de | | | 121 | ### Circle |
| 6dd74de | | | 122 | |
| 6dd74de | | | 123 | ```mermaid-example |
| 6dd74de | | | 124 | mindmap |
| 6dd74de | | | 125 | id((I am a circle)) |
| 6dd74de | | | 126 | ``` |
| 6dd74de | | | 127 | |
| 6dd74de | | | 128 | ```mermaid |
| 6dd74de | | | 129 | mindmap |
| 6dd74de | | | 130 | id((I am a circle)) |
| 6dd74de | | | 131 | ``` |
| 6dd74de | | | 132 | |
| 6dd74de | | | 133 | ### Bang |
| 6dd74de | | | 134 | |
| 6dd74de | | | 135 | ```mermaid-example |
| 6dd74de | | | 136 | mindmap |
| 6dd74de | | | 137 | id))I am a bang(( |
| 6dd74de | | | 138 | ``` |
| 6dd74de | | | 139 | |
| 6dd74de | | | 140 | ```mermaid |
| 6dd74de | | | 141 | mindmap |
| 6dd74de | | | 142 | id))I am a bang(( |
| 6dd74de | | | 143 | ``` |
| 6dd74de | | | 144 | |
| 6dd74de | | | 145 | ### Cloud |
| 6dd74de | | | 146 | |
| 6dd74de | | | 147 | ```mermaid-example |
| 6dd74de | | | 148 | mindmap |
| 6dd74de | | | 149 | id)I am a cloud( |
| 6dd74de | | | 150 | ``` |
| 6dd74de | | | 151 | |
| 6dd74de | | | 152 | ```mermaid |
| 6dd74de | | | 153 | mindmap |
| 6dd74de | | | 154 | id)I am a cloud( |
| 6dd74de | | | 155 | ``` |
| 6dd74de | | | 156 | |
| 6dd74de | | | 157 | ### Hexagon |
| 6dd74de | | | 158 | |
| 6dd74de | | | 159 | ```mermaid-example |
| 6dd74de | | | 160 | mindmap |
| 6dd74de | | | 161 | id{{I am a hexagon}} |
| 6dd74de | | | 162 | ``` |
| 6dd74de | | | 163 | |
| 6dd74de | | | 164 | ```mermaid |
| 6dd74de | | | 165 | mindmap |
| 6dd74de | | | 166 | id{{I am a hexagon}} |
| 6dd74de | | | 167 | ``` |
| 6dd74de | | | 168 | |
| 6dd74de | | | 169 | ### Default |
| 6dd74de | | | 170 | |
| 6dd74de | | | 171 | ```mermaid-example |
| 6dd74de | | | 172 | mindmap |
| 6dd74de | | | 173 | I am the default shape |
| 6dd74de | | | 174 | ``` |
| 6dd74de | | | 175 | |
| 6dd74de | | | 176 | ```mermaid |
| 6dd74de | | | 177 | mindmap |
| 6dd74de | | | 178 | I am the default shape |
| 6dd74de | | | 179 | ``` |
| 6dd74de | | | 180 | |
| 6dd74de | | | 181 | More shapes will be added, beginning with the shapes available in flowcharts. |
| 6dd74de | | | 182 | |
| 6dd74de | | | 183 | # Icons and classes |
| 6dd74de | | | 184 | |
| 6dd74de | | | 185 | ## Icons |
| 6dd74de | | | 186 | |
| 6dd74de | | | 187 | As with flowcharts you can add icons to your nodes but with an updated syntax. The styling for the font based icons are added during the integration so that they are available for the web page. _This is not something a diagram author can do but has to be done with the site administrator or the integrator_. Once the icon fonts are in place you add them to the mind map nodes using the `::icon()` syntax. You place the classes for the icon within the parenthesis like in the following example where icons for material design and [Font Awesome 5](https://fontawesome.com/v5/search?o=r&m=free) are displayed. The intention is that this approach should be used for all diagrams supporting icons. **Experimental feature:** This wider scope is also the reason Mindmaps are experimental as this syntax and approach could change. |
| 6dd74de | | | 188 | |
| 6dd74de | | | 189 | ```mermaid-example |
| 6dd74de | | | 190 | mindmap |
| 6dd74de | | | 191 | Root |
| 6dd74de | | | 192 | A |
| 6dd74de | | | 193 | ::icon(fa fa-book) |
| 6dd74de | | | 194 | B(B) |
| 6dd74de | | | 195 | ::icon(mdi mdi-skull-outline) |
| 6dd74de | | | 196 | ``` |
| 6dd74de | | | 197 | |
| 6dd74de | | | 198 | ```mermaid |
| 6dd74de | | | 199 | mindmap |
| 6dd74de | | | 200 | Root |
| 6dd74de | | | 201 | A |
| 6dd74de | | | 202 | ::icon(fa fa-book) |
| 6dd74de | | | 203 | B(B) |
| 6dd74de | | | 204 | ::icon(mdi mdi-skull-outline) |
| 6dd74de | | | 205 | ``` |
| 6dd74de | | | 206 | |
| 6dd74de | | | 207 | ## Classes |
| 6dd74de | | | 208 | |
| 6dd74de | | | 209 | Again the syntax for adding classes is similar to flowcharts. You can add classes using a triple colon following a number of css classes separated by space. In the following example one of the nodes has two custom classes attached urgent turning the background red and the text white and large increasing the font size: |
| 6dd74de | | | 210 | |
| 6dd74de | | | 211 | ```mermaid-example |
| 6dd74de | | | 212 | mindmap |
| 6dd74de | | | 213 | Root |
| 6dd74de | | | 214 | A[A] |
| 6dd74de | | | 215 | :::urgent large |
| 6dd74de | | | 216 | B(B) |
| 6dd74de | | | 217 | C |
| 6dd74de | | | 218 | ``` |
| 6dd74de | | | 219 | |
| 6dd74de | | | 220 | ```mermaid |
| 6dd74de | | | 221 | mindmap |
| 6dd74de | | | 222 | Root |
| 6dd74de | | | 223 | A[A] |
| 6dd74de | | | 224 | :::urgent large |
| 6dd74de | | | 225 | B(B) |
| 6dd74de | | | 226 | C |
| 6dd74de | | | 227 | ``` |
| 6dd74de | | | 228 | |
| 6dd74de | | | 229 | _These classes need to be supplied by the site administrator._ |
| 6dd74de | | | 230 | |
| 6dd74de | | | 231 | ## Unclear indentation |
| 6dd74de | | | 232 | |
| 6dd74de | | | 233 | The actual indentation does not really matter only compared with the previous rows. If we take the previous example and disrupt it a little we can see how the calculations are performed. Let us start with placing C with a smaller indentation than `B` but larger then `A`. |
| 6dd74de | | | 234 | |
| 6dd74de | | | 235 | ``` |
| 6dd74de | | | 236 | mindmap |
| 6dd74de | | | 237 | Root |
| 6dd74de | | | 238 | A |
| 6dd74de | | | 239 | B |
| 6dd74de | | | 240 | C |
| 6dd74de | | | 241 | ``` |
| 6dd74de | | | 242 | |
| 6dd74de | | | 243 | This outline is unclear as `B` clearly is a child of `A` but when we move on to `C` the clarity is lost. `C` is neither a child of `B` with a higher indentation nor does it have the same indentation as `B`. The only thing that is clear is that the first node with smaller indentation, indicating a parent, is A. Then Mermaid relies on this known truth and compensates for the unclear indentation and selects `A` as a parent of `C` leading till the same diagram with `B` and `C` as siblings. |
| 6dd74de | | | 244 | |
| 6dd74de | | | 245 | ```mermaid-example |
| 6dd74de | | | 246 | mindmap |
| 6dd74de | | | 247 | Root |
| 6dd74de | | | 248 | A |
| 6dd74de | | | 249 | B |
| 6dd74de | | | 250 | C |
| 6dd74de | | | 251 | ``` |
| 6dd74de | | | 252 | |
| 6dd74de | | | 253 | ```mermaid |
| 6dd74de | | | 254 | mindmap |
| 6dd74de | | | 255 | Root |
| 6dd74de | | | 256 | A |
| 6dd74de | | | 257 | B |
| 6dd74de | | | 258 | C |
| 6dd74de | | | 259 | ``` |
| 6dd74de | | | 260 | |
| 6dd74de | | | 261 | ## Markdown Strings |
| 6dd74de | | | 262 | |
| 6dd74de | | | 263 | The "Markdown Strings" feature enhances mind maps by offering a more versatile string type, which supports text formatting options such as bold and italics, and automatically wraps text within labels. |
| 6dd74de | | | 264 | |
| 6dd74de | | | 265 | ```mermaid-example |
| 6dd74de | | | 266 | mindmap |
| 6dd74de | | | 267 | id1["`**Root** with |
| 6dd74de | | | 268 | a second line |
| 6dd74de | | | 269 | Unicode works too: 🤓`"] |
| 6dd74de | | | 270 | id2["`The dog in **the** hog... a *very long text* that wraps to a new line`"] |
| 6dd74de | | | 271 | id3[Regular labels still works] |
| 6dd74de | | | 272 | ``` |
| 6dd74de | | | 273 | |
| 6dd74de | | | 274 | ```mermaid |
| 6dd74de | | | 275 | mindmap |
| 6dd74de | | | 276 | id1["`**Root** with |
| 6dd74de | | | 277 | a second line |
| 6dd74de | | | 278 | Unicode works too: 🤓`"] |
| 6dd74de | | | 279 | id2["`The dog in **the** hog... a *very long text* that wraps to a new line`"] |
| 6dd74de | | | 280 | id3[Regular labels still works] |
| 6dd74de | | | 281 | ``` |
| 6dd74de | | | 282 | |
| 6dd74de | | | 283 | Formatting: |
| 6dd74de | | | 284 | |
| 6dd74de | | | 285 | - For bold text, use double asterisks \*\* before and after the text. |
| 6dd74de | | | 286 | - For italics, use single asterisks \* before and after the text. |
| 6dd74de | | | 287 | - With traditional strings, you needed to add <br> tags for text to wrap in nodes. However, markdown strings automatically wrap text when it becomes too long and allows you to start a new line by simply using a newline character instead of a <br> tag. |
| 6dd74de | | | 288 | |
| 6dd74de | | | 289 | ## Integrating with your library/website. |
| 6dd74de | | | 290 | |
| 6dd74de | | | 291 | Mindmap uses the experimental lazy loading & async rendering features which could change in the future. From version 9.4.0 this diagram is included in mermaid but use lazy loading in order to keep the size of mermaid down. This is important in order to be able to add additional diagrams going forward. |
| 6dd74de | | | 292 | |
| 6dd74de | | | 293 | You can still use the pre 9.4.0 method to add mermaid with mindmaps to a web page: |
| 6dd74de | | | 294 | |
| 6dd74de | | | 295 | ```html |
| 6dd74de | | | 296 | <script type="module"> |
| 6dd74de | | | 297 | import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@9.3.0/dist/mermaid.esm.min.mjs'; |
| 6dd74de | | | 298 | import mindmap from 'https://cdn.jsdelivr.net/npm/@mermaid-js/mermaid-mindmap@9.3.0/dist/mermaid-mindmap.esm.min.mjs'; |
| 6dd74de | | | 299 | await mermaid.registerExternalDiagrams([mindmap]); |
| 6dd74de | | | 300 | </script> |
| 6dd74de | | | 301 | ``` |
| 6dd74de | | | 302 | |
| 6dd74de | | | 303 | From version 9.4.0 you can simplify this code to: |
| 6dd74de | | | 304 | |
| 6dd74de | | | 305 | ```html |
| 6dd74de | | | 306 | <script type="module"> |
| 6dd74de | | | 307 | import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs'; |
| 6dd74de | | | 308 | </script> |
| 6dd74de | | | 309 | ``` |
| 6dd74de | | | 310 | |
| 6dd74de | | | 311 | You can also refer the [implementation in the live editor](https://github.com/mermaid-js/mermaid-live-editor/blob/develop/src/lib/util/mermaid.ts) to see how the async loading is done. |
| 6dd74de | | | 312 | |
| 6dd74de | | | 313 | <!--- |
| 6dd74de | | | 314 | cspell:locale en,en-gb |
| 6dd74de | | | 315 | cspell:ignore Buzan |
| 6dd74de | | | 316 | ---> |
| 6dd74de | | | 317 | |
| 6dd74de | | | 318 | ## Layouts |
| 6dd74de | | | 319 | |
| 6dd74de | | | 320 | Mermaid also supports a Tidy Tree layout for mindmaps. |
| 6dd74de | | | 321 | |
| 6dd74de | | | 322 | ``` |
| 6dd74de | | | 323 | --- |
| 6dd74de | | | 324 | config: |
| 6dd74de | | | 325 | layout: tidy-tree |
| 6dd74de | | | 326 | --- |
| 6dd74de | | | 327 | mindmap |
| 6dd74de | | | 328 | root((mindmap is a long thing)) |
| 6dd74de | | | 329 | A |
| 6dd74de | | | 330 | B |
| 6dd74de | | | 331 | C |
| 6dd74de | | | 332 | D |
| 6dd74de | | | 333 | ``` |
| 6dd74de | | | 334 | |
| 6dd74de | | | 335 | Instructions to add and register tidy-tree layout are present in [Tidy Tree Configuration](/config/tidy-tree) |