nerd-fonts-woff2

v1.0.5

Published

a month ago

CLI pipeline for converting Nerd Fonts (and other fonts) from TTF/OTF to WOFF2 assets.

0High
0Medium
0Low

typpi

fonts woff2 nerdfonts nerd-font nerd-fonts cli webfont ttf conversion

nerd-fonts-woff2

Ready-to-use Nerd Fonts in WOFF2 format — use them in any website or app via CDN link, or install them through npm.

No build step needed. No tools to install. Just copy a URL.

Fonts are generated from Nerd Fonts v3.4.0 and committed directly to this repository so they can be served from a stable CDN URL.

Quick start — add a font to your website

Pick any font from the available families below and add a @font-face rule to your CSS.

jsDelivr CDN (recommended — global CDN, fast, always available)

@font-face {
  font-family: "JetBrains Mono Nerd";
  src: url("https://cdn.jsdelivr.net/gh/Nick2bad4u/[email protected]/fonts/woff2/JetBrainsMono/JetBrainsMonoNerdFont-Regular.woff2")
    format("woff2");
  font-display: swap;
}

Then use it in your CSS:

body {
  font-family: "JetBrains Mono Nerd", monospace;
}

Raw GitHub URL

@font-face {
  font-family: "JetBrains Mono Nerd";
  src: url("https://raw.githubusercontent.com/Nick2bad4u/nerd-fonts-woff2/v1.0.0/fonts/woff2/JetBrainsMono/JetBrainsMonoNerdFont-Regular.woff2")
    format("woff2");
  font-display: swap;
}

Tip: Always pin a version tag (v1.0.0) rather than using main so your fonts never change unexpectedly.

URL pattern

All font files follow this pattern:

https://cdn.jsdelivr.net/gh/Nick2bad4u/nerd-fonts-woff2@<version>/fonts/woff2/<Family>/<FileName>.woff2

| Part | Example | | ------------ | ------------------------------- | | <version> | v1.0.0 | | <Family> | JetBrainsMono | | <FileName> | JetBrainsMonoNerdFont-Regular |

Find available files by browsing the fonts/woff2/ folder in this repository, or see the full asset index.

You can also browse a searchable index page on GitHub Pages: /index.html

Install via npm

The npm package ships the CLI conversion tool only — font files are not bundled. To use fonts in a website or app, use the CDN URLs above (no install needed).

npm install nerd-fonts-woff2
# or globally
npm install -g nerd-fonts-woff2

Package size: ~86 KB unpacked (just the CLI binary + compiled JS).

The fonts themselves are served from CDN (jsDelivr, unpkg, Raw GitHub, etc.). Bundling 7 GB of binary font files into npm would be impractical — use a CDN URL instead.

CLI usage

The CLI converts local TTF/OTF font files into WOFF2 format.

Usage

npx nerd-fonts-woff2 --source-dir <path> [options]
# or if installed globally:
nerd-fonts-woff2 --source-dir <path> [options]

Core options

| Flag | Description | | ------------------------------- | ------------------------------------------------------------ | | --source-dir <path[,path...]> | Source directory containing .ttf/.otf files (repeatable) | | --manifest <file> | JSON config file (optional alternative to CLI flags) | | --out-dir <path> | Output directory for generated .woff2 files | | --temp-dir <path> | Temporary working directory | | --include-ext <ttf,otf> | Input extensions to process (default: ttf,otf) | | --max-files <n> | Limit number of files to process |

Conversion options

| Flag | Description | | ------------------------- | ------------------------------------------------------ | | --convert | Run conversion pipeline (default mode is plan/dry-run) | | --dry-run | Plan only — do not call the external converter | | --confirm, --yes | Required safety gate for non-dry-run conversion | | --converter <cmd> | Converter executable (default: woff2_compress) | | --converter-arg <value> | Extra converter arguments (repeatable) | | --fail-fast | Stop on first conversion failure | | --concurrency <n> | Number of concurrent conversions (default: 1) | | --timeout <ms> | Per-file converter timeout in ms (default: 60000) |

Output options

| Flag | Description | | --------------------- | -------------------------------------------------------- | | --index-file <path> | Write asset index JSON (default: <out-dir>/index.json) | | --verbose | Print planned files and failures | | --debug | Enable debug output (implies --verbose) | | --json | Emit machine-readable summary to stdout | | --help | Show help |

Examples

# Dry run — plan only, no files written (safe default)
npx nerd-fonts-woff2 --source-dir ./fonts/original --dry-run

# Convert with explicit safety confirmation
npx nerd-fonts-woff2 --source-dir ./fonts/original --convert --confirm

# Faster — 4 concurrent workers, 2 min timeout per file
npx nerd-fonts-woff2 --source-dir ./fonts/original --convert --confirm --concurrency 4 --timeout 120000

# Machine-readable JSON output + explicit index file path
npx nerd-fonts-woff2 --source-dir ./fonts/original --convert --confirm --json --index-file ./fonts/woff2/index.json

# Use a manifest config file instead of flags
npx nerd-fonts-woff2 --manifest ./nerd-fonts-woff2.config.json --convert --confirm --json

# Convert multiple source directories
npx nerd-fonts-woff2 --source-dir ./fonts/originals,./fonts/extras --convert --confirm

Available font families

All families from Nerd Fonts v3.4.0 are included.

Browse the full list in the fonts/woff2/ directory, or search the interactive browser.

Popular families by reserved font name (see Reserved Font Name mechanism).

For example, the Monaspice Nerd Font family is available as Monaspace in the URL path and file names:

Font Name vs Reserved Font Name

What are Nerd Fonts?

Nerd Fonts patches developer-targeted fonts with a large number of glyphs (icons) from popular icon sets — including Devicons, Font Awesome, Material Design Icons, and plenty of others.

They are widely used in terminal emulators, code editors, and shell prompts (Starship, Oh-My-Zsh, Powerlevel10k, etc.).

Releases and versioning

Font assets are updated on each tagged release. Check the Releases page for the latest version and changelog.

Pin the version in your CDN URLs to avoid unexpected changes.

License

Fonts are distributed under their respective upstream licenses (see each family's source in Nerd Fonts). This project's tooling and scripts are licensed under the MIT License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

nerd-fonts-woff2

Quick start — add a font to your website

jsDelivr CDN (recommended — global CDN, fast, always available)

Raw GitHub URL

URL pattern

Install via npm

CLI usage

Usage

Core options

Conversion options

Output options

Examples

Available font families

What are Nerd Fonts?

Releases and versioning

License

Links

Contributors ✨