webfonts-generator's Introduction

@momentum-ui/webfonts-generator

This webfonts generator takes SVG icons and transform them to WOFF and WOFF 2 fonts.

Developed specifically for the needs of Cisco's Momentum design system, this project is quite opinionated but open to features request and PRs nonetheless.

Despite being written from scratch, this project was inspired by the (now archived) project webfonts-generator project.

Caveats

Technically generates SVG and TTF fonts too, because they are necessary steps to get WOFF fonts from SVG files with today's tools.
Only runs on Node.JS 10 or better (because the source code relies heavily on async/await).
Never tested on Windows (but should work).
Does not generate EOT font (unecessary, woff and woff2 cover all modern browsers as well as IE9 and IE10).
There is no CLI, only a Node.JS API (PR welcome).
There is no way to pass down options to some of the tools used under the hood (svg2ttf, ttf2woff and wawoff2).
You can pass down the following options for svgicons2svgfont, :
- normalize: boolean
- fontHeight: number

Usage

const { generateFonts } = require("@momentum-ui/webfonts-generator");
const options = {};

generateFonts("My Awesome Font", "icons/*.svg", "fonts", options).then(
  result => {
    console.log(`Webfont ${result.fontName} created!`);
    console.log(`WOFF file: ${result.fontFiles.woff}`);
    console.log(`WOFF2 file: ${result.fontFiles.woff2}`);
    console.log(`Glyphs information:`, result.glyphsData);
  }
);