UNPKG

2.51 kBMarkdownView Raw
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-svg2ttf) [![Build status](https://secure.travis-ci.org/nfroidure/gulp-svg2ttf.png)](https://travis-ci.org/nfroidure/gulp-svg2ttf) [![Dependency Status](https://david-dm.org/nfroidure/gulp-svg2ttf.png)](https://david-dm.org/nfroidure/gulp-svg2ttf) [![devDependency Status](https://david-dm.org/nfroidure/gulp-svg2ttf/dev-status.png)](https://david-dm.org/nfroidure/gulp-svg2ttf#info=devDependencies) [![Coverage Status](https://coveralls.io/repos/nfroidure/gulp-svg2ttf/badge.png?branch=master)](https://coveralls.io/r/nfroidure/gulp-svg2ttf?branch=master) [![Code Climate](https://codeclimate.com/github/nfroidure/gulp-svg2ttf.png)](https://codeclimate.com/github/nfroidure/gulp-svg2ttf)
5
6## Usage
7
8First, install `gulp-svg2ttf` as a development dependency:
9
10```shell
11npm install --save-dev gulp-svg2ttf
12```
13
14Then, add it to your `gulpfile.js`:
15
16```javascript
17var svg2ttf = require('gulp-svg2ttf');
18
19gulp.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-svg2ttf/)
29[![NPM](https://nodei.co/npm-dl/gulp-svg2ttf.png)](https://nodei.co/npm/gulp-svg2ttf/)
30
31## API
32
33### svg2ttf(options)
34
35#### options.ignoreExt
36Type: `Boolean`
37Default value: `false`
38
39Set to true to also convert files that doesn't have the .svg extension.
40
41#### options.clone
42Type: `Boolean`
43Default value: `false`
44
45Set to true to clone the file before converting him so that it will output the
46 original file too.
47
48#### options.timestamp
49Type: `Number`
50Default value: `Math.round(Date.now()/1000)`
51
52Override the TTF font creation/modification date.
53
54#### options.copyright
55Type: `String`
56Default value: Fontello ad or SVG Font copyright metadata.
57
58Allows to set to your copyright informations.
59
60### Note
61
62You may look after a full Gulp web font workflow, see
63 [gulp-iconfont](https://github.com/nfroidure/gulp-iconfont)
64 fot that matter.
65
66### Contributing / Issues
67
68Please submit SVG to TTF related issues to the
69 [svg2ttf project](https://github.com/fontello/svg2ttf)
70 on wich gulp-svg2ttf is built.
71
72This repository issues is only for gulp and gulp tasks related issues.
73
74You may want to contribute to this project, pull requests are welcome if you
75 accept to publish under the MIT licence.