SVG + PNG icon kit generator — Grunt plugin wrapping around node-iconizr that creates a CSS icon kit from a bunch of SVG files, serving them as SVG / PNG sprites or embedded data URIs along with suitable CSS / Sass / LESS / Stylus etc. stylesheet resources and a JavaScript loader for easy integration into your HTML documents
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
CHANGELOG.md
LICENSE
README.md
gulpfile.js
index.js
package.json

README.md

gulp-iconizr NPM version NPM downloads Build Status Coverage Status Dependency Status Development Dependency Status

SVG + PNG icon kit generator — Gulp plugin wrapping around node-iconizr (dev branch) that creates a CSS icon kit from a bunch of SVG files, serving them as SVG / PNG sprites or embedded data URIs along with suitable CSS / Sass / LESS / Stylus etc. stylesheet resources and a JavaScript loader for easy integration into your HTML documents.

Sorry, no serious documentation so far. :(

Installation

To install gulp-iconizr as a development dependency, simply run:

npm install --save-dev jkphl/gulp-iconizr

Usage

Add it to your gulpfile.js and use it like this:

const gulp       = require('gulp');
const iconizr    = require('gulp-iconizr');

gulp.task('iconizr', function () {
    var config = { /* ... */ };

    return gulp.src('**/*.svg', {cwd: 'path/to/svgs'})
        .pipe(iconizr(config))
        .pipe(gulp.dest('path/to/dist'));
});

For a glimpse of the configuration options please see the (likewise incomplete — sorry!) node-iconizr documentation.

Changelog

Please refer to the changelog for a complete release history.

Legal

Copyright © 2016 Joschi Kuphal joschi@kuphal.net / @jkphl.

gulp-iconizr is licensed under the terms of the MIT license.