Installation

cargo add lightweight-pdf

# or, in Cargo.toml
[dependencies]
lightweight-pdf = "0.3"

cargo install lightweight-pdf-cli   # installs the `lwpdf` binary

# or from a clone of the repository
cargo install --path crates/lightweight-pdf-cli

# from a clone of the repository
cd bindings/js
npm install
npm run build

Rust crate

lightweight-pdf is the crate to depend on; it re-exports the builder API and adds render(). The other workspace crates are its building blocks (see workspace crates).

Two features are on by default:

• default-fonts bundles Source Sans 3 (regular and bold), so Document::render() works without any font setup.
• compress Flate-compresses content streams, font programs and image samples.

Everything else is opt-in, for example PNG support or the JSON format:

cargo add lightweight-pdf --features png,serde

The full list is in Cargo features.

CLI

lwpdf renders the JSON document and template format without writing Rust. It lives in its own crate, lightweight-pdf-cli, so the library never depends on clap. See the CLI guide for commands and exit codes.

JavaScript and WASM

bindings/js contains the @casoon/lightweight-pdf package: the Rust engine compiled to WASM with wasm-bindgen, plus TypeScript types generated from the document JSON Schema. The build needs the Rust toolchain with the wasm32-unknown-unknown target, wasm-pack and wasm-opt (binaryen).