zombie-mermaid 1.7.0 → 2.1.0

package/README.md

@@ -129,13 +129,30 @@ Installing the package also exposes a `zombie-mermaid` binary:
 
 ```bash
 zombie-mermaid render diagram.mmd --ascii              # Print ASCII/Unicode to terminal
-zombie-mermaid render diagram.mmd --svg -o out.svg      # Render to an SVG file
+zombie-mermaid render diagram.mmd --svg                 # Render to diagram.svg (name from the input)
+zombie-mermaid render diagram.mmd --svg -o out.svg      # Render to a named SVG file
+zombie-mermaid render diagram.mmd --svg -o out.svg --resolve-colors   # …with concrete colors, for resvg/Inkscape/etc.
+zombie-mermaid render diagram.mmd -o out.svg            # Same — the format is inferred from .svg
+zombie-mermaid render diagram.mmd --svg -o - | pbcopy   # Write the SVG to stdout
+zombie-mermaid render diagram.mmd --ascii -o out.txt    # Write the ASCII rendering to a file
+zombie-mermaid render diagram.mmd --html                # Self-contained pan/zoom HTML viewer
+zombie-mermaid render diagram.mmd --png                 # Rasterize to diagram.png
 cat diagram.mmd | zombie-mermaid render --ascii         # Read from stdin
 zombie-mermaid themes                                   # List built-in theme names
 zombie-mermaid --help                                   # Show all options
 ```
 
-`--theme <name>` applies a built-in theme (from `themes`) to either output mode.
+`--theme <name>` applies a built-in theme (from `themes`) to either output mode. `--resolve-colors` replaces the CSS `var()`/`color-mix()` theming in SVG output with computed colors so rasterizers that don't evaluate CSS (resvg, librsvg, Inkscape) render the theme instead of black — see [docs/theming.md](docs/theming.md#resolved-colors-for-rasterizers).
+`--direction <dir>` (`TD`, `TB`, `BT`, `LR`, or `RL`) overrides the diagram's layout direction in either output mode without editing the source — flowchart, state, and ER diagrams; a nested subgraph's own `direction` still applies on top of it. The same override is available to library callers as the `direction` render option (see [API Reference](docs/api-reference.md)).
+`--hyperlinks` (with `--ascii`) turns `click` hrefs into OSC 8 terminal
+hyperlinks — off by default, since terminal and pager support varies (see
+[ASCII terminal hyperlinks](docs/diagrams.md#ascii-terminal-hyperlinks)).
+
+**Output rules.** `-o` is the destination for the run's _file_ output — SVG, HTML, or PNG when `--svg`/`--html`/`--png` is given, otherwise the ASCII rendering — and `-o -` sends it to stdout instead. A recognised extension (`.svg`, `.html`/`.htm`, `.txt`, `.png`) picks the format on its own, so the flag can be dropped; an extension that contradicts an explicit flag (`--svg -o out.txt`) is an error, while unrecognised ones are simply used as given. `--svg`/`--html`/`--png` with no `-o` writes `<input stem>.svg`/`.html`/`.png` beside the input (stdin input has no name to derive from, so it must pass `-o`). Only one of `--svg`/`--html`/`--png` can be set at a time — run the command twice for more than one. ASCII always prints to the terminal when one of them is also requested (`--ascii --svg -o out.svg`), and never carries ANSI colour codes when written to a file. **An existing output file is never overwritten unless you pass `--force`/`-f`.**
+
+**`--html`** wraps the rendered SVG in a self-contained pan/zoom viewer — one file, no server, no network — with drag/scroll pan, ctrl/cmd+scroll and pinch to zoom, fit/1:1 buttons, a light/dark toggle that follows `prefers-color-scheme`, and keyboard controls. It opens straight from disk and survives being emailed as a single attachment. This is the one place in the project that ships client-side JavaScript, and deliberately so — see [`docs/decisions/no-script-interactivity.md`](docs/decisions/no-script-interactivity.md): the library's own SVG output stays permanently script-free, and this viewer is a separate CLI artifact wrapping that output, never part of it.
+
+**`--png`** rasterizes the diagram for anywhere SVG isn't accepted — issue trackers, Slack, docs tools, email — at the SVG's own pixel dimensions (1:1, no scaling). It always resolves CSS colors first, automatically, the same substitution `--resolve-colors` does for `--svg` — a rasterizer can't evaluate `var()`/`color-mix()`, so skipping this would render the whole theme black. Rasterization is via [`@resvg/resvg-js`](https://github.com/thx/resvg-js), listed as an `optionalDependency`: a normal install pulls its native binary like any other dependency, but a platform it has no prebuilt binary for, or an install run with `--no-optional`, simply skips it — `--png` then fails with a clear error telling you how to install it explicitly, rather than breaking the rest of the CLI.
 
 ---