Docs

Quickstart

From nothing to a font file in a few lines. Pick the SDK or the API: both make the same font.

With the SDK

1. Get the package

Download it from your account. It's an npm package in a single file, with the engine inside:

Terminal

npm install ./typomat-engine-0.1.0.tgz

2. Compile a font

make-font.mjs

import { writeFile } from "node:fs/promises";
import { createEngine } from "@typomat/engine";

const engine = await createEngine({ licenseKey: process.env.TYPOMAT_LICENSE });

const ttf = engine.compile(
  { weight: 118, contrast: 0.92, serif: 0.5, xHeight: 470 },
  { name: "Acme Display" },
);

await writeFile("acme-display.ttf", ttf);

3. Or use it in the browser

The same code runs there, and you can load the font straight into the page. Most bundlers pick up engine.wasm by themselves. If yours doesn't, serve the file and pass its address as wasm.

In the browser

const face = new FontFace("Acme Display", ttf);
document.fonts.add(await face.load());
document.body.style.fontFamily = "Acme Display";

With the API

Make a key in your account, and send it with a few parameters. The free trial gives you one straight away, with no card. The response is the font file: