forked from enviPath/enviPy
82 lines
2.7 KiB
Markdown
82 lines
2.7 KiB
Markdown
# gulp-svg2ttf
|
|
> Create a TTF font from an SVG font with [Gulp](http://gulpjs.com/).
|
|
|
|
[](https://npmjs.org/package/gulp-svg2ttf) [](https://travis-ci.org/nfroidure/gulp-svg2ttf) [](https://david-dm.org/nfroidure/gulp-svg2ttf) [](https://david-dm.org/nfroidure/gulp-svg2ttf#info=devDependencies) [](https://coveralls.io/r/nfroidure/gulp-svg2ttf?branch=master) [](https://codeclimate.com/github/nfroidure/gulp-svg2ttf)
|
|
|
|
## Usage
|
|
|
|
First, install `gulp-svg2ttf` as a development dependency:
|
|
|
|
```shell
|
|
npm install --save-dev gulp-svg2ttf
|
|
```
|
|
|
|
Then, add it to your `gulpfile.js`:
|
|
|
|
```javascript
|
|
var svg2ttf = require('gulp-svg2ttf');
|
|
|
|
gulp.task('svg2ttf', function(){
|
|
gulp.src(['fonts/*.svg'])
|
|
.pipe(svg2ttf())
|
|
.pipe(gulp.dest('fonts/'));
|
|
});
|
|
```
|
|
|
|
## Stats
|
|
|
|
[](https://nodei.co/npm/gulp-svg2ttf/)
|
|
[](https://nodei.co/npm/gulp-svg2ttf/)
|
|
|
|
## API
|
|
|
|
### svg2ttf(options)
|
|
|
|
#### options.ignoreExt
|
|
Type: `Boolean`
|
|
Default value: `false`
|
|
|
|
Set to true to also convert files that doesn't have the .svg extension.
|
|
|
|
#### options.clone
|
|
Type: `Boolean`
|
|
Default value: `false`
|
|
|
|
Set to true to clone the file before converting him so that it will output the
|
|
original file too.
|
|
|
|
#### options.timestamp
|
|
Type: `Number`
|
|
Default value: `Math.round(Date.now()/1000)`
|
|
|
|
Override the TTF font creation/modification date.
|
|
|
|
#### options.copyright
|
|
Type: `String`
|
|
Default value: Fontello ad or SVG Font copyright metadata.
|
|
|
|
Allows to set to your copyright informations.
|
|
|
|
#### options.version
|
|
Type: `String`
|
|
Default value: `undefined` (results in version `1.0`)
|
|
|
|
Allows to set the version number of the font. Needs to be in the format `Version <NUM>.<NUM>` (the `Version` prefix is optional).
|
|
|
|
### Note
|
|
|
|
You may look after a full Gulp web font workflow, see
|
|
[gulp-iconfont](https://github.com/nfroidure/gulp-iconfont)
|
|
fot that matter.
|
|
|
|
### Contributing / Issues
|
|
|
|
Please submit SVG to TTF related issues to the
|
|
[svg2ttf project](https://github.com/fontello/svg2ttf)
|
|
on wich gulp-svg2ttf is built.
|
|
|
|
This repository issues is only for gulp and gulp tasks related issues.
|
|
|
|
You may want to contribute to this project, pull requests are welcome if you
|
|
accept to publish under the MIT licence.
|