Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 2.12 KB

README.md

File metadata and controls

86 lines (66 loc) · 2.12 KB
Raw

grunt-fontgen

Generate webfonts and css ready to use on your site

Getting Started

This plugin requires Grunt ~0.4.5

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-fontgen --save-dev

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

grunt.loadNpmTasks('grunt-fontgen');

The "fontgen" task

Overview

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

grunt.initConfig({
  fontgen: {
    options: {
      // Task-specific options go here.
    },
    all: {
      options: {
        path_prefix: '../fonts/',
        stylesheet: '<%= dest_css %>/fonts.css',
      },
      files: [{
        src: [
          '<%= src %>/<%= font_dir %>/*.otf'
          '<%= src %>/<%= font_dir %>/*.ttf',
        ],
        dest: '<%= dest %>/<%= font_dir %>'
      }]
    }
  },
});

Options

options.path_prefix

Type: String Default value: ''

The path to the font files relative to the css file generated.

options.stylesheet

Type: String Default value: 'fonts.css'

Path and name of the css file to generate with the fonts available.

Usage Examples

Default Options

Only OTF and TTF source fonts are supported by default.

Fonts may also have a json file associated with custom settings for the stylesheet output.

{
  "name": "MyItalicFontName",
  "weight": "900",
  "style": "Italic"
}

Installation

brew install batik fontforge ttfautohint ttf2eot
npm install grunt-fontgen --save-dev

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)