fu

fontello-update

Fontello config updates made easy.

Showing:

Popularity

Downloads/wk

92

GitHub Stars

4

Maintenance

Last Commit

2yrs ago

Contributors

2

Package

Dependencies

8

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Fontello-update

Easily update your Fontello config with this nodejs package.

Workflow

  1. Run fontello-update with an initial fontello config.
  2. Pick and remove fonts on the website and press the 'Save session' button.
  3. Run fontello-update to download the new config and font files.

Use together with grunt-fontello to automatically download the latest package.
Use together with grunt-fontello-update to run fontello update as a Grunt task.

Example


var fontelloUpdate = require('fontello-update');

fontelloUpdate({
    config: 'fontello.json',
    fonts: 'public/font',
    css: 'public/css'
});

Options

  • config - The config file to use. Default: 'config.json'.
  • overwrite - Overwrite existing config file. Default: true.
  • fonts - Font files' destination: Default: 'fonts'.
  • css - Stylesheets' destination: Default: 'css'.
  • open - Open the package on the fontello website and don't update the fonts at all. Default: false.
  • updateConfigOnly - Only update the config file (ie don't extract font and css files). Default: false.
  • session - The session to use. Default: null.

Return value

The fontello update function returns a promise. For example, to use it in an asynchronous Grunt task, you would do something like:


function fontelloUpdate()
{
    var done = this.async();
    var fontelloUpdate = require('fontello-update');

    fontelloUpdate({
            config: 'fontello.json',
            dest: 'fontello.json'
        })
        .then(done)
        .catch(done)
    ;
}

Gulp

Basically Fulfill task relying on promises.

var fontelloUpdate = require('fontello-update');

gulp.task('fontello', function() {
  return fontelloUpdate({
    config: 'fontello.json',
    fonts: 'public/font',
    css: 'public/css'
  });
});

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial