excalirender

Render Excalidraw .excalidraw files to SVG or PNG — no browser needed.

Roughjs-powered sketch style with embedded hand-drawn fonts (Virgil + ZCOOL KuaiLe). Zero browser dependencies.

npm install excalirender

CLI

excalirender scene.excalidraw                    # → ./scene.svg
excalirender scene.excalidraw -o out.png         # → ./out.png
excalirender scene.excalidraw -o out.svg --no-sketch

API

import excalirender from "excalirender";

// Default: SVG, sketch on, white background
await excalirender("scene.excalidraw");

// Format auto-detected from output extension
await excalirender("scene.excalidraw", { output: "out.png" });
await excalirender("scene.excalidraw", { output: "out.svg" });

// Options
await excalirender("scene.excalidraw", { output: "out.png", sketch: false });
await excalirender("scene.excalidraw", { background: false });

| Option | Default | Description | |--------|---------|-------------| | output | ./<basename>.svg | Output path (.svg or .png) | | sketch | true | Roughjs hand-drawn style | | background | true | White background |

| Return | Description | |--------|-------------| | Promise<string> | The output file path |

not affiliated with Excalidraw

Release

npm run release              # patch (0.1.0 → 0.1.1)
npm run release -- minor     # minor  (0.1.0 → 0.2.0)
npm run release -- major     # major  (0.1.0 → 1.0.0)

Bumps version, creates a git tag, and pushes — GitHub Actions publishes to npm automatically.

License

MIT