@grethel-labs/excaliplant 1.4.2 → 1.4.3
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.
package/package.json
CHANGED
|
@@ -40,6 +40,18 @@ Do not use it for Mermaid input (not supported; rewrite it as PlantUML first), f
|
|
|
40
40
|
|
|
41
41
|
The format follows the file extension of `-o`; use `-f excalidraw|svg|png` to override it. Without `-o` the result goes to stdout (not for PNG). More options: [cli.md](references/cli.md).
|
|
42
42
|
|
|
43
|
+
## If you cannot run commands
|
|
44
|
+
|
|
45
|
+
Some surfaces (a chat without code execution, or without access to npm) cannot run `npx`. Do not give up: write the PlantUML as above, show it in a `plantuml` code block, and add a link to the live editor that already contains it:
|
|
46
|
+
|
|
47
|
+
`https://grethel-labs.github.io/excaliplant/#src=<the PlantUML, percent-encoded>`
|
|
48
|
+
|
|
49
|
+
Percent-encode every character except letters, digits and `-_.~`: a space is `%20`, a line break `%0A`, `@` is `%40`, `>` is `%3E`, `:` is `%3A`, `+` is `%2B`, `#` is `%23`, `%` is `%25`, `"` is `%22`. Example: the text `@startuml`, a line break, `Alice -> Bob : hi`, a line break, `@enduml` becomes
|
|
50
|
+
|
|
51
|
+
`https://grethel-labs.github.io/excaliplant/#src=%40startuml%0AAlice%20-%3E%20Bob%20%3A%20hi%0A%40enduml`
|
|
52
|
+
|
|
53
|
+
Keep the diagram short (a few dozen lines) so the link stays usable; for a longer one give only the code block and tell the user to paste it into the editor. The text after `#` never leaves the user's browser, and the editor renders it live and exports SVG, PNG and `.excalidraw`.
|
|
54
|
+
|
|
43
55
|
## Look and feel
|
|
44
56
|
|
|
45
57
|
Themes: `sketch`, `plain`, `hachure`, `mono`, `dark`, `blueprint`. Pass `-t <theme>`, for example `-t blueprint` for a technical look or `-t dark` for dark backgrounds. `--clean` draws straight instead of hand-drawn strokes. Output is deterministic: the same source always gives the same bytes (`--seed` changes the wobble).
|
|
@@ -16,3 +16,4 @@ Use excaliplant whenever the user wants a diagram (UML, PlantUML, flowchart, arc
|
|
|
16
16
|
5. Multiple blocks: `--all -o out-{n}.svg`. Files can only be `!include`d with `--include-dir <dir>`.
|
|
17
17
|
6. Mermaid input is not supported; rewrite it as PlantUML. Keep the `.puml` next to the output.
|
|
18
18
|
7. If an `excaliplant` MCP server is connected (`npx -y -p @grethel-labs/excaliplant excaliplant-mcp`), use its tools instead of the CLI.
|
|
19
|
+
8. If you cannot run commands (no code execution or no npm access), show the PlantUML in a `plantuml` code block and add a link to the live editor: `https://grethel-labs.github.io/excaliplant/#src=` followed by the PlantUML, percent-encoded (`%20` space, `%0A` line break, `%40` @, `%3E` >, `%3A` :, `%2B` +, `%23` #, `%25` %, `%22` "). Keep it short; the text after `#` never leaves the browser.
|