grunt-fontfactory v1.1.1

grunt-fontfactory

Create a font from multiple SVG glyph files

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-fontfactory --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-fontfactory');

The "fontfactory" task

Overview

In your project's Gruntfile, add a section named fontfactory to the data object passed into grunt.initConfig().

grunt.initConfig({
  fontfactory: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

src

Type: string

SVG glyphs. Wildcards are supported.

dest

Type: string

Directory for resulting font.

options.font

Type: String Default value: 'my-font'

A string value that is used to name your font-family.

Usage Examples

grunt.initConfig({
  fontfactory: {
    options: {
      font: "my-font-name"
    },
    src: 'glyphs/*.svg',
    dest: 'font/'
  },
})