@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,209 +0,0 @@
1
- # Org Chart
2
-
3
- ```dgmo
4
- org The Dread Fleet
5
- sub-node-label Crew
6
- show-sub-node-count
7
-
8
- tag Rank alias r
9
- Captain(red)
10
- FirstMate(orange)
11
- Quartermaster(yellow)
12
- Bosun(green)
13
- Gunner(teal)
14
- Sailor(blue) default
15
- Jester(cyan)
16
- Swab(purple)
17
-
18
- tag Ship alias s
19
- Revenge(blue) default
20
- Serpent(green)
21
- Phantom(purple)
22
-
23
- tag Status alias st
24
- Loyal(green) default
25
- Turncoat(red)
26
- NewRecruit(yellow)
27
-
28
- Blackbeard| r: Captain, s: Revenge
29
- Anne Bonny| r: FirstMate
30
- [Gun Deck]
31
- Cannonball Pete| r: Gunner
32
- Smokey Jack| r: Gunner, st: NewRecruit
33
- Powder Meg| r: Swab, st: NewRecruit
34
- [Boarding Party]
35
- Cutlass Jim| r: Bosun
36
- Red Mary
37
- One-Eyed Dan| st: Turncoat
38
- Calico Rackham| r: Quartermaster
39
- [Cargo Hold]
40
- Barnacle Bob
41
- Slippery Sal| st: Turncoat
42
- Long John| r: FirstMate, s: Serpent
43
- [Rigging Crew]
44
- Monkey Fist| r: Bosun
45
- Pegleg Pete
46
- Crow Jane
47
- [Navigation]
48
- Stargazer Quinn| r: Quartermaster
49
- Compass Rose| st: NewRecruit
50
- ```
51
-
52
- ## Overview
53
-
54
- Org charts use **indentation** to define reporting hierarchy. Each person is a line of text, and metadata like `role:` appears indented beneath them. Children are indented under their manager.
55
-
56
- ## Syntax
57
-
58
- ```
59
- org Chart Title
60
-
61
- Person Name
62
- role: Job Title
63
-
64
- Direct Report
65
- role: Job Title
66
- ```
67
-
68
- ## Settings
69
-
70
- | Key | Description | Default |
71
- | ------- | ------------- | ------- |
72
- | `chart` | Must be `org` | Yes |
73
- | `title` | Chart title | None |
74
-
75
- ## Nodes
76
-
77
- Each non-indented (or less-indented) text line creates a person node. Deeper indentation creates a child (direct report):
78
-
79
- ```
80
- CEO
81
- VP of Engineering
82
- Senior Engineer
83
- Junior Engineer
84
- VP of Sales
85
- Account Executive
86
- ```
87
-
88
- ## Metadata
89
-
90
- Add key-value pairs indented under a node:
91
-
92
- ```
93
- Alice Park
94
- role: Senior Engineer
95
- location: New York
96
- focus: APIs
97
- ```
98
-
99
- Metadata renders as secondary text on the node card.
100
-
101
- ### Compact Pipe Syntax
102
-
103
- For concise entries, use `|` to put metadata on a single line:
104
-
105
- ```
106
- Alice Park | role: Senior Engineer | location: NY
107
- Bob Torres | role: Junior Engineer | location: CO
108
- ```
109
-
110
- ## Containers (Teams)
111
-
112
- Use `[Team Name]` to create a container that groups its children visually:
113
-
114
- ```
115
- Alex Chen
116
- role: CTO
117
-
118
- [Platform Team]
119
- goal: Core infrastructure and APIs
120
-
121
- Alice Park | role: Senior Engineer
122
- Bob Torres | role: Junior Engineer
123
-
124
- [Frontend Team]
125
- goal: Ship new design system by Q3
126
-
127
- Carol Wu | role: Senior Engineer
128
- Dave Kim | role: Junior Engineer
129
- ```
130
-
131
- Containers render as labeled boxes. They can have metadata like `goal:` and `charter:` which display below the container label.
132
-
133
- ## Node Colors
134
-
135
- Add a color name in parentheses:
136
-
137
- ```
138
- [Platform Team(blue)]
139
- [Frontend Team(green)]
140
- ```
141
-
142
- ## Tag Groups
143
-
144
- Define color-coded tags for metadata values like location or status. Tag groups must appear before org content:
145
-
146
- ```
147
- org Acme Corp
148
-
149
- tag Location
150
- NY(blue)
151
- LA(yellow)
152
- Remote(purple)
153
-
154
- tag Status
155
- FTE(green)
156
- Contractor(orange)
157
-
158
- Jane Smith
159
- role: CEO
160
- location: NY
161
- status: FTE
162
- ```
163
-
164
- - `tag GroupName` starts a tag group
165
- - `alias` provides a shorthand for metadata keys (e.g., `tag Location alias l`)
166
- - `default` marks the fallback value for nodes without that metadata
167
- - When a node's metadata value matches a tag entry, it renders with that tag's color as a badge
168
-
169
- ## Comments
170
-
171
- ```
172
- // This line is ignored by the parser
173
- ```
174
-
175
- ## Collapse / Expand
176
-
177
- In the app, click a node that has children to focus it. Click again to collapse its subtree — a "+N hidden" label shows how many nodes are hidden. Click once more to expand. Containers can be collapsed independently.
178
-
179
- Keyboard: Tab to focus a node, Enter or Space to toggle.
180
-
181
- ## Complete Example
182
-
183
- ```dgmo
184
- org Engineering Division
185
-
186
- Alex Chen
187
- role: CTO
188
-
189
- [Platform Team]
190
- goal: Core infrastructure and APIs
191
- charter: Platform reliability and developer experience
192
-
193
- Alice Park | role: Senior Engineer | location: NY
194
- Bob Torres | role: Junior Engineer | location: CO
195
-
196
- [Frontend Team]
197
- goal: Ship new design system by Q3
198
-
199
- Carol Wu
200
- role: Senior Engineer
201
- Dave Kim
202
- role: Junior Engineer
203
-
204
- [Data Team]
205
- goal: ML pipeline and analytics
206
-
207
- Eve Martinez
208
- role: Data Scientist
209
- ```
@@ -1,39 +0,0 @@
1
- # Pie Chart
2
-
3
- ```dgmo
4
- pie Crew Roles Distribution
5
-
6
- Sailors 45
7
- Gunners 20
8
- Marines 15
9
- Officers 8
10
- Specialists 7
11
- Cooks & Surgeons 5
12
- ```
13
-
14
- ## Syntax
15
-
16
- ```
17
- pie Chart Title
18
-
19
- Label value
20
- ```
21
-
22
- ## Metadata Keys
23
-
24
- | Key | Description | Required |
25
- | ------- | ------------------------------------- | -------- |
26
- | `chart` | Must be `pie` | Yes |
27
- | `title` | Chart title displayed above the chart | No |
28
-
29
- ## Data Format
30
-
31
- Each data line follows the pattern `Label value`:
32
-
33
- ```
34
- Sailors 45
35
- Gunners 20
36
- Officers 8
37
- ```
38
-
39
- Slices are automatically colored using the Nord palette.
@@ -1,38 +0,0 @@
1
- # Polar Area Chart
2
-
3
- ```dgmo
4
- polar-area Captain's Skills
5
-
6
- Navigation 90
7
- Swordsmanship 75
8
- Leadership 85
9
- Cunning 95
10
- Seamanship 80
11
- ```
12
-
13
- ## Syntax
14
-
15
- ```
16
- polar-area Chart Title
17
-
18
- Label value
19
- ```
20
-
21
- ## Metadata Keys
22
-
23
- | Key | Description | Required |
24
- | ------- | ------------------------------------- | -------- |
25
- | `chart` | Must be `polar-area` | Yes |
26
- | `title` | Chart title displayed above the chart | No |
27
-
28
- ## Data Format
29
-
30
- Each data line follows the pattern `Label value`:
31
-
32
- ```
33
- Navigation 90
34
- Swordsmanship 75
35
- Leadership 85
36
- ```
37
-
38
- Segments are automatically colored using the Nord palette.
@@ -1,111 +0,0 @@
1
- # Pyramid Diagram
2
-
3
- ```dgmo
4
- pyramid Maslow's Hierarchy of Needs
5
-
6
- Self-Actualization | color: purple
7
- Morality, creativity, acceptance of facts.
8
-
9
- Esteem | color: blue
10
- Respect, recognition, confidence.
11
-
12
- Love & Belonging | color: green
13
- Friendship, intimacy, family.
14
-
15
- Safety | color: yellow
16
- Security, employment, health.
17
-
18
- Physiological | color: orange
19
- Food, water, warmth, rest.
20
- ```
21
-
22
- ## Overview
23
-
24
- Pyramid diagrams show a hierarchy of stacked layers. Each layer gets a colored band with a label and an optional description. Source order reads apex-first — the first layer in the file is the narrowest (visual top), the last is the widest (visual bottom). Use `inverted` to flip into a funnel orientation.
25
-
26
- ## Syntax
27
-
28
- ```
29
- pyramid Title
30
-
31
- LayerLabel
32
- LayerLabel | color: blue
33
- LayerLabel | color: green
34
- Indented description
35
- ```
36
-
37
- The first line declares the chart type and an optional title. Each non-indented, non-directive line declares one layer. At least two layers are required.
38
-
39
- ## Layers
40
-
41
- ```
42
- pyramid Roles
43
-
44
- Executives | color: purple
45
- Managers | color: blue
46
- Individual Contributors | color: green
47
- ```
48
-
49
- ### Layer Pipe Metadata
50
-
51
- | Key | Type | Default | Description |
52
- |-----|------|---------|-------------|
53
- | `color` | palette name | auto-assigned | Layer color |
54
- | `description` | string | — | One-liner shown beside the layer |
55
-
56
- ### Descriptions
57
-
58
- Indented lines under a layer add description text. Markdown inline formatting is supported (`**bold**`, `*italic*`, `` `code` ``, `[links](url)`). Bullet points with `- item` render as `• item`.
59
-
60
- ```
61
- Wisdom | color: purple
62
- Ethical judgment, acting with insight.
63
- - Knowing *why* something matters
64
- - Acting with long-term perspective
65
- ```
66
-
67
- If both `| description: text` and indented lines exist, they concatenate (pipe first, then indented).
68
-
69
- ## Directives
70
-
71
- | Directive | Effect |
72
- |-----------|--------|
73
- | `inverted` | Flip apex to the bottom (funnel orientation). Source order is preserved — the first layer is always the visual top. |
74
-
75
- ```
76
- pyramid Acquisition Funnel
77
-
78
- inverted
79
-
80
- Visitors | color: blue
81
- Signups | color: cyan
82
- Activated | color: green
83
- Paid | color: orange
84
- ```
85
-
86
- ## Overflow Handling
87
-
88
- When descriptions don't fit a layer's band, the renderer automatically:
89
-
90
- - **Wraps** text at the column edge so nothing leaves the canvas
91
- - **Truncates** with "…" when content exceeds the available lines
92
- - **Alternates** descriptions left ↔ right when a single column can't hold them
93
- - **Reveals** the full description when a layer is highlighted (in-app), hiding siblings so it has room
94
-
95
- ## Complete Example
96
-
97
- ```dgmo
98
- pyramid The DIKW Pyramid
99
-
100
- Wisdom | color: purple
101
- Ethical judgment, acting with insight — knowing *why*.
102
-
103
- Knowledge | color: blue
104
- Synthesized information — knowing *how*.
105
-
106
- Information | color: green
107
- Processed data with context — knowing *what*.
108
-
109
- Data | color: yellow
110
- Raw facts and measurements — unprocessed signals.
111
- ```
@@ -1,69 +0,0 @@
1
- # Quadrant Chart
2
-
3
- ```dgmo
4
- quadrant Crew Performance Assessment
5
- x-label Low Skill, High Skill
6
- y-label Low Loyalty, High Loyalty
7
-
8
- top-right Promote (green)
9
- top-left Train (yellow)
10
- bottom-left Maroon (red)
11
- bottom-right Watch Closely (purple)
12
-
13
- Quartermaster 0.9, 0.95
14
- Navigator 0.85, 0.8
15
- Gunner 0.7, 0.6
16
- Surgeon 0.8, 0.75
17
- Boatswain 0.6, 0.85
18
- Cook 0.4, 0.9
19
- New Recruit 0.2, 0.5
20
- Troublemaker 0.65, 0.2
21
- ```
22
-
23
- ## Syntax
24
-
25
- ```
26
- quadrant Chart Title
27
- x-label Low Label, High Label
28
- y-label Low Label, High Label
29
-
30
- top-right Quadrant Label (color)
31
- top-left Quadrant Label (color)
32
- bottom-left Quadrant Label (color)
33
- bottom-right Quadrant Label (color)
34
-
35
- Item Name x, y
36
- ```
37
-
38
- ## Metadata Keys
39
-
40
- | Key | Description | Required |
41
- | -------------- | ------------------------------------------------------- | -------- |
42
- | `chart` | Must be `quadrant` | Yes |
43
- | `title` | Chart title displayed above the chart | No |
44
- | `x-label` | Two comma-separated labels for X axis (low, high) | No |
45
- | `y-label` | Two comma-separated labels for Y axis (low, high) | No |
46
- | `top-right` | Label for the top-right quadrant with optional color | No |
47
- | `top-left` | Label for the top-left quadrant with optional color | No |
48
- | `bottom-left` | Label for the bottom-left quadrant with optional color | No |
49
- | `bottom-right` | Label for the bottom-right quadrant with optional color | No |
50
-
51
- ## Data Format
52
-
53
- Each data point specifies X and Y coordinates between 0 and 1:
54
-
55
- ```
56
- Item A 0.9, 0.95
57
- Item B 0.4, 0.3
58
- ```
59
-
60
- ## Quadrant Colors
61
-
62
- Colors can be specified in parentheses after each quadrant label:
63
-
64
- ```
65
- top-right Promote (green)
66
- top-left Train (yellow)
67
- bottom-left Maroon (red)
68
- bottom-right Watch Closely (purple)
69
- ```
@@ -1,38 +0,0 @@
1
- # Radar Chart
2
-
3
- ```dgmo
4
- radar Ship Combat Rating
5
-
6
- Firepower 85
7
- Speed 70
8
- Armor 60
9
- Maneuverability 90
10
- Crew Morale 75
11
- ```
12
-
13
- ## Syntax
14
-
15
- ```
16
- radar Chart Title
17
-
18
- Label value
19
- ```
20
-
21
- ## Metadata Keys
22
-
23
- | Key | Description | Required |
24
- | ------- | ------------------------------------- | -------- |
25
- | `chart` | Must be `radar` | Yes |
26
- | `title` | Chart title displayed above the chart | No |
27
-
28
- ## Data Format
29
-
30
- Each data line defines one axis of the radar with its value:
31
-
32
- ```
33
- Firepower 85
34
- Speed 70
35
- Armor 60
36
- ```
37
-
38
- Values are plotted on axes radiating from the center, connected by a filled polygon.
@@ -1,103 +0,0 @@
1
- # Sankey Diagram
2
-
3
- ```dgmo
4
- sankey Rum Supply Chain of the Caribbean
5
-
6
- Sugar Plantations(green)
7
- Tortuga Distillery(orange) 3000
8
- Nassau Distillery(orange) 2500
9
- Kingston Distillery(orange) 2000
10
-
11
- Tortuga Distillery
12
- Pirate Taverns(red) 2000
13
- Ship Provisions(teal) 1000
14
-
15
- Nassau Distillery
16
- Pirate Taverns 1500
17
- Black Market(purple) 1000
18
-
19
- Kingston Distillery
20
- Royal Navy(blue) 1200
21
- Pirate Taverns 800
22
-
23
- Pirate Taverns
24
- Crew Morale 3500
25
- Bar Fights 800 (red)
26
-
27
- Ship Provisions -> Long Voyages 1000
28
- ```
29
-
30
- ## Syntax
31
-
32
- ### Arrow syntax
33
-
34
- ```
35
- sankey Chart Title
36
-
37
- Source -> Target value
38
- ```
39
-
40
- ### Indentation syntax
41
-
42
- ```
43
- sankey
44
-
45
- Source
46
- Target A 300
47
- Target B 200
48
-
49
- Target A
50
- Sub-target 150
51
- ```
52
-
53
- Indent targets under a bare source label. Both syntaxes can be mixed in the same diagram.
54
-
55
- ## Color Annotations
56
-
57
- ### Node colors
58
-
59
- Add `(color)` after a node name to color that node:
60
-
61
- ```
62
- Revenue(green)
63
- Costs(red) 600
64
- Profit(blue) 400
65
-
66
- // or with arrows
67
- Revenue(green) -> Costs(red) 600
68
- ```
69
-
70
- Uncolored nodes use the palette's default series colors.
71
-
72
- ### Link colors
73
-
74
- Add `(color)` after the value to color a specific link:
75
-
76
- ```
77
- Revenue
78
- Costs 600 (orange)
79
-
80
- // or with arrows
81
- Revenue -> Costs 600 (orange)
82
- ```
83
-
84
- Uncolored links use a gradient between their source and target node colors.
85
-
86
- ## Metadata Keys
87
-
88
- | Key | Description | Required |
89
- | ------- | ------------------------------------- | -------- |
90
- | `chart` | Must be `sankey` | Yes |
91
- | `title` | Chart title displayed above the chart | No |
92
-
93
- ## Data Format
94
-
95
- Each data line defines a flow from source to target with a numeric value:
96
-
97
- ```
98
- Sugar Plantations -> Distillery 3000
99
- Distillery -> Taverns 2000
100
- Distillery -> Ship Provisions 1000
101
- ```
102
-
103
- Nodes are created automatically from the source and target names. The same node can appear as both a source and a target to create multi-level flows.
@@ -1,91 +0,0 @@
1
- # Scatter Plot
2
-
3
- ```dgmo
4
- scatter Cannon Range vs Powder Charge
5
- x-label Powder (lbs)
6
- y-label Range (yards)
7
-
8
- Long Tom 12 1800
9
- Demi-Culverin 8 1200
10
- Carronade 4 400
11
- Swivel Gun 2 250
12
- Nine-Pounder 6 900
13
- Eighteen-Pounder 10 1500
14
- Basilisk 14 2000
15
- Falconet 3 350
16
- Minion 5 700
17
- Saker 7 1050
18
- ```
19
-
20
- ## Syntax
21
-
22
- ```
23
- scatter Chart Title
24
- x-label X Axis Label
25
- y-label Y Axis Label
26
- no-name
27
- size-label Size Legend Label
28
-
29
- Point Name x y
30
-
31
- // or with size (bubble chart)
32
- Point Name x y size
33
- ```
34
-
35
- ## Metadata Keys
36
-
37
- | Key | Description | Required |
38
- | ------------ | ---------------------------------------------------------- | -------- |
39
- | `chart` | Must be `scatter` | Yes |
40
- | `title` | Chart title displayed above the chart | No |
41
- | `x-label` | Label for the X axis | No |
42
- | `y-label` | Label for the Y axis | No |
43
- | `no-name` | Hide point labels (labels are on by default) | No |
44
- | `size-label` | Label for the size dimension (shown in legend for bubbles) | No |
45
-
46
- ## Data Format
47
-
48
- Each data line provides X and Y values, with an optional third value for bubble size:
49
-
50
- ```
51
- // 2D scatter
52
- Point A 12 1800
53
- Point B 8 1200
54
-
55
- // 3D bubble
56
- Point A 85 90 80
57
- Point B 45 55 35
58
- ```
59
-
60
- ## Category Groups
61
-
62
- Use `[Category Name](color)` headers to group points into colored categories:
63
-
64
- ```
65
- [English Pirates](red)
66
- Blackbeard 85 90 80
67
- Calico Jack 45 55 35
68
-
69
- [French Buccaneers](blue)
70
- L'Olonnais 70 80 60
71
- ```
72
-
73
- ## Variants
74
-
75
- ### Bubble Chart
76
-
77
- Add a third value per data point and use `sizelabel` to label the size dimension:
78
-
79
- ```dgmo
80
- scatter Pirate Fleets of the Caribbean
81
- size-label Crew
82
-
83
- [English Pirates](red)
84
- Blackbeard 85 90 80
85
- Calico Jack 45 55 35
86
- Anne Bonny 50 70 30
87
-
88
- [French Buccaneers](blue)
89
- L'Olonnais 70 80 60
90
- Pierre le Grand 30 45 25
91
- ```