grunt-svgicons2svgfont

Create a SVG font from multiple SVG glyph files

npm install grunt-svgicons2svgfont
7 downloads in the last week
15 downloads in the last month

grunt-svgicons2svgfont Build Status

Create a SVG 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-svgicons2svgfont --save-dev

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

grunt.loadNpmTasks('grunt-svgicons2svgfont');

The "svgicons2svgfont" task

Overview

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

grunt.initConfig({
  svgicons2svgfont: {
    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 of the resulting font.

options.font

Type: String Default value: 'iconfont'

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

options.appendCodepoints

Type: Boolean Default value: false

Allow to append codepoints to icon files in order to always keep the same codepoints.

Example

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

You may use this plugin in addition of the following plugins :

Contributing / Issues

Please submit SVG related issue to the svgicons2svgfont project on wich grunt-svgicons2svgfont depends.

This repository issues is only for grunt and grunt tasks related issues.

You may want to contribute to this project, pull requests are welcome if you accept to publish under the MIT licence.

npm loves you