gulp-iconic

3.0.0 • Public • Published

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.

About gulp-iconfont version

Since version 3.0.0, we have made a rollback to version 1.0.2 of gulp-iconfont.

Version 2.0.0 of gulp-iconfont install succesfully on Windows. But this version has some bug.

Other version, tested up to v4.0.0, are unable to install successfully on Windows because of "ttf2woff2" dependency.

Package Sidebar

Install

npm i gulp-iconic

Weekly Downloads

2

Version

3.0.0

License

MIT

Last publish

Collaborators

  • sigmundftw