@diagrammo/dgmo 0.10.1 → 0.10.2

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 (48) hide show
  1. package/dist/auto.cjs +1 -1
  2. package/dist/auto.js +1 -1
  3. package/dist/auto.mjs +1 -1
  4. package/package.json +2 -2
  5. package/docs/guide/chart-arc.md +0 -71
  6. package/docs/guide/chart-area.md +0 -73
  7. package/docs/guide/chart-bar-stacked.md +0 -61
  8. package/docs/guide/chart-bar.md +0 -62
  9. package/docs/guide/chart-boxes-and-lines.md +0 -243
  10. package/docs/guide/chart-c4.md +0 -298
  11. package/docs/guide/chart-chord.md +0 -43
  12. package/docs/guide/chart-class.md +0 -204
  13. package/docs/guide/chart-cycle.md +0 -156
  14. package/docs/guide/chart-doughnut.md +0 -38
  15. package/docs/guide/chart-er.md +0 -218
  16. package/docs/guide/chart-flowchart.md +0 -102
  17. package/docs/guide/chart-function.md +0 -56
  18. package/docs/guide/chart-funnel.md +0 -38
  19. package/docs/guide/chart-gantt.md +0 -368
  20. package/docs/guide/chart-heatmap.md +0 -41
  21. package/docs/guide/chart-infra.md +0 -694
  22. package/docs/guide/chart-journey-map.md +0 -179
  23. package/docs/guide/chart-kanban.md +0 -158
  24. package/docs/guide/chart-line.md +0 -79
  25. package/docs/guide/chart-mindmap.md +0 -198
  26. package/docs/guide/chart-multi-line.md +0 -84
  27. package/docs/guide/chart-org.md +0 -209
  28. package/docs/guide/chart-pie.md +0 -39
  29. package/docs/guide/chart-polar-area.md +0 -38
  30. package/docs/guide/chart-pyramid.md +0 -111
  31. package/docs/guide/chart-quadrant.md +0 -69
  32. package/docs/guide/chart-radar.md +0 -38
  33. package/docs/guide/chart-sankey.md +0 -103
  34. package/docs/guide/chart-scatter.md +0 -91
  35. package/docs/guide/chart-sequence.md +0 -354
  36. package/docs/guide/chart-sitemap.md +0 -265
  37. package/docs/guide/chart-slope.md +0 -56
  38. package/docs/guide/chart-state.md +0 -171
  39. package/docs/guide/chart-tech-radar.md +0 -219
  40. package/docs/guide/chart-timeline.md +0 -229
  41. package/docs/guide/chart-venn.md +0 -81
  42. package/docs/guide/chart-wireframe.md +0 -100
  43. package/docs/guide/chart-wordcloud.md +0 -66
  44. package/docs/guide/colors.md +0 -287
  45. package/docs/guide/how-dgmo-thinks.md +0 -277
  46. package/docs/guide/index.md +0 -63
  47. package/docs/guide/keyboard-shortcuts.md +0 -49
  48. package/docs/guide/registry.json +0 -58
@@ -1,179 +0,0 @@
1
- # Journey Map
2
-
3
- ```dgmo
4
- journey-map Coffee Shop Visit
5
-
6
- [Order]
7
- Walk in | 4
8
- Wait in line | 2
9
- Order drink | 4
10
-
11
- [Wait]
12
- Find a seat | 3
13
- Wait for drink | 2
14
-
15
- [Enjoy]
16
- Get drink | 5
17
- ```
18
-
19
- ## Overview
20
-
21
- Journey maps visualize a user's experience across a process or service, plotting emotional highs and lows as a continuous curve. Each step has a score (1–5, high is good) that drives the emotion landscape. Phases group related steps, annotations capture pain points, opportunities, and thoughts, and tags add cross-cutting dimensions like channel or touchpoint.
22
-
23
- Journey maps are ideal for UX research, customer experience mapping, service design, and identifying friction points.
24
-
25
- ## Syntax
26
-
27
- ```
28
- journey-map Title
29
-
30
- persona Name
31
-
32
- [Phase Name]
33
- Step Name | score
34
- Step Name | score Emotion
35
- ```
36
-
37
- The first line must be `journey-map` followed by a title. Phases use bracket syntax at indent 0. Steps are indented within phases.
38
-
39
- ## Persona
40
-
41
- Declares the journey's protagonist:
42
-
43
- ```
44
- persona Tech-Savvy Shopper
45
- 28yo developer, price-sensitive, does extensive research
46
- ```
47
-
48
- Name is everything after `persona `. Indented lines add description text. Only one persona per diagram.
49
-
50
- ## Phases
51
-
52
- Phases group steps into logical stages:
53
-
54
- ```
55
- [Research]
56
- Compare specs | 4
57
- Watch reviews | 5
58
-
59
- [Purchase]
60
- Add to cart | 3
61
- Complete payment | 3
62
- ```
63
-
64
- Phases are optional — steps can appear at root level for a flat continuous flow.
65
-
66
- ## Steps
67
-
68
- Steps appear indented within phases (or at indent 0 in flat mode).
69
-
70
- ### Score Syntax
71
-
72
- The score goes in the pipe, separating step name from data:
73
-
74
- ```
75
- Step Name | 4 // bare score
76
- Step Name | 4 Delighted // score + emotion label
77
- Step Name | 4, ch: Web // score + tag metadata
78
- Step Name | 4 Delighted, ch: Web // score + label + metadata
79
- Step Name | score: 4, ch: Web // explicit score key
80
- Step Name // no pipe = scoreless step
81
- ```
82
-
83
- - **Score scale**: 1–5 integer (high = good)
84
- - **Emotion label**: optional single word after the score (e.g., `Frustrated`, `Delighted`, `Neutral`)
85
- - **Scoreless steps**: render as cards but produce no emotion curve point
86
-
87
- ## Annotations
88
-
89
- Deeper-indented lines under a step add context:
90
-
91
- ```
92
- Forced account creation | 1 Frustrated
93
- pain: Wants guest checkout
94
- opportunity: Add guest checkout option
95
- thought: Why do I need an account?
96
- description: User abandoned cart twice
97
- ```
98
-
99
- | Prefix | Rendering |
100
- |--------|-----------|
101
- | `pain:` | Pain point (red accent) |
102
- | `opportunity:` | Improvement opportunity (green accent) |
103
- | `thought:` | User thought (italic) |
104
- | `description:` | General context text |
105
-
106
- Multiple annotations per step are allowed.
107
-
108
- ## Tag Groups
109
-
110
- Tags add color-coded dimensions like channel or touchpoint:
111
-
112
- ```
113
- tag Channel ch
114
- Web(blue)
115
- Mobile(purple)
116
- In-Person(green)
117
-
118
- [Research]
119
- Compare specs | 4, ch: Web
120
- Ask friends | 4, ch: In-Person
121
- ```
122
-
123
- Reference tag values in step pipes via the alias.
124
-
125
- ## Flat Mode
126
-
127
- Steps at root level (no `[Phase]` brackets) render as a continuous horizontal strip:
128
-
129
- ```dgmo
130
- journey-map Quick Feedback
131
-
132
- Opened app | 4
133
- Searched for feature | 3
134
- Hit error | 1 Frustrated
135
- pain: No helpful error message
136
- Contacted support | 2
137
- Got resolution | 5 Relieved
138
- ```
139
-
140
- ## Directives
141
-
142
- | Directive | Effect |
143
- |-----------|--------|
144
- | `no-legend` | Hide the score legend |
145
- | `active-tag GroupName` | Set the active tag group for coloring |
146
-
147
- ## Complete Example
148
-
149
- ```dgmo
150
- journey-map Buying a Laptop
151
-
152
- persona Tech-Savvy Shopper
153
- 28yo developer, price-sensitive, does extensive research
154
-
155
- tag Channel ch
156
- Web(blue)
157
- Mobile(purple)
158
- Email(teal)
159
- In-Person(green)
160
-
161
- [Research]
162
- Compare specs | 4, ch: Web
163
- description: Checked 12 laptops across 4 review sites
164
- Watch reviews | 5 Engaged, ch: Mobile
165
- Ask friends | 4, ch: In-Person
166
-
167
- [Purchase]
168
- Add to cart | 3, ch: Web
169
- Forced account creation | 1 Frustrated, ch: Web
170
- pain: Wants guest checkout
171
- pain: Password requirements too strict
172
- Complete payment | 3, ch: Web
173
-
174
- [Delivery]
175
- Track package | 4, ch: Mobile
176
- Unboxing | 5 Delighted, ch: In-Person
177
- opportunity: Include setup guide
178
- thought: Excited to try it out
179
- ```
@@ -1,158 +0,0 @@
1
- # Kanban Board
2
-
3
- ```dgmo
4
- kanban Plunder Sprint 7
5
-
6
- tag Priority
7
- Urgent(red)
8
- High(orange)
9
- Low(green) default
10
-
11
- tag Crew alias c
12
- Blackbeard(red)
13
- Anne Bonny(purple)
14
- Calico Jack(teal)
15
-
16
- [Awaiting Orders](red)
17
- Recruit gunners at Tortuga | priority: High, c: Calico Jack
18
- Chart new trade route | priority: Urgent, c: Anne Bonny
19
- Scout the Windward Passage
20
- Avoid Royal Navy patrols
21
- Resupply rum and powder | priority: Low, c: Calico Jack
22
-
23
- [Underway](orange) | wip: 2
24
- Forge letters of marque | priority: High, c: Anne Bonny
25
- Raid merchant convoy | priority: Urgent, c: Blackbeard
26
- Three ships spotted off Nassau
27
-
28
- [Done](green)
29
- Bribe the harbour master | priority: High, c: Anne Bonny
30
- Repair hull damage | priority: Low, c: Blackbeard
31
- ```
32
-
33
- ## Overview
34
-
35
- Kanban boards visualize work items as cards organized into columns. Columns typically represent workflow stages (To Do, In Progress, Done). Cards can carry tags for color-coded categorization and freeform detail text.
36
-
37
- **Drag-and-drop:** In the app, drag cards between columns or reorder within a column. The editor text updates automatically.
38
-
39
- ## Syntax
40
-
41
- ```
42
- kanban Board Title
43
-
44
- [Column Name]
45
- Card Title
46
- Card Title | key: Value, key: Value
47
- Freeform detail text
48
- Another detail line
49
- ```
50
-
51
- ## Settings
52
-
53
- | Key | Description | Default |
54
- | ------- | ---------------- | ------- |
55
- | `chart` | Must be `kanban` | — |
56
- | `title` | Board title | None |
57
-
58
- ## Columns
59
-
60
- Columns are defined with `[Column Name]` syntax. All cards between one column header and the next belong to that column.
61
-
62
- Kanban columns model a workflow pipeline. Cards move left to right as work progresses. Each column should answer "what stage is this work in?" If something isn't a stage — like acceptance criteria, decision gates, or definitions of done — model it as a tag on cards rather than a separate column.
63
-
64
- ```
65
- [To Do]
66
- [In Progress]
67
- [Done]
68
- ```
69
-
70
- ### WIP Limits
71
-
72
- Add `| wip: N` after a column header to set a work-in-progress limit. A warning appears when the limit is exceeded:
73
-
74
- ```
75
- [In Progress] | wip: 3
76
- ```
77
-
78
- ## Cards
79
-
80
- Each non-indented line within a column creates a card. Cards can have tags and detail lines.
81
-
82
- ### Tags
83
-
84
- Tags follow the card title, separated by `|`. Multiple tags are comma-separated:
85
-
86
- ```
87
- Build login | priority: High, assignee: Alice
88
- ```
89
-
90
- ### Detail Lines
91
-
92
- Indented lines under a card are freeform detail text:
93
-
94
- ```
95
- Build login | priority: High
96
- OAuth + email/password support
97
- Needs design review first
98
- ```
99
-
100
- ### Card Colors
101
-
102
- Add a color suffix to a card title:
103
-
104
- ```
105
- Urgent fix(red)
106
- ```
107
-
108
- ## Tag Groups
109
-
110
- Tag groups define categories with color-coded values. They appear before columns and use the `tag` directive:
111
-
112
- ```
113
- tag Priority
114
- High(red)
115
- Medium(yellow)
116
- Low(green) default
117
-
118
- tag Assignee alias a
119
- Alice(blue)
120
- Bob(purple)
121
- ```
122
-
123
- - `default` marks the fallback value for cards without an explicit tag
124
- - `alias` provides a short name for the tag (e.g., `a` instead of `assignee`)
125
- - Colors are shown as dots on each card
126
-
127
- ## Complete Example
128
-
129
- ```dgmo
130
- kanban Product Roadmap
131
-
132
- tag Status
133
- Blocked(red)
134
- Active(green) default
135
-
136
- tag Team alias t
137
- Frontend(blue)
138
- Backend(purple)
139
- Design(yellow)
140
-
141
- [Backlog]
142
- Dark mode support | t: Frontend
143
- API rate limiting | t: Backend
144
- Research token bucket vs sliding window
145
-
146
- [In Progress] | wip: 3
147
- User dashboard | t: Frontend, status: Active
148
- Charts and metrics overview
149
- Auth refactor | t: Backend, status: Active
150
-
151
- [Review]
152
- Payment integration | t: Backend, status: Blocked
153
- Waiting on Stripe webhook setup
154
-
155
- [Done]
156
- Onboarding flow | t: Design
157
- Landing page | t: Frontend
158
- ```
@@ -1,79 +0,0 @@
1
- # Line Chart
2
-
3
- ```dgmo
4
- line Ship Speed Over Voyage
5
- series Knots
6
- x-label Day
7
- y-label Speed
8
-
9
- era Day 1 -> Day 3 Rough Seas (red)
10
- era Day 3 -> Day 7 Fair Winds (blue)
11
-
12
- Day 1 8
13
- Day 2 10
14
- Day 3 7
15
- Day 4 12
16
- Day 5 9
17
- Day 6 11
18
- Day 7 6
19
- ```
20
-
21
- ## Syntax
22
-
23
- ```
24
- line Chart Title
25
- series Series Name
26
- x-label X Axis Label
27
- y-label Y Axis Label
28
-
29
- Label value
30
- ```
31
-
32
- ## Era Bands
33
-
34
- Annotate named time periods with a shaded background band and label:
35
-
36
- ```dgmo
37
- line U.S. Strategic Petroleum Reserve
38
- y-label Million Barrels
39
-
40
- era '77 -> '81 Carter (blue)
41
- era '81 -> '89 Reagan (red)
42
- era '89 -> '93 Bush (red)
43
-
44
- '77 7
45
- '78 67
46
- '79 91
47
- '80 108
48
- '81 230
49
- '82 294
50
- '83 379
51
- ```
52
-
53
- Era syntax: `era <start> -> <end> Label (color)`
54
-
55
- - `start` and `end` must exactly match data point labels
56
- - Color is optional; omit for the palette default
57
- - Named colors: `red`, `blue`, `green`, `orange`, `purple`, `teal`, etc.
58
- - Multiple eras can overlap — both render without error
59
-
60
- ## Metadata Keys
61
-
62
- | Key | Description | Required |
63
- | --------- | ----------------------------------------- | -------- |
64
- | `chart` | Must be `line` | Yes |
65
- | `title` | Chart title displayed above the chart | No |
66
- | `series` | Name of the data series (shown in legend) | No |
67
- | `x-label` | Label for the X axis | No |
68
- | `y-label` | Label for the Y axis | No |
69
- | `color` | Override the line color | No |
70
-
71
- ## Data Format
72
-
73
- Each data line follows the pattern `Label value`:
74
-
75
- ```
76
- Day 1 8
77
- Day 2 10
78
- Day 3 7
79
- ```
@@ -1,198 +0,0 @@
1
- # Mind Map
2
-
3
- ```dgmo
4
- mindmap Product Strategy
5
-
6
- Research
7
- User Interviews
8
- Surveys | description: Quarterly NPS survey
9
- Focus Groups
10
- Competitor Analysis
11
- Feature Matrix
12
- Pricing Review
13
- Development
14
- MVP Features
15
- Auth System
16
- description: Handle login, signup, OAuth flows
17
- Dashboard
18
- Nice-to-haves | collapsed: true
19
- Dark Mode
20
- Export PDF
21
- Go-to-Market
22
- Launch Plan
23
- Blog Post
24
- Demo Video | description: 2-min product walkthrough
25
- ```
26
-
27
- ## Overview
28
-
29
- Mind maps visualize hierarchical information radiating from a central concept. Each branch represents a subtopic, with deeper nesting for finer detail. Mind maps are useful for brainstorming, project planning, knowledge organization, and breaking down complex topics.
30
-
31
- **Interactive features:** Click nodes to navigate to their source line. Collapse and expand subtrees by clicking nodes with children. Toggle tag group coloring and depth-based coloring via the legend controls.
32
-
33
- ## Syntax
34
-
35
- ```
36
- mindmap Title
37
-
38
- Node
39
- Child Node
40
- Grandchild
41
- Another Child
42
- ```
43
-
44
- The first line declares the chart type. The title becomes the root node. Indentation establishes the parent-child hierarchy.
45
-
46
- ## Nodes
47
-
48
- Every non-blank, non-directive line is a node. Nesting is set by indentation:
49
-
50
- ```
51
- mindmap Root
52
- Level 1a
53
- Level 2a
54
- Level 2b
55
- Level 1b
56
- ```
57
-
58
- ### Node Colors
59
-
60
- Add a color suffix in parentheses:
61
-
62
- ```
63
- Important Topic(red)
64
- Sub-topic(blue)
65
- ```
66
-
67
- ### Descriptions
68
-
69
- Nodes can have descriptions shown as secondary text. Two forms:
70
-
71
- ```
72
- // Pipe form (single line)
73
- Surveys | description: Quarterly NPS survey
74
-
75
- // Indented form (before children)
76
- Auth System
77
- description: Handle login, signup, and OAuth flows
78
- Login Page
79
- ```
80
-
81
- ### Collapse Default
82
-
83
- Set a node's default collapsed state with pipe metadata:
84
-
85
- ```
86
- Nice-to-haves | collapsed: true
87
- Dark Mode
88
- Export PDF
89
- ```
90
-
91
- Collapsed nodes show a drill-bar indicating hidden children. Click to expand.
92
-
93
- ## Multi-Root
94
-
95
- Omit the title to create multiple independent root trees:
96
-
97
- ```
98
- mindmap
99
-
100
- Q1 Goals
101
- Ship MVP
102
- Hire designers
103
- Q2 Goals
104
- Launch marketing
105
- Expand team
106
- ```
107
-
108
- The diagram title is inferred from the first root's label.
109
-
110
- ## Pipe Metadata
111
-
112
- Attach metadata after `|` with comma-separated `key: value` pairs:
113
-
114
- ```
115
- Node | priority: High, status: Done
116
- ```
117
-
118
- Tag values, descriptions, and `collapsed` are all set via pipe metadata.
119
-
120
- ## Tag Groups
121
-
122
- Tag groups define color-coded categories. They appear before content and follow the standard tag syntax:
123
-
124
- ```
125
- mindmap Root
126
-
127
- tag Priority p
128
- High(red)
129
- Medium(yellow)
130
- Low(green)
131
-
132
- Task A | p: High
133
- Task B | p: Low
134
- ```
135
-
136
- - The alias (`p`) provides a shorthand for metadata keys
137
- - The active tag group colors nodes by their tag value
138
- - Click a tag group name in the legend to activate or deactivate it
139
-
140
- ## Options
141
-
142
- | Option | Effect |
143
- |--------|--------|
144
- | `active-tag GroupName` | Set the default active tag group |
145
- | `no-descriptions` | Hide description text on all nodes |
146
-
147
- Options are placed on their own line before content:
148
-
149
- ```
150
- mindmap Root
151
-
152
- tag Priority p
153
- High(red)
154
- Low(green)
155
-
156
- active-tag Priority
157
- no-descriptions
158
-
159
- Task A | p: High
160
- ```
161
-
162
- ## Complete Example
163
-
164
- ```dgmo
165
- mindmap Product Strategy(blue)
166
-
167
- tag Priority p
168
- High(red)
169
- Medium(yellow)
170
- Low(green)
171
-
172
- tag Department d
173
- Engineering(blue)
174
- Design(purple)
175
- Marketing(orange)
176
-
177
- active-tag Priority
178
-
179
- Research | d: Marketing
180
- User Interviews | p: High
181
- Surveys | description: Quarterly NPS survey
182
- Focus Groups
183
- Competitor Analysis | d: Engineering
184
- Feature Matrix
185
- Pricing Review
186
- Development | p: High, d: Engineering
187
- MVP Features
188
- Auth System
189
- description: Handle login, signup, OAuth flows
190
- Dashboard
191
- Nice-to-haves | p: Low, collapsed: true
192
- Dark Mode
193
- Export PDF
194
- Go-to-Market | d: Marketing
195
- Launch Plan
196
- Blog Post
197
- Demo Video | description: 2-min product walkthrough
198
- ```
@@ -1,84 +0,0 @@
1
- # Multi-Line Chart
2
-
3
- ```dgmo
4
- line Monthly Captures by Fleet
5
- series Blackbeard(red), Roberts(blue), Vane(green)
6
- x-label Month
7
- //y-label Captures
8
-
9
- era Jan -> Mar Atlantic Season
10
- era Mar -> Jun Caribbean Season (teal)
11
-
12
- Jan 3 5 2
13
- Feb 4 3 4
14
- Mar 2 7 3
15
- Apr 6 4 1
16
- May 5 6 5
17
- Jun 3 8 2
18
- ```
19
-
20
- ## Syntax
21
-
22
- ```
23
- line Chart Title
24
- series Series1(color), Series2(color), Series3(color)
25
- x-label X Axis Label
26
-
27
- Label value1 value2 value3
28
- ```
29
-
30
- ## Metadata Keys
31
-
32
- | Key | Description | Required |
33
- | --------- | ---------------------------------------------------------------- | -------- |
34
- | `chart` | Must be `line` (or `multi-line` as an alias) | Yes |
35
- | `title` | Chart title displayed above the chart | No |
36
- | `series` | Comma-separated series names with optional colors in parentheses | Yes |
37
- | `x-label` | Label for the X axis | No |
38
- | `y-label` | Label for the Y axis | No |
39
-
40
- ## Data Format
41
-
42
- Each data line provides space-separated values matching the series order:
43
-
44
- ```
45
- Jan 3 5 2
46
- Feb 4 3 4
47
- ```
48
-
49
- The number of values per line must match the number of series names.
50
-
51
- ## Era Bands
52
-
53
- Annotate named time periods with a shaded background band and label:
54
-
55
- ```dgmo
56
- line Monthly Captures by Fleet
57
- series Blackbeard(red), Roberts(blue)
58
- x-label Month
59
-
60
- era Jan -> Mar Q1 (green)
61
- era Apr -> Jun Q2 (orange)
62
-
63
- Jan 3 5
64
- Feb 4 3
65
- Mar 2 7
66
- Apr 6 4
67
- May 5 6
68
- Jun 3 8
69
- ```
70
-
71
- Era syntax: `era <start> -> <end> Label (color)`
72
-
73
- - `start` and `end` must exactly match data point labels
74
- - Color is optional; omit for the palette default
75
- - Era bands render on the first series only
76
-
77
- ## Series Colors
78
-
79
- Colors can be specified in parentheses after each series name using named colors:
80
-
81
- ```
82
- series Gold(yellow), Silver(gray), Bronze(orange)
83
- series Fleet A(red), Fleet B(blue)
84
- ```