Gulp-iconic NPM

gulp-iconic

NodeJS module used to wrap a use case of gulp-iconfont (v1.0.2).

This module is a wrapper to use the gulp-iconfont plugin with simplified options. It is not planned for generic use inside Gulp, but if this plugin meets your need, feel free to use it.

Usage

var iconic = require('gulp-iconic');

gulp.task('icon', function(cb){
  iconic({
		cssTemplate: '_iconfont.scss',
		svgFolder: './svg',
		cssFolder: './css',
		fontFolder: './font/iconfont',
		previewFolder: './preview',
		fontUrl: '/test/font/iconfont',
		descent: 80
	}, cb);
});

Options

cssTemplate
Filename or filepath to the CSS template. Lodash is used for templating.

svgFolder
Path to the source folder containing SVG to convert (do not end with /).

cssFolder
Path to the destitation folder to ouput result of CSS template (do not end with /).

fontFolder
Path to the destitation folder to ouput font (do not end with /).

previewFolder
Path to the destitation folder for preview (do not end with /).

fontUrl
URL relative to the root to the destination font folder (do not end with /).
This URL must be relative to the root because it is also used has a path for a behavior css property.

descent
The font descent, fix the font baseline.