vf-web-kit
v0.1.1
Published
Build production-ready variable font web kits with subsetting, CSS, tokens, and a specimen.
Maintainers
Readme
Variable Font Web Kit
Ship variable fonts safely and fast. Subset glyphs, clamp axes, and ship production-ready kits. Outputs CSS, tokens, and a specimen page for immediate QA.
Type: CLI + Library (Node.js)
[!IMPORTANT] Provide representative content or strings to avoid missing glyphs in the subset.
Highlights
- Subsets glyphs and clamps axes safely.
- Outputs production-ready web font kits.
- Includes specimen page for QA.
Output
Example artifacts live in examples/.
Need help? Start with docs/troubleshooting.md.
Kit outputs include fonts, CSS, tokens, and a specimen page. See docs/kit-contents.md.
Quickstart
npx vf-web-kit path/to/font.ttf --content "./content/**/*.{html,md,mdx,tsx}" --out ./dist/fontkitCI in 60s
- name: Build font kit
run: npx vf-web-kit path/to/font.ttf --content './content/**/*.{md,tsx}' --out ./dist/fontkitDemo

vf-web-kit font.woff2 --strings "Hamburgefontsiv 0123456789" --out ./dist/fontkitCompatibility
- Node.js: 20 (CI on ubuntu-latest).
- OS: Linux in CI; macOS/Windows unverified.
- External deps: none.
Guarantees & Non-Goals
Guarantees
- Outputs a web-ready kit (fonts, CSS, tokens, specimen).
- Deterministic given the same inputs and tool version (metadata may vary).
Non-Goals
- Not a full font editor.
- Does not generate new glyphs.
Docs
- Requirements
- Installation
- Configuration
- Presets
- Kit Contents
- Troubleshooting
- Guarantees & Non-Goals
- Constraints
- Reproducibility
More: docs/README.md
Examples
See examples/README.md for inputs and expected outputs.
Used By
Open a PR to add your org.
Contributing
See CONTRIBUTING.md.
License
MIT.
