{"_id":"@bestminr/gulp-iconfont-css","_rev":"2-8313772b3da00be99953668d31167ada","name":"@bestminr/gulp-iconfont-css","dist-tags":{"latest":"2.0.0"},"versions":{"2.0.0":{"name":"@bestminr/gulp-iconfont-css","version":"2.0.0","description":"Generate (S)CSS file for icon font created with Gulp","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hikerpig/gulp-iconfont-css.git"},"author":{"name":"Thomas Jaggi, Nicolas Froidure, hikerpig"},"engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"main":"./index.js","keywords":["gulpplugin","gulp","icon","font","scss","css"],"dependencies":{"gulp-util":"~3.0.6","consolidate":"~0.13.1","lodash":"~3.10.0"},"devDependencies":{"mocha":"*","event-stream":"~3.3.1","gulp":"~3.9.0","gulp-iconfont":"~5.0.0"},"gitHead":"ec47bbdbcb7bed8085ecbe194ddd0618d505e2fe","bugs":{"url":"https://github.com/hikerpig/gulp-iconfont-css/issues"},"homepage":"https://github.com/hikerpig/gulp-iconfont-css#readme","_id":"@bestminr/gulp-iconfont-css@2.0.0","_npmVersion":"6.1.0","_nodeVersion":"8.11.1","_npmUser":{"name":"hikerpig","email":"hikerpigwinnie@gmail.com"},"dist":{"integrity":"sha512-clFsutikPGqBtZi4px0woMZEHI1dzBbnSlHztEr0y57gZq/PoXrKD2x73blFsw3Mkbq7rKSeVPvzRkGdr+G+YA==","shasum":"a973762f92fc637a885a6f6c4d849819875b7bd1","tarball":"https://registry.npmjs.org/@bestminr/gulp-iconfont-css/-/gulp-iconfont-css-2.0.0.tgz","fileCount":17,"unpackedSize":23846,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbILVQCRA9TVsSAnZWagAAfDkQAIcPv1D9g5qoQ8RPZP+G\nklKU0iLsW+Ff6WBMKWWaoiX8j3rsEH18Cvr82NlQhI23NcCYso336CnTeFpc\nFjZ3nZ1nEx6zFmyhKXj+HxeqjLHmvz/fMYMwCaYGY80OD6ueVPbsH49uiO0w\nkgo6GYPwGF2HmguE/WmDnSOq/13wKAXiO2i4hyUbj/0bKR7UhiUOCN2+BlPn\nLsozw/wj4p/DrNC+NX2K9KjD8wSiVU0cjQmXAf0fqw/p1NSsKvE5EHkcfZIf\nXBbOb3bGpm2KZn3DypdTo5NktOFr6IXneAzf3DO5b9GejepCx+6NEMScJiSK\ntgXkRdiZ5PNOkqQHAUZ6/XolU2GgE7/yC8PA6P3AlZ5qfOwoYckqC3jaXH+o\newCwsaCgGQiJck4Lwxb/klfDuHaM0csJGjfoSYU7054yOtGWc0RKBJxEjCaq\nS6LK6diDYDgUJDAIdFDvkQ4m3ErRMHn32+y67ELvZf/CTffPxpKSvGby9moV\nRrObwWLTC5Peg7JQNjXQHJEAQKlHU7n8KAMIDn6J7sdsX45ehD+Qe0PnzKrB\nopXa9eoFTz3Ug1mZmFcwsq6PRAg5MUfaIzc3Lohc13G9C1QoIp6cvty2VTy9\nkCxyh51/hRq/xWb70O0ldPZWXOSQ/PbrSny1qbPAxQOvmOnHVG7WYxJMc8Fl\no6MW\r\n=dg47\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDGUkNNTlePNxVNqCjBmoRL8DkggYRsaaiIQI9mZxAaQgIgEv8p3L5XOARDfTCSXrqO7JMQX0gZU9+X/UpGWIrg8sw="}]},"maintainers":[{"name":"hikerpig","email":"hikerpigwinnie@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gulp-iconfont-css_2.0.0_1528870223762_0.18630585183843373"},"_hasShrinkwrap":false}},"time":{"created":"2018-06-13T06:10:23.567Z","2.0.0":"2018-06-13T06:10:23.872Z","modified":"2022-04-04T18:33:46.298Z"},"maintainers":[{"email":"imsunhao1994@gmail.com","name":"imsunhao"},{"email":"hikerpigwinnie@gmail.com","name":"hikerpig"}],"description":"Generate (S)CSS file for icon font created with Gulp","homepage":"https://github.com/hikerpig/gulp-iconfont-css#readme","keywords":["gulpplugin","gulp","icon","font","scss","css"],"repository":{"type":"git","url":"git+https://github.com/hikerpig/gulp-iconfont-css.git"},"author":{"name":"Thomas Jaggi, Nicolas Froidure, hikerpig"},"bugs":{"url":"https://github.com/hikerpig/gulp-iconfont-css/issues"},"license":"MIT","readme":"# gulp-iconfont-css\n> Generate (S)CSS file for icon font created with [Gulp](http://gulpjs.com/)\n\n## Warning\n\nRecent versions of [gulp-iconfont](https://github.com/nfroidure/gulp-iconfont) emit a `glyphs` (or `codepoints` < 4.0.0) event (see [docs](https://github.com/nfroidure/gulp-iconfont/)) which should likely be used instead of the workflow described below. However, it will continue to work as expected.\nThe future of this plugin will be discussed in https://github.com/backflip/gulp-iconfont-css/issues/9.\n\n## Usage\n\nFirst, install `gulp-iconfont` and `gulp-iconfont-css` as development dependencies:\n\n```shell\nnpm install --save-dev gulp-iconfont gulp-iconfont-css\n```\n\nThen, add it to your `gulpfile.js`. **Important**: `gulp-iconfont-css` has to be inserted *before* piping the files through `gulp-iconfont`.\n\n```javascript\nvar iconfont = require('gulp-iconfont');\nvar iconfontCss = require('gulp-iconfont-css');\n\nvar fontName = 'Icons';\n\ngulp.task('iconfont', function(){\n  gulp.src(['app/assets/icons/*.svg'])\n    .pipe(iconfontCss({\n      fontName: fontName,\n      path: 'app/assets/css/templates/_icons.scss',\n      targetPath: '../../css/_icons.scss',\n      fontPath: '../../fonts/icons/'\n    }))\n    .pipe(iconfont({\n      fontName: fontName\n     }))\n    .pipe(gulp.dest('app/assets/fonts/icons/'));\n});\n```\n\n`gulp-iconfont-css` works well with `gulp-iconfont` but you can use it in a more modular fashion by directly using `gulp-svgicons2svgfont`, `gulp-svg2tff`, `gulp-ttf2eot` and/or `gulp-ttf2woff`.\n\n## API\n\n### iconfontCSS(options)\n\n#### options.fontName\nType: `String`\n\nThe name of the generated font family (required). **Important**: Has to be identical to iconfont's ```fontName``` option.\n\n#### options.path\nType: `String`\n\nThe 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](templates)\n\n#### options.targetPath\nType: `String`\n\nThe path where the (S)CSS file should be saved, relative to the path used in ```gulp.dest()``` (optional, defaults to ```_icons.css```). Depennding on the path, it might be necessary to set the ```base``` option, see https://github.com/backflip/gulp-iconfont-css/issues/16.\n\n#### options.fontPath\nType: `String`\n\nDirectory of font files relative to generated (S)CSS file (optional, defaults to ```./```).\n\n#### options.cssClass\nType: `String`\n\nName of the generated CSS class/placeholder. Used for mixins and functions, too. See https://github.com/backflip/gulp-iconfont-css/tree/master/templates. Default is `icon`.\n\n#### options.engine\nType: `String`\n\nThe template engine to use (optional, defaults to ```lodash```). \nSee https://github.com/visionmedia/consolidate.js/ for available engines. The engine has to be installed before using.\n","readmeFilename":"README.md"}