https://github.com/jcxldn/fontx

A npm package to make working with fonts easier.
https://github.com/jcxldn/fontx

cli converter font fontkit npm-package otf svg ttf woff woff2 yargs

Last synced: 20 days ago
JSON representation

A npm package to make working with fonts easier.

• Host: GitHub
• URL: https://github.com/jcxldn/fontx
• Owner: jcxldn
• License: mit
• Created: 2019-12-14T15:41:09.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-12-19T13:01:16.000Z (about 5 years ago)
• Last Synced: 2024-12-09T16:30:51.748Z (24 days ago)
• Topics: cli, converter, font, fontkit, npm-package, otf, svg, ttf, woff, woff2, yargs
• Language: JavaScript
• Size: 331 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FontX

[![npm](https://img.shields.io/npm/v/fontx)

![node](https://img.shields.io/node/v/fontx)](https://www.npmjs.com/package/fontx)

A npm package to make working with fonts easier.

## Installation

`npm i fontx --save`

You'll need Node.JS 6 or newer.

If you want to use the command-line interface you'll probably want to install it globally so that you can run `fontx` from anywhere.

`npm i -g fontx`

## CLI

```

fontx 

Commands:

  fontx export    export all glyphs to a folder

  fontx web                  start the webserver

Options:

  --help, -h     Show help                                             [boolean]

  --version, -v  Show version number                                   [boolean]

```

## API

From [example.js](example.js):

```node

const fontx = require("./api");

// Initialise the core (required)

const core = fontx.Core("font.ttf");

// Start the Express webserver

fontx.Express(core, 3000);

// Export all glyphs to a folder

fontx.Export(core, "out");

```

## v1.2 Feat: Dynamic SVGs

![Introducing Dynamic SVG (v1.2 or later)](./.md_resources/dyn_svg.png)