grunt-fontello2js

Generate a Javascript module file for referencing font icons based on a fontello config file

Getting Started

This plugin requires Grunt.

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

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

grunt.loadNpmTasks('grunt-fontello2js');

The "fontello2js" task

Overview

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

grunt.initConfig({
  fontello2js: {
    your_target: {
      src: [path to fontello config.json],
      dest: [destination path for resulting js module]
    },
  },
})

Options

Usage Examples

In this example, a config.json from fontello.com is processed into a resulting result.js

grunt.initConfig({
  fontello2js: {
    files: {
      src: 'test/fixtures/config.json',
      dest: 'tmp/result.js'
    },
  },
})

Specific font icons can then be referenced within code by requiring the resulting file and using the name of the icon as the key into the object.

var icons = require('result.js');

console.log(icons['my-icon-name']);

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

0.0.1 Initial Release

0.0.2 Do not include custom fonts that are not selected

License

Copyright (c) 2015 Dan Wilson. Licensed under the MIT license.