Skip to content

Commit

Permalink
Move templates, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
backflip committed Mar 10, 2014
1 parent efc0e8c commit 7fc9fae
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 6 deletions.
9 changes: 6 additions & 3 deletions README.md
@@ -1,6 +1,11 @@
# gulp-iconfont-css
> Generate (S)CSS file for icon font created with [Gulp](http://gulpjs.com/)
## Warning

The latest version of [gulp-iconfont](https://github.com/nfroidure/gulp-iconfont) emits a `codepoints` event (see https://github.com/nfroidure/gulp-iconfont/pull/4) which should likely be used instead of the workflow described below. However, it will continue to work as expected.
The future of this plugin will be discussed in https://github.com/backflip/gulp-iconfont-css/issues/9.

## Usage

First, install `gulp-iconfont-css` as a development dependency:
Expand Down Expand Up @@ -46,9 +51,7 @@ The name of the generated font family (required). **Important**: Has to be ident
#### options.path
Type: `String`

The template path (optional, defaults to `scss` provided with plugin).

If set to `'scss'`, `'less'`, or `'css'`, default templates using SCSS, Less, or CSS will be generated.
The template path (optional, defaults to `css` template provided with plugin).If set to `'scss'` or `'less'`, the corresponding default template will be used. See [templates](tree/master/templates)

#### options.targetPath
Type: `String`
Expand Down
6 changes: 3 additions & 3 deletions index.js
Expand Up @@ -19,8 +19,8 @@ function iconfontCSS(config) {

// Set default values
config = _.merge({
path: __dirname + '/_icons.scss',
targetPath: '_icons.scss',
path: 'css',
targetPath: '_icons.css',
fontPath: './',
engine: 'lodash',
firstGlyph: 0xE001
Expand All @@ -31,7 +31,7 @@ function iconfontCSS(config) {
config.path = 'scss';
}
if(/^(scss|less|css)$/i.test(config.path)) {
config.path = __dirname + '/_icons.' + config.path;
config.path = __dirname + '/templates/_icons.' + config.path;
}

// Validate config
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 7fc9fae

Please sign in to comment.