Installation

Requirements

• Node.js 16+ (or Deno / Bun).
• A platform with a skia-canvas prebuilt binary — macOS, Linux, and Windows on common architectures are supported.

Install

npm install sone

skia-canvas is a peer dependency. On most platforms npm install will pick up a prebuilt native binary automatically. If installation fails, follow the skia-canvas instructions for your platform.

Optional dependencies

• Syntax highlighting — npm install shiki to enable code blocks via sone/shiki. See Shiki integration.

Hyphenation patterns ship with Sone, so .hyphenate(locale) works out of the box — no extra install needed.

TypeScript

Sone ships with full TypeScript types. No additional @types/* package required.

Next.js

Externalize the native module so the bundler doesn't try to inline it:

// next.config.ts
import type { NextConfig } from "next";

const nextConfig: NextConfig = {
  serverExternalPackages: ["skia-canvas"],
  webpack: (config, options) => {
    if (options.isServer) {
      config.externals = [
        ...config.externals,
        { "skia-canvas": "commonjs skia-canvas" },
      ];
    }
    return config;
  },
};

export default nextConfig;

Browser

Import from the browser entry instead of the default. The browser build does not include PDF or SVG output — those require the Node.js backend. See Browser usage.