forked from enviPath/enviPy
64 lines
2.2 KiB
Markdown
64 lines
2.2 KiB
Markdown
# gulp-ttf2woff2
|
|
> Create a WOFF2 font from a TTF font with [Gulp](http://gulpjs.com/).
|
|
|
|
[](https://npmjs.org/package/gulp-ttf2woff2) [](https://travis-ci.org/nfroidure/gulp-ttf2woff2) [](https://david-dm.org/nfroidure/gulp-ttf2woff2) [](https://david-dm.org/nfroidure/gulp-ttf2woff2#info=devDependencies) [](https://coveralls.io/r/nfroidure/gulp-ttf2woff2?branch=master) [](https://codeclimate.com/github/nfroidure/gulp-ttf2woff2)
|
|
|
|
## Usage
|
|
|
|
First, install `gulp-ttf2woff2` as a development dependency:
|
|
|
|
```shell
|
|
npm install --save-dev gulp-ttf2woff2
|
|
```
|
|
|
|
Then, add it to your `gulpfile.js`:
|
|
|
|
```javascript
|
|
var ttf2woff2 = require('gulp-ttf2woff2');
|
|
|
|
gulp.task('ttf2woff2', function(){
|
|
gulp.src(['fonts/*.ttf'])
|
|
.pipe(ttf2woff2())
|
|
.pipe(gulp.dest('fonts/'));
|
|
});
|
|
```
|
|
|
|
## API
|
|
|
|
### ttf2woff(options)
|
|
|
|
#### options.ignoreExt
|
|
Type: `Boolean`
|
|
Default value: `false`
|
|
|
|
Set to true to also convert files that doesn't have the .ttf 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.
|
|
|
|
### Note
|
|
|
|
You may look after a full Gulp web font workflow, see
|
|
[gulp-iconfont](https://github.com/nfroidure/gulp-iconfont)
|
|
fot that matter.
|
|
|
|
## Stats
|
|
|
|
[](https://nodei.co/npm/gulp-ttf2woff2/)
|
|
[](https://nodei.co/npm/gulp-ttf2woff2/)
|
|
|
|
### Contributing / Issues
|
|
|
|
Please submit TTF to WOFF2 related issues to the
|
|
[ttf2woff2 project](https://github.com/nfroidure/ttf2woff2)
|
|
on wich gulp-ttf2woff2 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.
|