@grethel-labs/excaliplant 1.2.0 → 1.2.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 (34) hide show
  1. package/README.md +8 -7
  2. package/package.json +13 -2
  3. package/skills/excaliplant/references/diagram-types.md +31 -31
  4. package/skills/excaliplant/references/examples.md +58 -58
  5. package/skills/manifest.json +29 -29
  6. /package/skills/excaliplant/assets/examples/{activity-order-processing.puml → activity-order-processing.puml.txt} +0 -0
  7. /package/skills/excaliplant/assets/examples/{archimate-insurance.puml → archimate-insurance.puml.txt} +0 -0
  8. /package/skills/excaliplant/assets/examples/{chart-quarterly.puml → chart-quarterly.puml.txt} +0 -0
  9. /package/skills/excaliplant/assets/examples/{chen-movie-rental.puml → chen-movie-rental.puml.txt} +0 -0
  10. /package/skills/excaliplant/assets/examples/{chronology-project-history.puml → chronology-project-history.puml.txt} +0 -0
  11. /package/skills/excaliplant/assets/examples/{class-shop-domain.puml → class-shop-domain.puml.txt} +0 -0
  12. /package/skills/excaliplant/assets/examples/{component-c4-container.puml → component-c4-container.puml.txt} +0 -0
  13. /package/skills/excaliplant/assets/examples/{creole-release-notes.puml → creole-release-notes.puml.txt} +0 -0
  14. /package/skills/excaliplant/assets/examples/{deployment-kubernetes.puml → deployment-kubernetes.puml.txt} +0 -0
  15. /package/skills/excaliplant/assets/examples/{ditaa-pipeline.puml → ditaa-pipeline.puml.txt} +0 -0
  16. /package/skills/excaliplant/assets/examples/{dot-pipeline.puml → dot-pipeline.puml.txt} +0 -0
  17. /package/skills/excaliplant/assets/examples/{ebnf-json-grammar.puml → ebnf-json-grammar.puml.txt} +0 -0
  18. /package/skills/excaliplant/assets/examples/{files-project-layout.puml → files-project-layout.puml.txt} +0 -0
  19. /package/skills/excaliplant/assets/examples/{gantt-release-plan.puml → gantt-release-plan.puml.txt} +0 -0
  20. /package/skills/excaliplant/assets/examples/{json-api-response.puml → json-api-response.puml.txt} +0 -0
  21. /package/skills/excaliplant/assets/examples/{latex-gaussian.puml → latex-gaussian.puml.txt} +0 -0
  22. /package/skills/excaliplant/assets/examples/{legacy-activity-approval.puml → legacy-activity-approval.puml.txt} +0 -0
  23. /package/skills/excaliplant/assets/examples/{math-sum-of-cubes.puml → math-sum-of-cubes.puml.txt} +0 -0
  24. /package/skills/excaliplant/assets/examples/{mindmap-excaliplant.puml → mindmap-excaliplant.puml.txt} +0 -0
  25. /package/skills/excaliplant/assets/examples/{nwdiag-office-network.puml → nwdiag-office-network.puml.txt} +0 -0
  26. /package/skills/excaliplant/assets/examples/{object-runtime-snapshot.puml → object-runtime-snapshot.puml.txt} +0 -0
  27. /package/skills/excaliplant/assets/examples/{regex-email.puml → regex-email.puml.txt} +0 -0
  28. /package/skills/excaliplant/assets/examples/{salt-login-dialog.puml → salt-login-dialog.puml.txt} +0 -0
  29. /package/skills/excaliplant/assets/examples/{sequence-checkout-flow.puml → sequence-checkout-flow.puml.txt} +0 -0
  30. /package/skills/excaliplant/assets/examples/{state-order-lifecycle.puml → state-order-lifecycle.puml.txt} +0 -0
  31. /package/skills/excaliplant/assets/examples/{timing-sensor.puml → timing-sensor.puml.txt} +0 -0
  32. /package/skills/excaliplant/assets/examples/{usecase-checkout.puml → usecase-checkout.puml.txt} +0 -0
  33. /package/skills/excaliplant/assets/examples/{wbs-website-relaunch.puml → wbs-website-relaunch.puml.txt} +0 -0
  34. /package/skills/excaliplant/assets/examples/{yaml-ci-config.puml → yaml-ci-config.puml.txt} +0 -0
package/README.md CHANGED
@@ -103,13 +103,14 @@ result.diagnostics; // warnings with line numbers
103
103
 
104
104
  One package, several front doors. Everything is built from this repository and released together with the npm package.
105
105
 
106
- | Where | What | Docs |
107
- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
108
- | Markdown | `excaliplant markdown README.md` replaces ` ```plantuml ` blocks with diagrams; plugins for `markdown-it` and `remark`; a GitHub Action for CI | [`docs/markdown.md`](docs/markdown.md) |
109
- | AI assistants | An agent skill for Claude Code, Claude, Codex, Gemini CLI, opencode, Cursor, Copilot, Antigravity and more (`excaliplant skills install`), always bundled with the current Excalidraw element spec | [`docs/skills.md`](docs/skills.md) |
110
- | MCP clients | `excaliplant mcp` — an MCP server with `render_plantuml`, `validate_plantuml`, `list_diagram_types` and `get_example` | [`docs/mcp.md`](docs/mcp.md) |
111
- | VS Code | Live Markdown preview and commands for `.puml` files | [`docs/vscode.md`](docs/vscode.md) |
112
- | Obsidian | Renders `plantuml` code blocks in your notes | [`docs/obsidian.md`](docs/obsidian.md) |
106
+ | Where | What | Docs |
107
+ | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
108
+ | Markdown | `excaliplant markdown README.md` replaces ` ```plantuml ` blocks with diagrams; plugins for `markdown-it` and `remark`; a GitHub Action for CI | [`docs/markdown.md`](docs/markdown.md) |
109
+ | AI assistants | An agent skill for Claude Code, Claude, Codex, Gemini CLI, opencode, Cursor, Copilot, Antigravity and more (`excaliplant skills install`), always bundled with the current Excalidraw element spec | [`docs/skills.md`](docs/skills.md) |
110
+ | MCP clients | `excaliplant mcp` — an MCP server with `render_plantuml`, `validate_plantuml`, `list_diagram_types` and `get_example` | [`docs/mcp.md`](docs/mcp.md) |
111
+ | VS Code | Live Markdown preview and commands for `.puml` files | [`docs/vscode.md`](docs/vscode.md) |
112
+ | Obsidian | Renders `plantuml` code blocks in your notes | [`docs/obsidian.md`](docs/obsidian.md) |
113
+ | Directories | Where excaliplant is listed (Claude, Codex, Gemini CLI, skills.sh, MCP registry, Markdown ecosystems) and how to submit it | [`docs/publishing.md`](docs/publishing.md) |
113
114
 
114
115
  ## How it works
115
116
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@grethel-labs/excaliplant",
3
- "version": "1.2.0",
3
+ "version": "1.2.2",
4
4
  "description": "Render PlantUML as hand-drawn Excalidraw diagrams, SVG and PNG.",
5
5
  "type": "module",
6
6
  "main": "./src/index.mjs",
@@ -63,7 +63,18 @@
63
63
  "svg",
64
64
  "png",
65
65
  "elk",
66
- "hand-drawn"
66
+ "hand-drawn",
67
+ "markdown",
68
+ "markdown-it-plugin",
69
+ "remark-plugin",
70
+ "unified-plugin",
71
+ "mcp",
72
+ "mcp-server",
73
+ "model-context-protocol",
74
+ "agent-skill",
75
+ "claude-code-plugin",
76
+ "gemini-cli-extension",
77
+ "codex-plugin"
67
78
  ],
68
79
  "publishConfig": {
69
80
  "access": "public",
@@ -6,36 +6,36 @@ excaliplant renders 29 kinds of diagram. Pick the kind that matches the request
6
6
 
7
7
  Diagrams that share `@startuml` are told apart by their content (arrows, keywords such as `class`, `participant`, `state`, `actor`). If the wrong kind is detected, make the intent clearer or use the dedicated start keyword where one exists.
8
8
 
9
- | Diagram | Kind | Start keywords | Highlights | Example |
10
- | --------------- | ----------------- | ----------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------- |
11
- | Sequence | `sequence` | `@startuml`, `@startsequence` | Participants, all arrow styles, activations, notes, fragments, dividers, autonumber, boxes. | `assets/examples/sequence-checkout-flow.puml` |
12
- | Class & IE | `class` | `@startuml` | Classes, interfaces, enums, generics, members, packages, all UML relations, IE crow's feet. | `assets/examples/class-shop-domain.puml` |
13
- | Activity | `activity` | `@startuml`, `@startactivity` | New syntax with if/switch/while/repeat/fork/split, partitions, notes and swimlanes. | `assets/examples/activity-order-processing.puml` |
14
- | State | `state` | `@startuml` | Composite states, concurrent regions, choice, fork/join, history, entry/exit actions. | `assets/examples/state-order-lifecycle.puml` |
15
- | Component & C4 | `component` | `@startuml` | Components, interfaces, ports, packages, nodes — and C4 via `!include <C4/...>`. | `assets/examples/component-c4-container.puml` |
16
- | Use case | `usecase` | `@startuml` | Actors, use cases, system boundaries, include/extend. | `assets/examples/usecase-checkout.puml` |
17
- | Deployment | `deployment` | `@startuml` | Nodes, clouds, databases, queues, artifacts and nested deployment targets. | `assets/examples/deployment-kubernetes.puml` |
18
- | Object | `object` | `@startuml` | Objects with fields, maps (`key => value`) and links. | `assets/examples/object-runtime-snapshot.puml` |
19
- | Timing | `timing` | `@startuml`, `@starttiming` | Robust, concise, clock, binary and analog signals with messages and constraints. | `assets/examples/timing-sensor.puml` |
20
- | Gantt | `gantt` | `@startgantt`, `@startuml` | Tasks, dependencies, milestones, progress, resources, closed days, today marker. | `assets/examples/gantt-release-plan.puml` |
21
- | Mind map | `mindmap` | `@startmindmap` | OrgMode/Markdown outlines on both sides, colours, boxless nodes. | `assets/examples/mindmap-excaliplant.puml` |
22
- | WBS | `wbs` | `@startwbs` | Work breakdown structures as org charts. | `assets/examples/wbs-website-relaunch.puml` |
23
- | JSON | `json` | `@startjson` | JSON documents as linked tables with highlights. | `assets/examples/json-api-response.puml` |
24
- | YAML | `yaml` | `@startyaml` | YAML documents as linked tables. | `assets/examples/yaml-ci-config.puml` |
25
- | ArchiMate | `archimate` | `@startuml` | ArchiMate elements by layer with icons, junctions and `Rel_*` macros. | `assets/examples/archimate-insurance.puml` |
26
- | Chen ER | `chen` | `@startchen` | Chen ER diagrams: entities, weak entities, relationships, attributes, cardinalities. | `assets/examples/chen-movie-rental.puml` |
27
- | Network | `nwdiag` | `@startnwdiag`, `@startuml` | Networks, addresses, multi-homed nodes, groups and peer links. | `assets/examples/nwdiag-office-network.puml` |
28
- | Salt wireframe | `salt` | `@startsalt`, `@startuml` | Wireframes: grids, buttons, inputs, check boxes, trees, tabs, group boxes. | `assets/examples/salt-login-dialog.puml` |
29
- | EBNF | `ebnf` | `@startebnf` | EBNF grammars as railroad diagrams. | `assets/examples/ebnf-json-grammar.puml` |
30
- | Regex | `regex` | `@startregex` | Regular expressions as railroad diagrams. | `assets/examples/regex-email.puml` |
31
- | Graphviz DOT | `dot` | `@startdot` | Graphviz DOT graphs laid out with ELK. | `assets/examples/dot-pipeline.puml` |
32
- | Chronology | `chronology` | `@startchronology` | Events and spans on a time line with links. | `assets/examples/chronology-project-history.puml` |
33
- | Files | `files` | `@startfiles` | File trees from path lists with notes. | `assets/examples/files-project-layout.puml` |
34
- | Chart | `chart` | `@startchart` | Bar, line, area and scatter charts. | `assets/examples/chart-quarterly.puml` |
35
- | AsciiMath | `math` | `@startmath` | AsciiMath formulas. | `assets/examples/math-sum-of-cubes.puml` |
36
- | LaTeX | `latex` | `@startlatex` | LaTeX formulas. | `assets/examples/latex-gaussian.puml` |
37
- | Ditaa | `ditaa` | `@startditaa`, `@startuml` | ASCII art boxes, lines, arrows and colour tags. | `assets/examples/ditaa-pipeline.puml` |
38
- | Legacy activity | `legacy-activity` | `@startuml` | The classic `(*) --> "Activity"` syntax with sync bars and branches. | `assets/examples/legacy-activity-approval.puml` |
39
- | Creole | `creole` | `@startcreole` | Rich text with headings, lists, tables and links. | `assets/examples/creole-release-notes.puml` |
9
+ | Diagram | Kind | Start keywords | Highlights | Example |
10
+ | --------------- | ----------------- | ----------------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
11
+ | Sequence | `sequence` | `@startuml`, `@startsequence` | Participants, all arrow styles, activations, notes, fragments, dividers, autonumber, boxes. | `assets/examples/sequence-checkout-flow.puml.txt` |
12
+ | Class & IE | `class` | `@startuml` | Classes, interfaces, enums, generics, members, packages, all UML relations, IE crow's feet. | `assets/examples/class-shop-domain.puml.txt` |
13
+ | Activity | `activity` | `@startuml`, `@startactivity` | New syntax with if/switch/while/repeat/fork/split, partitions, notes and swimlanes. | `assets/examples/activity-order-processing.puml.txt` |
14
+ | State | `state` | `@startuml` | Composite states, concurrent regions, choice, fork/join, history, entry/exit actions. | `assets/examples/state-order-lifecycle.puml.txt` |
15
+ | Component & C4 | `component` | `@startuml` | Components, interfaces, ports, packages, nodes — and C4 via `!include <C4/...>`. | `assets/examples/component-c4-container.puml.txt` |
16
+ | Use case | `usecase` | `@startuml` | Actors, use cases, system boundaries, include/extend. | `assets/examples/usecase-checkout.puml.txt` |
17
+ | Deployment | `deployment` | `@startuml` | Nodes, clouds, databases, queues, artifacts and nested deployment targets. | `assets/examples/deployment-kubernetes.puml.txt` |
18
+ | Object | `object` | `@startuml` | Objects with fields, maps (`key => value`) and links. | `assets/examples/object-runtime-snapshot.puml.txt` |
19
+ | Timing | `timing` | `@startuml`, `@starttiming` | Robust, concise, clock, binary and analog signals with messages and constraints. | `assets/examples/timing-sensor.puml.txt` |
20
+ | Gantt | `gantt` | `@startgantt`, `@startuml` | Tasks, dependencies, milestones, progress, resources, closed days, today marker. | `assets/examples/gantt-release-plan.puml.txt` |
21
+ | Mind map | `mindmap` | `@startmindmap` | OrgMode/Markdown outlines on both sides, colours, boxless nodes. | `assets/examples/mindmap-excaliplant.puml.txt` |
22
+ | WBS | `wbs` | `@startwbs` | Work breakdown structures as org charts. | `assets/examples/wbs-website-relaunch.puml.txt` |
23
+ | JSON | `json` | `@startjson` | JSON documents as linked tables with highlights. | `assets/examples/json-api-response.puml.txt` |
24
+ | YAML | `yaml` | `@startyaml` | YAML documents as linked tables. | `assets/examples/yaml-ci-config.puml.txt` |
25
+ | ArchiMate | `archimate` | `@startuml` | ArchiMate elements by layer with icons, junctions and `Rel_*` macros. | `assets/examples/archimate-insurance.puml.txt` |
26
+ | Chen ER | `chen` | `@startchen` | Chen ER diagrams: entities, weak entities, relationships, attributes, cardinalities. | `assets/examples/chen-movie-rental.puml.txt` |
27
+ | Network | `nwdiag` | `@startnwdiag`, `@startuml` | Networks, addresses, multi-homed nodes, groups and peer links. | `assets/examples/nwdiag-office-network.puml.txt` |
28
+ | Salt wireframe | `salt` | `@startsalt`, `@startuml` | Wireframes: grids, buttons, inputs, check boxes, trees, tabs, group boxes. | `assets/examples/salt-login-dialog.puml.txt` |
29
+ | EBNF | `ebnf` | `@startebnf` | EBNF grammars as railroad diagrams. | `assets/examples/ebnf-json-grammar.puml.txt` |
30
+ | Regex | `regex` | `@startregex` | Regular expressions as railroad diagrams. | `assets/examples/regex-email.puml.txt` |
31
+ | Graphviz DOT | `dot` | `@startdot` | Graphviz DOT graphs laid out with ELK. | `assets/examples/dot-pipeline.puml.txt` |
32
+ | Chronology | `chronology` | `@startchronology` | Events and spans on a time line with links. | `assets/examples/chronology-project-history.puml.txt` |
33
+ | Files | `files` | `@startfiles` | File trees from path lists with notes. | `assets/examples/files-project-layout.puml.txt` |
34
+ | Chart | `chart` | `@startchart` | Bar, line, area and scatter charts. | `assets/examples/chart-quarterly.puml.txt` |
35
+ | AsciiMath | `math` | `@startmath` | AsciiMath formulas. | `assets/examples/math-sum-of-cubes.puml.txt` |
36
+ | LaTeX | `latex` | `@startlatex` | LaTeX formulas. | `assets/examples/latex-gaussian.puml.txt` |
37
+ | Ditaa | `ditaa` | `@startditaa`, `@startuml` | ASCII art boxes, lines, arrows and colour tags. | `assets/examples/ditaa-pipeline.puml.txt` |
38
+ | Legacy activity | `legacy-activity` | `@startuml` | The classic `(*) --> "Activity"` syntax with sync bars and branches. | `assets/examples/legacy-activity-approval.puml.txt` |
39
+ | Creole | `creole` | `@startcreole` | Rich text with headings, lists, tables and links. | `assets/examples/creole-release-notes.puml.txt` |
40
40
 
41
41
  The `kind` is what `excaliplant --list-types` prints and what the JavaScript API reports as `result.kind`.
@@ -6,232 +6,232 @@ One tested example per diagram type lives in `assets/examples/`. Copy the closes
6
6
 
7
7
  ## Sequence
8
8
 
9
- Participants, all arrow styles, activations, notes, fragments, dividers, autonumber, boxes. Source: `assets/examples/sequence-checkout-flow.puml`. More: [fragments-notes](https://github.com/grethel-labs/excaliplant/blob/main/examples/sequence/fragments-notes.puml), [lifecycle](https://github.com/grethel-labs/excaliplant/blob/main/examples/sequence/lifecycle.puml), [preprocessor](https://github.com/grethel-labs/excaliplant/blob/main/examples/sequence/preprocessor.puml).
9
+ Participants, all arrow styles, activations, notes, fragments, dividers, autonumber, boxes. Source: `assets/examples/sequence-checkout-flow.puml.txt`. More: [fragments-notes](https://github.com/grethel-labs/excaliplant/blob/main/examples/sequence/fragments-notes.puml), [lifecycle](https://github.com/grethel-labs/excaliplant/blob/main/examples/sequence/lifecycle.puml), [preprocessor](https://github.com/grethel-labs/excaliplant/blob/main/examples/sequence/preprocessor.puml).
10
10
 
11
11
  ```sh
12
- npx -y @grethel-labs/excaliplant assets/examples/sequence-checkout-flow.puml -o sequence.svg
12
+ npx -y @grethel-labs/excaliplant assets/examples/sequence-checkout-flow.puml.txt -o sequence.svg
13
13
  ```
14
14
 
15
15
  ## Class & IE
16
16
 
17
- Classes, interfaces, enums, generics, members, packages, all UML relations, IE crow's feet. Source: `assets/examples/class-shop-domain.puml`. More: [ie-schema](https://github.com/grethel-labs/excaliplant/blob/main/examples/class/ie-schema.puml), [relations](https://github.com/grethel-labs/excaliplant/blob/main/examples/class/relations.puml).
17
+ Classes, interfaces, enums, generics, members, packages, all UML relations, IE crow's feet. Source: `assets/examples/class-shop-domain.puml.txt`. More: [ie-schema](https://github.com/grethel-labs/excaliplant/blob/main/examples/class/ie-schema.puml), [relations](https://github.com/grethel-labs/excaliplant/blob/main/examples/class/relations.puml).
18
18
 
19
19
  ```sh
20
- npx -y @grethel-labs/excaliplant assets/examples/class-shop-domain.puml -o class.svg
20
+ npx -y @grethel-labs/excaliplant assets/examples/class-shop-domain.puml.txt -o class.svg
21
21
  ```
22
22
 
23
23
  ## Activity
24
24
 
25
- New syntax with if/switch/while/repeat/fork/split, partitions, notes and swimlanes. Source: `assets/examples/activity-order-processing.puml`. More: [repeat-switch](https://github.com/grethel-labs/excaliplant/blob/main/examples/activity/repeat-switch.puml), [swimlanes](https://github.com/grethel-labs/excaliplant/blob/main/examples/activity/swimlanes.puml).
25
+ New syntax with if/switch/while/repeat/fork/split, partitions, notes and swimlanes. Source: `assets/examples/activity-order-processing.puml.txt`. More: [repeat-switch](https://github.com/grethel-labs/excaliplant/blob/main/examples/activity/repeat-switch.puml), [swimlanes](https://github.com/grethel-labs/excaliplant/blob/main/examples/activity/swimlanes.puml).
26
26
 
27
27
  ```sh
28
- npx -y @grethel-labs/excaliplant assets/examples/activity-order-processing.puml -o activity.svg
28
+ npx -y @grethel-labs/excaliplant assets/examples/activity-order-processing.puml.txt -o activity.svg
29
29
  ```
30
30
 
31
31
  ## State
32
32
 
33
- Composite states, concurrent regions, choice, fork/join, history, entry/exit actions. Source: `assets/examples/state-order-lifecycle.puml`. More: [fork-history](https://github.com/grethel-labs/excaliplant/blob/main/examples/state/fork-history.puml).
33
+ Composite states, concurrent regions, choice, fork/join, history, entry/exit actions. Source: `assets/examples/state-order-lifecycle.puml.txt`. More: [fork-history](https://github.com/grethel-labs/excaliplant/blob/main/examples/state/fork-history.puml).
34
34
 
35
35
  ```sh
36
- npx -y @grethel-labs/excaliplant assets/examples/state-order-lifecycle.puml -o state.svg
36
+ npx -y @grethel-labs/excaliplant assets/examples/state-order-lifecycle.puml.txt -o state.svg
37
37
  ```
38
38
 
39
39
  ## Component & C4
40
40
 
41
- Components, interfaces, ports, packages, nodes — and C4 via `!include <C4/...>`. Source: `assets/examples/component-c4-container.puml`. More: [web-platform](https://github.com/grethel-labs/excaliplant/blob/main/examples/component/web-platform.puml).
41
+ Components, interfaces, ports, packages, nodes — and C4 via `!include <C4/...>`. Source: `assets/examples/component-c4-container.puml.txt`. More: [web-platform](https://github.com/grethel-labs/excaliplant/blob/main/examples/component/web-platform.puml).
42
42
 
43
43
  ```sh
44
- npx -y @grethel-labs/excaliplant assets/examples/component-c4-container.puml -o component.svg
44
+ npx -y @grethel-labs/excaliplant assets/examples/component-c4-container.puml.txt -o component.svg
45
45
  ```
46
46
 
47
47
  ## Use case
48
48
 
49
- Actors, use cases, system boundaries, include/extend. Source: `assets/examples/usecase-checkout.puml`. More: [library](https://github.com/grethel-labs/excaliplant/blob/main/examples/usecase/library.puml).
49
+ Actors, use cases, system boundaries, include/extend. Source: `assets/examples/usecase-checkout.puml.txt`. More: [library](https://github.com/grethel-labs/excaliplant/blob/main/examples/usecase/library.puml).
50
50
 
51
51
  ```sh
52
- npx -y @grethel-labs/excaliplant assets/examples/usecase-checkout.puml -o usecase.svg
52
+ npx -y @grethel-labs/excaliplant assets/examples/usecase-checkout.puml.txt -o usecase.svg
53
53
  ```
54
54
 
55
55
  ## Deployment
56
56
 
57
- Nodes, clouds, databases, queues, artifacts and nested deployment targets. Source: `assets/examples/deployment-kubernetes.puml`. More: [shapes](https://github.com/grethel-labs/excaliplant/blob/main/examples/deployment/shapes.puml).
57
+ Nodes, clouds, databases, queues, artifacts and nested deployment targets. Source: `assets/examples/deployment-kubernetes.puml.txt`. More: [shapes](https://github.com/grethel-labs/excaliplant/blob/main/examples/deployment/shapes.puml).
58
58
 
59
59
  ```sh
60
- npx -y @grethel-labs/excaliplant assets/examples/deployment-kubernetes.puml -o deployment.svg
60
+ npx -y @grethel-labs/excaliplant assets/examples/deployment-kubernetes.puml.txt -o deployment.svg
61
61
  ```
62
62
 
63
63
  ## Object
64
64
 
65
- Objects with fields, maps (`key => value`) and links. Source: `assets/examples/object-runtime-snapshot.puml`.
65
+ Objects with fields, maps (`key => value`) and links. Source: `assets/examples/object-runtime-snapshot.puml.txt`.
66
66
 
67
67
  ```sh
68
- npx -y @grethel-labs/excaliplant assets/examples/object-runtime-snapshot.puml -o object.svg
68
+ npx -y @grethel-labs/excaliplant assets/examples/object-runtime-snapshot.puml.txt -o object.svg
69
69
  ```
70
70
 
71
71
  ## Timing
72
72
 
73
- Robust, concise, clock, binary and analog signals with messages and constraints. Source: `assets/examples/timing-sensor.puml`. More: [web-request](https://github.com/grethel-labs/excaliplant/blob/main/examples/timing/web-request.puml).
73
+ Robust, concise, clock, binary and analog signals with messages and constraints. Source: `assets/examples/timing-sensor.puml.txt`. More: [web-request](https://github.com/grethel-labs/excaliplant/blob/main/examples/timing/web-request.puml).
74
74
 
75
75
  ```sh
76
- npx -y @grethel-labs/excaliplant assets/examples/timing-sensor.puml -o timing.svg
76
+ npx -y @grethel-labs/excaliplant assets/examples/timing-sensor.puml.txt -o timing.svg
77
77
  ```
78
78
 
79
79
  ## Gantt
80
80
 
81
- Tasks, dependencies, milestones, progress, resources, closed days, today marker. Source: `assets/examples/gantt-release-plan.puml`.
81
+ Tasks, dependencies, milestones, progress, resources, closed days, today marker. Source: `assets/examples/gantt-release-plan.puml.txt`.
82
82
 
83
83
  ```sh
84
- npx -y @grethel-labs/excaliplant assets/examples/gantt-release-plan.puml -o gantt.svg
84
+ npx -y @grethel-labs/excaliplant assets/examples/gantt-release-plan.puml.txt -o gantt.svg
85
85
  ```
86
86
 
87
87
  ## Mind map
88
88
 
89
- OrgMode/Markdown outlines on both sides, colours, boxless nodes. Source: `assets/examples/mindmap-excaliplant.puml`.
89
+ OrgMode/Markdown outlines on both sides, colours, boxless nodes. Source: `assets/examples/mindmap-excaliplant.puml.txt`.
90
90
 
91
91
  ```sh
92
- npx -y @grethel-labs/excaliplant assets/examples/mindmap-excaliplant.puml -o mindmap.svg
92
+ npx -y @grethel-labs/excaliplant assets/examples/mindmap-excaliplant.puml.txt -o mindmap.svg
93
93
  ```
94
94
 
95
95
  ## WBS
96
96
 
97
- Work breakdown structures as org charts. Source: `assets/examples/wbs-website-relaunch.puml`.
97
+ Work breakdown structures as org charts. Source: `assets/examples/wbs-website-relaunch.puml.txt`.
98
98
 
99
99
  ```sh
100
- npx -y @grethel-labs/excaliplant assets/examples/wbs-website-relaunch.puml -o wbs.svg
100
+ npx -y @grethel-labs/excaliplant assets/examples/wbs-website-relaunch.puml.txt -o wbs.svg
101
101
  ```
102
102
 
103
103
  ## JSON
104
104
 
105
- JSON documents as linked tables with highlights. Source: `assets/examples/json-api-response.puml`.
105
+ JSON documents as linked tables with highlights. Source: `assets/examples/json-api-response.puml.txt`.
106
106
 
107
107
  ```sh
108
- npx -y @grethel-labs/excaliplant assets/examples/json-api-response.puml -o json.svg
108
+ npx -y @grethel-labs/excaliplant assets/examples/json-api-response.puml.txt -o json.svg
109
109
  ```
110
110
 
111
111
  ## YAML
112
112
 
113
- YAML documents as linked tables. Source: `assets/examples/yaml-ci-config.puml`.
113
+ YAML documents as linked tables. Source: `assets/examples/yaml-ci-config.puml.txt`.
114
114
 
115
115
  ```sh
116
- npx -y @grethel-labs/excaliplant assets/examples/yaml-ci-config.puml -o yaml.svg
116
+ npx -y @grethel-labs/excaliplant assets/examples/yaml-ci-config.puml.txt -o yaml.svg
117
117
  ```
118
118
 
119
119
  ## ArchiMate
120
120
 
121
- ArchiMate elements by layer with icons, junctions and `Rel_*` macros. Source: `assets/examples/archimate-insurance.puml`.
121
+ ArchiMate elements by layer with icons, junctions and `Rel_*` macros. Source: `assets/examples/archimate-insurance.puml.txt`.
122
122
 
123
123
  ```sh
124
- npx -y @grethel-labs/excaliplant assets/examples/archimate-insurance.puml -o archimate.svg
124
+ npx -y @grethel-labs/excaliplant assets/examples/archimate-insurance.puml.txt -o archimate.svg
125
125
  ```
126
126
 
127
127
  ## Chen ER
128
128
 
129
- Chen ER diagrams: entities, weak entities, relationships, attributes, cardinalities. Source: `assets/examples/chen-movie-rental.puml`.
129
+ Chen ER diagrams: entities, weak entities, relationships, attributes, cardinalities. Source: `assets/examples/chen-movie-rental.puml.txt`.
130
130
 
131
131
  ```sh
132
- npx -y @grethel-labs/excaliplant assets/examples/chen-movie-rental.puml -o chen.svg
132
+ npx -y @grethel-labs/excaliplant assets/examples/chen-movie-rental.puml.txt -o chen.svg
133
133
  ```
134
134
 
135
135
  ## Network
136
136
 
137
- Networks, addresses, multi-homed nodes, groups and peer links. Source: `assets/examples/nwdiag-office-network.puml`.
137
+ Networks, addresses, multi-homed nodes, groups and peer links. Source: `assets/examples/nwdiag-office-network.puml.txt`.
138
138
 
139
139
  ```sh
140
- npx -y @grethel-labs/excaliplant assets/examples/nwdiag-office-network.puml -o nwdiag.svg
140
+ npx -y @grethel-labs/excaliplant assets/examples/nwdiag-office-network.puml.txt -o nwdiag.svg
141
141
  ```
142
142
 
143
143
  ## Salt wireframe
144
144
 
145
- Wireframes: grids, buttons, inputs, check boxes, trees, tabs, group boxes. Source: `assets/examples/salt-login-dialog.puml`.
145
+ Wireframes: grids, buttons, inputs, check boxes, trees, tabs, group boxes. Source: `assets/examples/salt-login-dialog.puml.txt`.
146
146
 
147
147
  ```sh
148
- npx -y @grethel-labs/excaliplant assets/examples/salt-login-dialog.puml -o salt.svg
148
+ npx -y @grethel-labs/excaliplant assets/examples/salt-login-dialog.puml.txt -o salt.svg
149
149
  ```
150
150
 
151
151
  ## EBNF
152
152
 
153
- EBNF grammars as railroad diagrams. Source: `assets/examples/ebnf-json-grammar.puml`.
153
+ EBNF grammars as railroad diagrams. Source: `assets/examples/ebnf-json-grammar.puml.txt`.
154
154
 
155
155
  ```sh
156
- npx -y @grethel-labs/excaliplant assets/examples/ebnf-json-grammar.puml -o ebnf.svg
156
+ npx -y @grethel-labs/excaliplant assets/examples/ebnf-json-grammar.puml.txt -o ebnf.svg
157
157
  ```
158
158
 
159
159
  ## Regex
160
160
 
161
- Regular expressions as railroad diagrams. Source: `assets/examples/regex-email.puml`.
161
+ Regular expressions as railroad diagrams. Source: `assets/examples/regex-email.puml.txt`.
162
162
 
163
163
  ```sh
164
- npx -y @grethel-labs/excaliplant assets/examples/regex-email.puml -o regex.svg
164
+ npx -y @grethel-labs/excaliplant assets/examples/regex-email.puml.txt -o regex.svg
165
165
  ```
166
166
 
167
167
  ## Graphviz DOT
168
168
 
169
- Graphviz DOT graphs laid out with ELK. Source: `assets/examples/dot-pipeline.puml`.
169
+ Graphviz DOT graphs laid out with ELK. Source: `assets/examples/dot-pipeline.puml.txt`.
170
170
 
171
171
  ```sh
172
- npx -y @grethel-labs/excaliplant assets/examples/dot-pipeline.puml -o dot.svg
172
+ npx -y @grethel-labs/excaliplant assets/examples/dot-pipeline.puml.txt -o dot.svg
173
173
  ```
174
174
 
175
175
  ## Chronology
176
176
 
177
- Events and spans on a time line with links. Source: `assets/examples/chronology-project-history.puml`.
177
+ Events and spans on a time line with links. Source: `assets/examples/chronology-project-history.puml.txt`.
178
178
 
179
179
  ```sh
180
- npx -y @grethel-labs/excaliplant assets/examples/chronology-project-history.puml -o chronology.svg
180
+ npx -y @grethel-labs/excaliplant assets/examples/chronology-project-history.puml.txt -o chronology.svg
181
181
  ```
182
182
 
183
183
  ## Files
184
184
 
185
- File trees from path lists with notes. Source: `assets/examples/files-project-layout.puml`.
185
+ File trees from path lists with notes. Source: `assets/examples/files-project-layout.puml.txt`.
186
186
 
187
187
  ```sh
188
- npx -y @grethel-labs/excaliplant assets/examples/files-project-layout.puml -o files.svg
188
+ npx -y @grethel-labs/excaliplant assets/examples/files-project-layout.puml.txt -o files.svg
189
189
  ```
190
190
 
191
191
  ## Chart
192
192
 
193
- Bar, line, area and scatter charts. Source: `assets/examples/chart-quarterly.puml`.
193
+ Bar, line, area and scatter charts. Source: `assets/examples/chart-quarterly.puml.txt`.
194
194
 
195
195
  ```sh
196
- npx -y @grethel-labs/excaliplant assets/examples/chart-quarterly.puml -o chart.svg
196
+ npx -y @grethel-labs/excaliplant assets/examples/chart-quarterly.puml.txt -o chart.svg
197
197
  ```
198
198
 
199
199
  ## AsciiMath
200
200
 
201
- AsciiMath formulas. Source: `assets/examples/math-sum-of-cubes.puml`.
201
+ AsciiMath formulas. Source: `assets/examples/math-sum-of-cubes.puml.txt`.
202
202
 
203
203
  ```sh
204
- npx -y @grethel-labs/excaliplant assets/examples/math-sum-of-cubes.puml -o math.svg
204
+ npx -y @grethel-labs/excaliplant assets/examples/math-sum-of-cubes.puml.txt -o math.svg
205
205
  ```
206
206
 
207
207
  ## LaTeX
208
208
 
209
- LaTeX formulas. Source: `assets/examples/latex-gaussian.puml`.
209
+ LaTeX formulas. Source: `assets/examples/latex-gaussian.puml.txt`.
210
210
 
211
211
  ```sh
212
- npx -y @grethel-labs/excaliplant assets/examples/latex-gaussian.puml -o latex.svg
212
+ npx -y @grethel-labs/excaliplant assets/examples/latex-gaussian.puml.txt -o latex.svg
213
213
  ```
214
214
 
215
215
  ## Ditaa
216
216
 
217
- ASCII art boxes, lines, arrows and colour tags. Source: `assets/examples/ditaa-pipeline.puml`.
217
+ ASCII art boxes, lines, arrows and colour tags. Source: `assets/examples/ditaa-pipeline.puml.txt`.
218
218
 
219
219
  ```sh
220
- npx -y @grethel-labs/excaliplant assets/examples/ditaa-pipeline.puml -o ditaa.svg
220
+ npx -y @grethel-labs/excaliplant assets/examples/ditaa-pipeline.puml.txt -o ditaa.svg
221
221
  ```
222
222
 
223
223
  ## Legacy activity
224
224
 
225
- The classic `(*) --> "Activity"` syntax with sync bars and branches. Source: `assets/examples/legacy-activity-approval.puml`.
225
+ The classic `(*) --> "Activity"` syntax with sync bars and branches. Source: `assets/examples/legacy-activity-approval.puml.txt`.
226
226
 
227
227
  ```sh
228
- npx -y @grethel-labs/excaliplant assets/examples/legacy-activity-approval.puml -o legacy-activity.svg
228
+ npx -y @grethel-labs/excaliplant assets/examples/legacy-activity-approval.puml.txt -o legacy-activity.svg
229
229
  ```
230
230
 
231
231
  ## Creole
232
232
 
233
- Rich text with headings, lists, tables and links. Source: `assets/examples/creole-release-notes.puml`.
233
+ Rich text with headings, lists, tables and links. Source: `assets/examples/creole-release-notes.puml.txt`.
234
234
 
235
235
  ```sh
236
- npx -y @grethel-labs/excaliplant assets/examples/creole-release-notes.puml -o creole.svg
236
+ npx -y @grethel-labs/excaliplant assets/examples/creole-release-notes.puml.txt -o creole.svg
237
237
  ```
@@ -2,35 +2,35 @@
2
2
  "name": "excaliplant",
3
3
  "files": [
4
4
  "SKILL.md",
5
- "assets/examples/activity-order-processing.puml",
6
- "assets/examples/archimate-insurance.puml",
7
- "assets/examples/chart-quarterly.puml",
8
- "assets/examples/chen-movie-rental.puml",
9
- "assets/examples/chronology-project-history.puml",
10
- "assets/examples/class-shop-domain.puml",
11
- "assets/examples/component-c4-container.puml",
12
- "assets/examples/creole-release-notes.puml",
13
- "assets/examples/deployment-kubernetes.puml",
14
- "assets/examples/ditaa-pipeline.puml",
15
- "assets/examples/dot-pipeline.puml",
16
- "assets/examples/ebnf-json-grammar.puml",
17
- "assets/examples/files-project-layout.puml",
18
- "assets/examples/gantt-release-plan.puml",
19
- "assets/examples/json-api-response.puml",
20
- "assets/examples/latex-gaussian.puml",
21
- "assets/examples/legacy-activity-approval.puml",
22
- "assets/examples/math-sum-of-cubes.puml",
23
- "assets/examples/mindmap-excaliplant.puml",
24
- "assets/examples/nwdiag-office-network.puml",
25
- "assets/examples/object-runtime-snapshot.puml",
26
- "assets/examples/regex-email.puml",
27
- "assets/examples/salt-login-dialog.puml",
28
- "assets/examples/sequence-checkout-flow.puml",
29
- "assets/examples/state-order-lifecycle.puml",
30
- "assets/examples/timing-sensor.puml",
31
- "assets/examples/usecase-checkout.puml",
32
- "assets/examples/wbs-website-relaunch.puml",
33
- "assets/examples/yaml-ci-config.puml",
5
+ "assets/examples/activity-order-processing.puml.txt",
6
+ "assets/examples/archimate-insurance.puml.txt",
7
+ "assets/examples/chart-quarterly.puml.txt",
8
+ "assets/examples/chen-movie-rental.puml.txt",
9
+ "assets/examples/chronology-project-history.puml.txt",
10
+ "assets/examples/class-shop-domain.puml.txt",
11
+ "assets/examples/component-c4-container.puml.txt",
12
+ "assets/examples/creole-release-notes.puml.txt",
13
+ "assets/examples/deployment-kubernetes.puml.txt",
14
+ "assets/examples/ditaa-pipeline.puml.txt",
15
+ "assets/examples/dot-pipeline.puml.txt",
16
+ "assets/examples/ebnf-json-grammar.puml.txt",
17
+ "assets/examples/files-project-layout.puml.txt",
18
+ "assets/examples/gantt-release-plan.puml.txt",
19
+ "assets/examples/json-api-response.puml.txt",
20
+ "assets/examples/latex-gaussian.puml.txt",
21
+ "assets/examples/legacy-activity-approval.puml.txt",
22
+ "assets/examples/math-sum-of-cubes.puml.txt",
23
+ "assets/examples/mindmap-excaliplant.puml.txt",
24
+ "assets/examples/nwdiag-office-network.puml.txt",
25
+ "assets/examples/object-runtime-snapshot.puml.txt",
26
+ "assets/examples/regex-email.puml.txt",
27
+ "assets/examples/salt-login-dialog.puml.txt",
28
+ "assets/examples/sequence-checkout-flow.puml.txt",
29
+ "assets/examples/state-order-lifecycle.puml.txt",
30
+ "assets/examples/timing-sensor.puml.txt",
31
+ "assets/examples/usecase-checkout.puml.txt",
32
+ "assets/examples/wbs-website-relaunch.puml.txt",
33
+ "assets/examples/yaml-ci-config.puml.txt",
34
34
  "assets/rules.md",
35
35
  "references/cli.md",
36
36
  "references/diagram-types.md",