grunt-evil-icons
v0.5.0
Published
Grunt plugin to use Evil Icons in your project
Downloads
14
Readme
grunt-evil-icons
This plugin allows to use Evil Icons in your project with Grunt.
Getting Started
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-evil-icons --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-evil-icons');
The "evil_icons" task
Overview
In your project's Gruntfile, add a section named evil_icons
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
evil_icons: {
dist: {
files: {
"build/index.html": "src/index.html"
}
}
}
});
Using icons
Once you have added the evil_icons
section to your Gruntfile, you can use
the icons in your html with the icon
tag:
<icon name="ei-archive" />
<icon name="ei-chart" size="s" />
<icon name="ei-check" size="m" />
<icon name="ei-cart" size="l" class="foo" />
The sprite will be added to your html automatically, and the icon
tags will
be replaced with actual SVG code.
The only thing you have to add to your code explicitly is the stylesheet:
<link rel="stylesheet" href="./node_modules/grunt-evil-icons/node_modules/assets/evil-icons.css">