Ninja Pumpkin Mutants

    gulp-fontello

    0.5.2 • Public • Published

    gulp-fontello

    Import svg files to Fontello icon font project, use svg filename as glyph name. Also provide task for auto download exported css and font files into destinated folder.

    Dependencies Status Npm Version Month Downloads Build Status Npm Licence

    PayPal Donate

    NPM

    Install

    npm install --save-dev gulp-fontello

    Default Zip Archive Structure

    ├── LICENSE.txt
    ├── README.txt
    ├── config.json
    ├── css
    │   ├── animation.css
    │   ├── fontello-codes.css
    │   ├── fontello-embedded.css
    │   ├── fontello-ie7-codes.css
    │   ├── fontello-ie7.css
    │   └── fontello.css
    ├── demo.html
    └── font
        ├── fontello.eot
        ├── fontello.svg
        ├── fontello.ttf
        └── fontello.woff
    

    Usage

    • You should get a config.json file from http://fontello.com project and save it somewhere in your project;
    • create Gulp Task:
    var
      gulp = require('gulp'),
      $ = require('gulp-load-plugins')()
    ;
     
    gulp.task('glyph', function () {
      return gulp.src('config.json')
        .pipe($.fontello())
        .pipe($.print())
        .pipe(gulp.dest('dist'))
    });

    Options

    var options = {
      host          :         'http://fontello.com',      // Host for response
      font          :         'font',                     // Destination dir for Fonts and Glyphs
      css           :         'css',                      // Destination dir for CSS Styles,
      assetsOnly    :         true                        // extract from ZipFile only CSS Styles and Fonts exclude config.json, LICENSE.txt, README.txt and demo.html
      cache         :         $.fontello.simpleFsCache('cachedir') // object containing methods get(key, callback) and set(key, value)
    }

    CLI Arguments

    Script can accept input parameters in CLI mode and extends options parameters in gulp task, for example:

    • Gulp global install
        gulp <fontello-task> --no-assets-only    
    • Gulp local install (For this make gulp scripts in package.json)
        npm run gulp <fontello-task> -- --no-assets-only

    Available arguments

    • --host=host Host for response
    • --css=css Destination dir for Fonts and Glyphs
    • --font=font Destination dir for CSS Styles
    • --no-assets-only Extract from ZipFile CSS Styles and Fonts with config.json, LICENSE.txt, README.txt and demo.html
    • --assets-only Extract from ZipFile only CSS Styles and Fonts exclude config.json, LICENSE.txt, README.txt and demo.html

    Keywords

    Install

    npm i gulp-fontello

    DownloadsWeekly Downloads

    541

    Version

    0.5.2

    License

    MIT

    Unpacked Size

    10.9 kB

    Total Files

    7

    Last publish

    Collaborators

    • gillbeits