1 | # gulp-svg2ttf
|
2 | > Create a TTF font from an SVG font with [Gulp](http://gulpjs.com/).
|
3 |
|
4 | [![NPM version](https://badge.fury.io/js/gulp-svg2ttf.png)](https://npmjs.org/package/gulp-iconfont) [![Build status](https://secure.travis-ci.org/nfroidure/gulp-iconfont.png)](https://travis-ci.org/nfroidure/gulp-iconfont) [![Dependency Status](https://david-dm.org/nfroidure/gulp-iconfont.png)](https://david-dm.org/nfroidure/gulp-iconfont) [![devDependency Status](https://david-dm.org/nfroidure/gulp-iconfont/dev-status.png)](https://david-dm.org/nfroidure/gulp-iconfont#info=devDependencies) [![Coverage Status](https://coveralls.io/repos/nfroidure/gulp-iconfont/badge.png?branch=master)](https://coveralls.io/r/nfroidure/gulp-iconfont?branch=master) [![Code Climate](https://codeclimate.com/github/nfroidure/gulp-iconfont.png)](https://codeclimate.com/github/nfroidure/gulp-iconfont)
|
5 |
|
6 | ## Usage
|
7 |
|
8 | First, install `gulp-svg2ttf` as a development dependency:
|
9 |
|
10 | ```shell
|
11 | npm install --save-dev gulp-svg2ttf
|
12 | ```
|
13 |
|
14 | Then, add it to your `gulpfile.js`:
|
15 |
|
16 | ```javascript
|
17 | var svg2ttf = require('gulp-svg2ttf');
|
18 |
|
19 | gulp.task('svg2ttf', function(){
|
20 | gulp.src(['fonts/*.svg'])
|
21 | .pipe(svg2ttf())
|
22 | .pipe(gulp.dest('fonts/'));
|
23 | });
|
24 | ```
|
25 |
|
26 | ## Stats
|
27 |
|
28 | [![NPM](https://nodei.co/npm/gulp-svg2ttf.png?downloads=true&stars=true)](https://nodei.co/npm/gulp-iconfont/)
|
29 | [![NPM](https://nodei.co/npm-dl/gulp-svg2ttf.png)](https://nodei.co/npm/gulp-iconfont/)
|
30 |
|
31 | ## API
|
32 |
|
33 | ### svg2ttf(options)
|
34 |
|
35 | #### options.ignoreExt
|
36 | Type: `Boolean`
|
37 | Default value: `false`
|
38 |
|
39 | Set to true to also convert files that doesn't have the .svg extension.
|
40 |
|
41 | #### options.clone
|
42 | Type: `Boolean`
|
43 | Default value: `false`
|
44 |
|
45 | Set to true to clone the file before converting him so that it will output the
|
46 | original file too.
|
47 |
|
48 | ### Contributing / Issues
|
49 |
|
50 | Please submit SVG to TTF related issues to the
|
51 | [svg2ttf project](https://github.com/fontello/svg2ttf)
|
52 | on wich gulp-svg2ttf is built.
|
53 |
|
54 | This repository issues is only for gulp and gulp tasks related issues.
|
55 |
|
56 | You may want to contribute to this project, pull requests are welcome if you
|
57 | accept to publish under the MIT licence.
|