@groupby/ai-dev 0.5.10 → 0.5.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/package.json +1 -1
  2. package/teams/fhr-neowise/commands/address-pr.md +120 -0
  3. package/teams/fhr-neowise/commands/ready-pr.md +70 -0
  4. package/teams/fhr-neowise/commands/review-pr.md +111 -0
  5. package/teams/fhr-neowise/commands/tdd-implementation.md +86 -0
  6. package/teams/fhr-neowise/commands/write-plan.md +23 -0
  7. package/teams/fhr-neowise/commands/write-pr.md +21 -0
  8. package/teams/fhr-neowise/commands/write-spec.md +25 -0
  9. package/teams/fhr-neowise/skills/agent-routing/SKILL.md +72 -0
  10. package/teams/fhr-neowise/skills/code-review/SKILL.md +83 -0
  11. package/teams/fhr-neowise/skills/code-review/review-template.md +90 -0
  12. package/teams/fhr-neowise/skills/mermaid-diagram/SKILL.md +94 -0
  13. package/teams/fhr-neowise/skills/mermaid-diagram/references/BEST_PRACTICES.md +96 -0
  14. package/teams/fhr-neowise/skills/mermaid-diagram/references/architecture.md +434 -0
  15. package/teams/fhr-neowise/skills/mermaid-diagram/references/block.md +753 -0
  16. package/teams/fhr-neowise/skills/mermaid-diagram/references/c4.md +619 -0
  17. package/teams/fhr-neowise/skills/mermaid-diagram/references/classDiagram.md +1186 -0
  18. package/teams/fhr-neowise/skills/mermaid-diagram/references/config-configuration.md +72 -0
  19. package/teams/fhr-neowise/skills/mermaid-diagram/references/config-directives.md +342 -0
  20. package/teams/fhr-neowise/skills/mermaid-diagram/references/config-layouts.md +40 -0
  21. package/teams/fhr-neowise/skills/mermaid-diagram/references/config-math.md +96 -0
  22. package/teams/fhr-neowise/skills/mermaid-diagram/references/config-theming.md +246 -0
  23. package/teams/fhr-neowise/skills/mermaid-diagram/references/config-tidy-tree.md +89 -0
  24. package/teams/fhr-neowise/skills/mermaid-diagram/references/cynefin.md +279 -0
  25. package/teams/fhr-neowise/skills/mermaid-diagram/references/entityRelationshipDiagram.md +670 -0
  26. package/teams/fhr-neowise/skills/mermaid-diagram/references/eventmodeling.md +475 -0
  27. package/teams/fhr-neowise/skills/mermaid-diagram/references/examples.md +301 -0
  28. package/teams/fhr-neowise/skills/mermaid-diagram/references/flowchart.md +2116 -0
  29. package/teams/fhr-neowise/skills/mermaid-diagram/references/gantt.md +725 -0
  30. package/teams/fhr-neowise/skills/mermaid-diagram/references/gitgraph.md +2138 -0
  31. package/teams/fhr-neowise/skills/mermaid-diagram/references/ishikawa.md +66 -0
  32. package/teams/fhr-neowise/skills/mermaid-diagram/references/kanban.md +161 -0
  33. package/teams/fhr-neowise/skills/mermaid-diagram/references/mindmap.md +335 -0
  34. package/teams/fhr-neowise/skills/mermaid-diagram/references/packet.md +153 -0
  35. package/teams/fhr-neowise/skills/mermaid-diagram/references/pie.md +93 -0
  36. package/teams/fhr-neowise/skills/mermaid-diagram/references/quadrantChart.md +267 -0
  37. package/teams/fhr-neowise/skills/mermaid-diagram/references/radar.md +269 -0
  38. package/teams/fhr-neowise/skills/mermaid-diagram/references/railroad.md +337 -0
  39. package/teams/fhr-neowise/skills/mermaid-diagram/references/requirementDiagram.md +495 -0
  40. package/teams/fhr-neowise/skills/mermaid-diagram/references/sankey.md +415 -0
  41. package/teams/fhr-neowise/skills/mermaid-diagram/references/sequenceDiagram.md +1195 -0
  42. package/teams/fhr-neowise/skills/mermaid-diagram/references/stateDiagram.md +670 -0
  43. package/teams/fhr-neowise/skills/mermaid-diagram/references/timeline.md +571 -0
  44. package/teams/fhr-neowise/skills/mermaid-diagram/references/treeView.md +321 -0
  45. package/teams/fhr-neowise/skills/mermaid-diagram/references/treemap.md +353 -0
  46. package/teams/fhr-neowise/skills/mermaid-diagram/references/userJourney.md +42 -0
  47. package/teams/fhr-neowise/skills/mermaid-diagram/references/venn.md +134 -0
  48. package/teams/fhr-neowise/skills/mermaid-diagram/references/wardley.md +732 -0
  49. package/teams/fhr-neowise/skills/mermaid-diagram/references/xyChart.md +312 -0
  50. package/teams/fhr-neowise/skills/mermaid-diagram/references/zenuml.md +474 -0
  51. package/teams/fhr-neowise/skills/mermaid-diagram/scripts/sync_docs.py +138 -0
  52. package/teams/fhr-neowise/skills/pull-request-authoring/COMPLEX.template.md +52 -0
  53. package/teams/fhr-neowise/skills/pull-request-authoring/NON-CODE.template.md +15 -0
  54. package/teams/fhr-neowise/skills/pull-request-authoring/SIMPLE.template.md +20 -0
  55. package/teams/fhr-neowise/skills/pull-request-authoring/SKILL.md +102 -0
  56. package/teams/fhr-neowise/skills/spec-investigation/SKILL.md +139 -0
  57. package/teams/fhr-neowise/skills/spec-investigation/TEMPLATE.spec.md +74 -0
  58. package/teams/fhr-neowise/skills/tdd-workflow/SKILL.md +137 -0
  59. package/teams/fhr-neowise/skills/write-plan/SKILL.md +285 -0
  60. package/teams/fhr-neowise/skills/write-plan/assets/TEMPLATE.checklist.json +79 -0
  61. package/teams/fhr-neowise/skills/write-plan/assets/TEMPLATE.plan.md +158 -0
@@ -0,0 +1,321 @@
1
+ > **Warning**
2
+ >
3
+ > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
4
+ >
5
+ > ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/treeView.md](../../packages/mermaid/src/docs/syntax/treeView.md).
6
+
7
+ # TreeView Diagram (v11.14.0+)
8
+
9
+ ## Introduction
10
+
11
+ A TreeView diagram is used to represent hierarchical data in the form of a directory-like structure, with file-type icons, connector lines, and optional annotations.
12
+
13
+ ## Syntax
14
+
15
+ The structure of the tree depends only on indentation. Labels can be **bare** (unquoted) or **quoted** (for names containing spaces).
16
+
17
+ - Directories are indicated by a trailing `/` on the label — they get a folder icon and bold text.
18
+ - Files are auto-detected by extension and assigned a matching icon.
19
+ - Quoted labels (`"my file"`) support spaces in names.
20
+
21
+ ```
22
+ treeView-beta
23
+ my-project/
24
+ src/
25
+ index.js
26
+ package.json
27
+ README.md
28
+ ```
29
+
30
+ Quoted labels (backward compatible):
31
+
32
+ ```
33
+ treeView-beta
34
+ "my project"
35
+ "folder with spaces"
36
+ "file.js"
37
+ ```
38
+
39
+ ## Box-Drawing Input
40
+
41
+ As an alternative to indentation, you can use box-drawing characters to define the tree structure. The parser auto-detects the format — no extra keyword or config is needed. This is how most file tree diagrams are drawn already, so you can turn those into Mermaid diagrams with very little effort.
42
+
43
+ Both standard (`├──`, `└──`, `│`) and heavy (`┣━━`, `┗━━`, `┃`) Unicode variants are supported.
44
+
45
+ ```mermaid-example
46
+ treeView-beta
47
+ ├── src/
48
+ │ ├── index.ts
49
+ │ └── utils.ts
50
+ ├── package.json
51
+ └── README.md
52
+ ```
53
+
54
+ ```mermaid
55
+ treeView-beta
56
+ ├── src/
57
+ │ ├── index.ts
58
+ │ └── utils.ts
59
+ ├── package.json
60
+ └── README.md
61
+ ```
62
+
63
+ All annotations work the same way — just append them after the label:
64
+
65
+ ```mermaid-example
66
+ treeView-beta
67
+ ├── src/
68
+ │ ├── App.tsx :::highlight icon(react) ## main component
69
+ │ └── index.ts ## entry point
70
+ ├── .env ## environment variables
71
+ ├── Dockerfile
72
+ └── package.json
73
+ ```
74
+
75
+ ```mermaid
76
+ treeView-beta
77
+ ├── src/
78
+ │ ├── App.tsx :::highlight icon(react) ## main component
79
+ │ └── index.ts ## entry point
80
+ ├── .env ## environment variables
81
+ ├── Dockerfile
82
+ └── package.json
83
+ ```
84
+
85
+ Depth is inferred from the column position of the branch character, so deeper nesting works naturally:
86
+
87
+ ```mermaid-example
88
+ treeView-beta
89
+ ├── packages/
90
+ │ ├── mermaid/
91
+ │ │ ├── src/
92
+ │ │ │ ├── parser.ts
93
+ │ │ │ └── renderer.ts
94
+ │ │ └── package.json
95
+ │ └── parser/
96
+ │ └── src/
97
+ └── README.md
98
+ ```
99
+
100
+ ```mermaid
101
+ treeView-beta
102
+ ├── packages/
103
+ │ ├── mermaid/
104
+ │ │ ├── src/
105
+ │ │ │ ├── parser.ts
106
+ │ │ │ └── renderer.ts
107
+ │ │ └── package.json
108
+ │ └── parser/
109
+ │ └── src/
110
+ └── README.md
111
+ ```
112
+
113
+ > **Note:** If a parse error occurs, line numbers in the error message refer to your original input. Tab characters are automatically expanded to spaces.
114
+
115
+ ## Annotations
116
+
117
+ ### Highlighting with :::class
118
+
119
+ Annotate a node with `:::className` to apply a CSS class. A built-in `highlight` class is provided:
120
+
121
+ ```mermaid-example
122
+ treeView-beta
123
+ src/
124
+ App.tsx :::highlight
125
+ index.js
126
+ package.json
127
+ ```
128
+
129
+ ```mermaid
130
+ treeView-beta
131
+ src/
132
+ App.tsx :::highlight
133
+ index.js
134
+ package.json
135
+ ```
136
+
137
+ ### Inline descriptions with `##`
138
+
139
+ Add a visible description after `##` — rendered next to the label in italic:
140
+
141
+ ```mermaid-example
142
+ treeView-beta
143
+ src/
144
+ index.js ## app entry point
145
+ config.ts ## runtime configuration
146
+ package.json ## project manifest
147
+ ```
148
+
149
+ ```mermaid
150
+ treeView-beta
151
+ src/
152
+ index.js ## app entry point
153
+ config.ts ## runtime configuration
154
+ package.json ## project manifest
155
+ ```
156
+
157
+ ### Icon overrides with icon()
158
+
159
+ Override the auto-detected icon with `icon(name)`:
160
+
161
+ ```mermaid-example
162
+ treeView-beta
163
+ data/
164
+ model.bin icon(database)
165
+ weights.h5 icon(database)
166
+ src/
167
+ index.js
168
+ ```
169
+
170
+ ```mermaid
171
+ treeView-beta
172
+ data/
173
+ model.bin icon(database)
174
+ weights.h5 icon(database)
175
+ src/
176
+ index.js
177
+ ```
178
+
179
+ ### Combined annotations
180
+
181
+ Annotations can be combined in any order:
182
+
183
+ ```mermaid-example
184
+ treeView-beta
185
+ my-project/
186
+ src/
187
+ App.tsx :::highlight icon(react) ## main component
188
+ index.js ## entry point
189
+ .env ## environment variables
190
+ Dockerfile
191
+ package.json
192
+ ```
193
+
194
+ ```mermaid
195
+ treeView-beta
196
+ my-project/
197
+ src/
198
+ App.tsx :::highlight icon(react) ## main component
199
+ index.js ## entry point
200
+ .env ## environment variables
201
+ Dockerfile
202
+ package.json
203
+ ```
204
+
205
+ ## Comments
206
+
207
+ Use `%%` for invisible comments (standard Mermaid convention):
208
+
209
+ ```
210
+ treeView-beta
211
+ %% Generated files — do not edit
212
+ src/
213
+ generated/
214
+ index.js
215
+ ```
216
+
217
+ ## Examples
218
+
219
+ Basic with quoted labels:
220
+
221
+ ```mermaid-example
222
+ treeView-beta
223
+ "packages"
224
+ "mermaid"
225
+ "src"
226
+ "parser"
227
+ ```
228
+
229
+ ```mermaid
230
+ treeView-beta
231
+ "packages"
232
+ "mermaid"
233
+ "src"
234
+ "parser"
235
+ ```
236
+
237
+ With custom config:
238
+
239
+ ```mermaid-example
240
+ ---
241
+ config:
242
+ treeView:
243
+ rowIndent: 80
244
+ lineThickness: 3
245
+ themeVariables:
246
+ treeView:
247
+ labelFontSize: '20px'
248
+ labelColor: '#FF0000'
249
+ lineColor: '#00FF00'
250
+ ---
251
+ treeView-beta
252
+ "packages"
253
+ "mermaid"
254
+ "src"
255
+ "parser"
256
+ ```
257
+
258
+ ```mermaid
259
+ ---
260
+ config:
261
+ treeView:
262
+ rowIndent: 80
263
+ lineThickness: 3
264
+ themeVariables:
265
+ treeView:
266
+ labelFontSize: '20px'
267
+ labelColor: '#FF0000'
268
+ lineColor: '#00FF00'
269
+ ---
270
+ treeView-beta
271
+ "packages"
272
+ "mermaid"
273
+ "src"
274
+ "parser"
275
+ ```
276
+
277
+ ## Config Variables
278
+
279
+ | Property | Description | Default Value |
280
+ | ------------- | --------------------------------- | ------------- |
281
+ | rowIndent | Indentation for each row | 10 |
282
+ | paddingX | Horizontal padding of row | 5 |
283
+ | paddingY | Vertical padding of row | 5 |
284
+ | lineThickness | Thickness of the line | 1 |
285
+ | showIcons | Whether to show file/folder icons | true |
286
+
287
+ ### Theme Variables
288
+
289
+ | Property | Description | Default Value |
290
+ | ---------------- | ------------------------------ | -------------------- |
291
+ | labelFontSize | Font size of the label | '16px' |
292
+ | labelColor | Color of the label | 'black' |
293
+ | lineColor | Color of the line | 'black' |
294
+ | iconColor | Color of file-type icons | '#546e7a' |
295
+ | descriptionColor | Color of `##` description text | '#6a9955' |
296
+ | highlightBg | Highlight background fill | rgba(255,193,7,0.15) |
297
+ | highlightStroke | Highlight border stroke | #ffc107 |
298
+
299
+ ## Supported Icons
300
+
301
+ Icons are auto-detected from file extensions and known filenames:
302
+
303
+ | Extension / Filename | Icon |
304
+ | --------------------- | ---------- |
305
+ | `.js`, `.mjs`, `.cjs` | javascript |
306
+ | `.ts` | typescript |
307
+ | `.jsx`, `.tsx` | react |
308
+ | `.py` | python |
309
+ | `.json` | json |
310
+ | `.md`, `.mdx` | markdown |
311
+ | `.html`, `.htm` | html |
312
+ | `.css`, `.scss` | css |
313
+ | `.yaml`, `.yml` | yaml |
314
+ | `.sh`, `.bash` | terminal |
315
+ | `.sql`, `.db` | database |
316
+ | `.lock` | lock |
317
+ | `.gitignore` | git |
318
+ | `Dockerfile` | docker |
319
+ | `Makefile` | terminal |
320
+ | Directories (`/`) | folder |
321
+ | Unknown extension | file |
@@ -0,0 +1,353 @@
1
+ > **Warning**
2
+ >
3
+ > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
4
+ >
5
+ > ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/treemap.md](../../packages/mermaid/src/docs/syntax/treemap.md).
6
+
7
+ # Treemap Diagram
8
+
9
+ > A treemap diagram displays hierarchical data as a set of nested rectangles. Each branch of the tree is represented by a rectangle, which is then tiled with smaller rectangles representing sub-branches.
10
+
11
+ > **Warning**
12
+ > This is a new diagram type in Mermaid. Its syntax may evolve in future versions.
13
+
14
+ ## Introduction
15
+
16
+ Treemap diagrams are an effective way to visualize hierarchical data and show proportions between categories and subcategories. The size of each rectangle is proportional to the value it represents, making it easy to compare different parts of a hierarchy.
17
+
18
+ Treemap diagrams are particularly useful for:
19
+
20
+ - Visualizing hierarchical data structures
21
+ - Comparing proportions between categories
22
+ - Displaying large amounts of hierarchical data in a limited space
23
+ - Identifying patterns and outliers in hierarchical data
24
+
25
+ ## Syntax
26
+
27
+ ```
28
+ treemap-beta
29
+ "Section 1"
30
+ "Leaf 1.1": 12
31
+ "Section 1.2"
32
+ "Leaf 1.2.1": 12
33
+ "Section 2"
34
+ "Leaf 2.1": 20
35
+ "Leaf 2.2": 25
36
+ ```
37
+
38
+ ### Node Definition
39
+
40
+ Nodes in a treemap are defined using the following syntax:
41
+
42
+ - **Section/Parent nodes**: Defined with quoted text `"Section Name"`
43
+ - **Leaf nodes with values**: Defined with quoted text followed by a colon and value `"Leaf Name": value`
44
+ - **Hierarchy**: Created using indentation (spaces or tabs)
45
+ - **Styling**: Nodes can be styled using the `:::class` syntax
46
+
47
+ ## Examples
48
+
49
+ ### Basic Treemap
50
+
51
+ ```mermaid-example
52
+ treemap-beta
53
+ "Category A"
54
+ "Item A1": 10
55
+ "Item A2": 20
56
+ "Category B"
57
+ "Item B1": 15
58
+ "Item B2": 25
59
+ ```
60
+
61
+ ```mermaid
62
+ treemap-beta
63
+ "Category A"
64
+ "Item A1": 10
65
+ "Item A2": 20
66
+ "Category B"
67
+ "Item B1": 15
68
+ "Item B2": 25
69
+ ```
70
+
71
+ ### Hierarchical Treemap
72
+
73
+ ```mermaid-example
74
+ treemap-beta
75
+ "Products"
76
+ "Electronics"
77
+ "Phones": 50
78
+ "Computers": 30
79
+ "Accessories": 20
80
+ "Clothing"
81
+ "Men's": 40
82
+ "Women's": 40
83
+ ```
84
+
85
+ ```mermaid
86
+ treemap-beta
87
+ "Products"
88
+ "Electronics"
89
+ "Phones": 50
90
+ "Computers": 30
91
+ "Accessories": 20
92
+ "Clothing"
93
+ "Men's": 40
94
+ "Women's": 40
95
+ ```
96
+
97
+ ### Treemap with Styling
98
+
99
+ ```mermaid-example
100
+ treemap-beta
101
+ "Section 1"
102
+ "Leaf 1.1": 12
103
+ "Section 1.2":::class1
104
+ "Leaf 1.2.1": 12
105
+ "Section 2"
106
+ "Leaf 2.1": 20:::class1
107
+ "Leaf 2.2": 25
108
+ "Leaf 2.3": 12
109
+
110
+ classDef class1 fill:red,color:blue,stroke:#FFD600;
111
+ ```
112
+
113
+ ```mermaid
114
+ treemap-beta
115
+ "Section 1"
116
+ "Leaf 1.1": 12
117
+ "Section 1.2":::class1
118
+ "Leaf 1.2.1": 12
119
+ "Section 2"
120
+ "Leaf 2.1": 20:::class1
121
+ "Leaf 2.2": 25
122
+ "Leaf 2.3": 12
123
+
124
+ classDef class1 fill:red,color:blue,stroke:#FFD600;
125
+ ```
126
+
127
+ ## Styling and Configuration
128
+
129
+ Treemap diagrams can be customized using Mermaid's styling and configuration options.
130
+
131
+ ### Using classDef for Styling
132
+
133
+ You can define custom styles for nodes using the `classDef` syntax, which is a standard feature across many Mermaid diagram types:
134
+
135
+ ```mermaid-example
136
+ treemap-beta
137
+ "Main"
138
+ "A": 20
139
+ "B":::important
140
+ "B1": 10
141
+ "B2": 15
142
+ "C": 5
143
+
144
+ classDef important fill:#f96,stroke:#333,stroke-width:2px;
145
+ ```
146
+
147
+ ```mermaid
148
+ treemap-beta
149
+ "Main"
150
+ "A": 20
151
+ "B":::important
152
+ "B1": 10
153
+ "B2": 15
154
+ "C": 5
155
+
156
+ classDef important fill:#f96,stroke:#333,stroke-width:2px;
157
+ ```
158
+
159
+ ### Theme Configuration
160
+
161
+ You can customize the colors of your treemap using the theme configuration:
162
+
163
+ ```mermaid-example
164
+ ---
165
+ config:
166
+ theme: 'forest'
167
+ ---
168
+ treemap-beta
169
+ "Category A"
170
+ "Item A1": 10
171
+ "Item A2": 20
172
+ "Category B"
173
+ "Item B1": 15
174
+ "Item B2": 25
175
+ ```
176
+
177
+ ```mermaid
178
+ ---
179
+ config:
180
+ theme: 'forest'
181
+ ---
182
+ treemap-beta
183
+ "Category A"
184
+ "Item A1": 10
185
+ "Item A2": 20
186
+ "Category B"
187
+ "Item B1": 15
188
+ "Item B2": 25
189
+ ```
190
+
191
+ ### Diagram Padding
192
+
193
+ You can adjust the padding around the treemap diagram using the `diagramPadding` configuration option:
194
+
195
+ ```mermaid-example
196
+ ---
197
+ config:
198
+ treemap:
199
+ diagramPadding: 200
200
+ ---
201
+ treemap-beta
202
+ "Category A"
203
+ "Item A1": 10
204
+ "Item A2": 20
205
+ "Category B"
206
+ "Item B1": 15
207
+ "Item B2": 25
208
+ ```
209
+
210
+ ```mermaid
211
+ ---
212
+ config:
213
+ treemap:
214
+ diagramPadding: 200
215
+ ---
216
+ treemap-beta
217
+ "Category A"
218
+ "Item A1": 10
219
+ "Item A2": 20
220
+ "Category B"
221
+ "Item B1": 15
222
+ "Item B2": 25
223
+ ```
224
+
225
+ ## Configuration Options
226
+
227
+ The treemap diagram supports the following configuration options:
228
+
229
+ | Option | Description | Default |
230
+ | -------------- | --------------------------------------------------------------------------- | ------- |
231
+ | useMaxWidth | When true, the diagram width is set to 100% and scales with available space | true |
232
+ | padding | Internal padding between nodes | 10 |
233
+ | diagramPadding | Padding around the entire diagram | 8 |
234
+ | showValues | Whether to show values in the treemap | true |
235
+ | nodeWidth | Width of nodes | 100 |
236
+ | nodeHeight | Height of nodes | 40 |
237
+ | borderWidth | Width of borders | 1 |
238
+ | valueFontSize | Font size for values | 12 |
239
+ | labelFontSize | Font size for labels | 14 |
240
+ | valueFormat | Format for values (see Value Formatting section) | ',' |
241
+
242
+ ## Advanced Features
243
+
244
+ ### Value Formatting
245
+
246
+ Values in treemap diagrams can be formatted to display in different ways using the `valueFormat` configuration option. This option primarily uses [D3's format specifiers](https://github.com/d3/d3-format#locale_format) to control how numbers are displayed, with some additional special cases for common formats.
247
+
248
+ Some common format patterns:
249
+
250
+ - `,` - Thousands separator (default)
251
+ - `$` - Add dollar sign
252
+ - `.1f` - Show one decimal place
253
+ - `.1%` - Show as percentage with one decimal place
254
+ - `$0,0` - Dollar sign with thousands separator
255
+ - `$.2f` - Dollar sign with 2 decimal places
256
+ - `$,.2f` - Dollar sign with thousands separator and 2 decimal places
257
+
258
+ The treemap diagram supports both standard D3 format specifiers and some common currency formats that combine the dollar sign with other formatting options.
259
+
260
+ Example with currency formatting:
261
+
262
+ ```mermaid-example
263
+ ---
264
+ config:
265
+ treemap:
266
+ valueFormat: '$0,0'
267
+ ---
268
+ treemap-beta
269
+ "Budget"
270
+ "Operations"
271
+ "Salaries": 700000
272
+ "Equipment": 200000
273
+ "Supplies": 100000
274
+ "Marketing"
275
+ "Advertising": 400000
276
+ "Events": 100000
277
+ ```
278
+
279
+ ```mermaid
280
+ ---
281
+ config:
282
+ treemap:
283
+ valueFormat: '$0,0'
284
+ ---
285
+ treemap-beta
286
+ "Budget"
287
+ "Operations"
288
+ "Salaries": 700000
289
+ "Equipment": 200000
290
+ "Supplies": 100000
291
+ "Marketing"
292
+ "Advertising": 400000
293
+ "Events": 100000
294
+ ```
295
+
296
+ Example with percentage formatting:
297
+
298
+ ```mermaid-example
299
+ ---
300
+ config:
301
+ treemap:
302
+ valueFormat: '$.1%'
303
+ ---
304
+ treemap-beta
305
+ "Market Share"
306
+ "Company A": 0.35
307
+ "Company B": 0.25
308
+ "Company C": 0.15
309
+ "Others": 0.25
310
+ ```
311
+
312
+ ```mermaid
313
+ ---
314
+ config:
315
+ treemap:
316
+ valueFormat: '$.1%'
317
+ ---
318
+ treemap-beta
319
+ "Market Share"
320
+ "Company A": 0.35
321
+ "Company B": 0.25
322
+ "Company C": 0.15
323
+ "Others": 0.25
324
+ ```
325
+
326
+ ## Common Use Cases
327
+
328
+ Treemap diagrams are commonly used for:
329
+
330
+ 1. **Financial Data**: Visualizing budget allocations, market shares, or portfolio compositions
331
+ 2. **File System Analysis**: Showing disk space usage by folders and files
332
+ 3. **Population Demographics**: Displaying population distribution across regions and subregions
333
+ 4. **Product Hierarchies**: Visualizing product categories and their sales volumes
334
+ 5. **Organizational Structures**: Representing departments and team sizes in a company
335
+
336
+ ## Limitations
337
+
338
+ - Treemap diagrams work best when the data has a natural hierarchy
339
+ - Very small values may be difficult to see or label in a treemap diagram
340
+ - Deep hierarchies (many levels) can be challenging to represent clearly
341
+ - Treemap diagrams are not well suited for representing data with negative values
342
+
343
+ ## Related Diagrams
344
+
345
+ If treemap diagrams don't suit your needs, consider these alternatives:
346
+
347
+ - [**Pie Charts**](./pie.md): For simple proportion comparisons without hierarchy
348
+ - **Sunburst Diagrams**: For hierarchical data with a radial layout (yet to be released in Mermaid).
349
+ - [**Sankey Diagrams**](./sankey.md): For flow-based hierarchical data
350
+
351
+ ## Notes
352
+
353
+ The treemap diagram implementation in Mermaid is designed to be simple to use while providing powerful visualization capabilities. As this is a newer diagram type, feedback and feature requests are welcome through the Mermaid GitHub repository.
@@ -0,0 +1,42 @@
1
+ > **Warning**
2
+ >
3
+ > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
4
+ >
5
+ > ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/userJourney.md](../../packages/mermaid/src/docs/syntax/userJourney.md).
6
+
7
+ # User Journey Diagram
8
+
9
+ > User journeys describe at a high level of detail exactly what steps different users take to complete a specific task within a system, application or website. This technique shows the current (as-is) user workflow, and reveals areas of improvement for the to-be workflow. (Wikipedia)
10
+
11
+ Mermaid can render user journey diagrams:
12
+
13
+ ```mermaid-example
14
+ journey
15
+ title My working day
16
+ section Go to work
17
+ Make tea: 5: Me
18
+ Go upstairs: 3: Me
19
+ Do work: 1: Me, Cat
20
+ section Go home
21
+ Go downstairs: 5: Me
22
+ Sit down: 5: Me
23
+ ```
24
+
25
+ ```mermaid
26
+ journey
27
+ title My working day
28
+ section Go to work
29
+ Make tea: 5: Me
30
+ Go upstairs: 3: Me
31
+ Do work: 1: Me, Cat
32
+ section Go home
33
+ Go downstairs: 5: Me
34
+ Sit down: 5: Me
35
+ ```
36
+
37
+ Each user journey is split into sections, these describe the part of the task
38
+ the user is trying to complete.
39
+
40
+ Tasks syntax is `Task name: <score>: <comma separated list of actors>`
41
+
42
+ Score is a number between 1 and 5, inclusive.