Installation

runemark ships as a Rust crate and as a native Node.js package. Both use the same Rust renderer, so output matches across ecosystems.

RustNode

cargo add runemark

# with the terminal progress sink (adds indicatif)
cargo add runemark --features progress

npm install @casoon/runemark

const { RunemarkConsole } = require('@casoon/runemark')

Requirements

Runtime	Minimum	Notes
Rust (crate)	`1.85`	Edition 2024. One required dependency, `unicode-width`.
Node.js	`20`	Node-API 8. CommonJS package with TypeScript declarations.

The npm package contains prebuilt native binaries. Each one is built and smoke-tested in CI before a release.

Caution

Use @casoon/runemark 0.3.1 or newer. Version 0.3.0 on npm contained only the macOS arm64 binary.

Continue with the Quickstart.