\n\n# fontmin\n**Minify font seamlessly**\n\n[![NPM version][npm-image]][npm-url]\n[![Build Status][travis-image]][travis-url]\n[![Downloads][downloads-image]][npm-url]\n[![Dependencies][dep-image]][dep-url]\n[![Font support][font-image]][font-url]\n\n## Homepage\n\n- [简体中文](http://ecomfe.github.io/fontmin/)\n- [繁體中文](http://ecomfe.github.io/fontmin/tw)\n- [日本語](http://ecomfe.github.io/fontmin/jp)\n- [한국어](http://ecomfe.github.io/fontmin/kr)\n- [English](http://ecomfe.github.io/fontmin/en)\n\n## Install\n\n```sh\n$ npm install --save fontmin\n```\n\n## Usage\n\n```js\nvar Fontmin = require('fontmin');\n\nvar fontmin = new Fontmin()\n .src('fonts/*.ttf')\n .dest('build/fonts');\n\nfontmin.run(function (err, files) {\n if (err) {\n throw err;\n }\n\n console.log(files[0]);\n // => { contents: }\n});\n```\n\nYou can use [gulp-rename](https://github.com/hparra/gulp-rename) to rename your files:\n\n```js\nvar Fontmin = require('fontmin');\nvar rename = require('gulp-rename');\n\nvar fontmin = new Fontmin()\n .src('fonts/big.ttf')\n .use(rename('small.ttf'));\n```\n\n## API\n\n### new Fontmin()\n\nCreates a new `Fontmin` instance.\n\n### .src(file)\n\nType: `Array|Buffer|String`\n\nSet the files to be optimized. Takes a buffer, glob string or an array of glob strings\nas argument.\n\n### .dest(folder)\n\nType: `String`\n\nSet the destination folder to where your files will be written. If you don't set\nany destination no files will be written.\n\n### .use(plugin)\n\nType: `Function`\n\nAdd a `plugin` to the middleware stack.\n\n### .run(cb)\n\nType: `Function`\n\nOptimize your files with the given settings.\n\n#### cb(err, files, stream)\n\nThe callback will return an array of vinyl files in `files` and a Readable/Writable\nstream in `stream`\n\n## Plugins\n\nThe following plugins are bundled with fontmin:\n\n* [glyph](#glyph) — Compress ttf by glyph.\n* [ttf2eot](#ttf2eot) — Convert ttf to eot.\n* [ttf2woff](#ttf2woff) — Convert ttf to woff.\n* [ttf2svg](#ttf2svg) — Convert ttf to svg.\n* [css](#css) — Generate css from ttf, often used to make iconfont.\n* [svg2ttf](#svg2ttf) — Convert font format svg to ttf.\n* [svgs2ttf](#svgs2ttf) — Concat svg files to a ttf, just like css sprite.\n* [otf2ttf](#otf2ttf) — Convert otf to ttf.\n\n### .glyph()\n\nCompress ttf by glyph.\n\n```js\nvar Fontmin = require('fontmin');\n\nvar fontmin = new Fontmin()\n .use(Fontmin.glyph({ \n text: '天地玄黄 宇宙洪荒',\n hinting: false // keep ttf hint info (fpgm, prep, cvt). default = true\n }));\n```\n\n### .ttf2eot()\n\nConvert ttf to eot.\n\n```js\nvar Fontmin = require('fontmin');\n\nvar fontmin = new Fontmin()\n .use(Fontmin.ttf2eot());\n```\n\n### .ttf2woff()\n\nConvert ttf to woff.\n\n```js\nvar Fontmin = require('fontmin');\n\nvar fontmin = new Fontmin()\n .use(Fontmin.ttf2woff({\n deflate: true // deflate woff. default = false\n }));\n```\n\n### .ttf2svg()\n\nConvert ttf to svg.\n\nyou can use [imagemin-svgo](https://github.com/imagemin/imagemin-svgo) to compress svg:\n\n```js\nvar Fontmin = require('fontmin');\nvar svgo = require('imagemin-svgo');\n\nvar fontmin = new Fontmin()\n .use(Fontmin.ttf2svg())\n .use(svgo());\n\n```\n\n### .css()\n\nGenerate css from ttf, often used to make iconfont.\n\n```js\nvar Fontmin = require('fontmin');\n\nvar fontmin = new Fontmin()\n .use(Fontmin.css({\n fontPath: './', // location of font file \n base64: true, // inject base64 data:application/x-font-ttf; (gzip font with css). \n // default = false\n glyph: true, // generate class for each glyph. default = false\n iconPrefix: 'my-icon', // class prefix, only work when glyph is `true`. default to \"icon\"\n fontFamily: 'myfont', // custom fontFamily, default to filename or get from analysed ttf file\n asFileName: false, // rewrite fontFamily as filename force. default = false\n local: true // boolean to add local font. default = false\n }));\n```\n\nAlternatively, a transform function can be passed as `fontFamily` option.\n```js\nvar Fontmin = require('fontmin');\n\nvar fontmin = new Fontmin()\n .use(Fontmin.css({\n // ...\n fontFamily: function(fontInfo, ttf) {\n return \"Transformed Font Family Name\"\n },\n // ...\n }));\n```\n\n### .svg2ttf()\n\nConvert font format svg to ttf.\n\n```js\nvar Fontmin = require('fontmin');\n\nvar fontmin = new Fontmin()\n .src('font.svg')\n .use(Fontmin.svg2ttf());\n```\n\n### .svgs2ttf()\n\nConcat svg files to a ttf, just like css sprite.\n\nawesome work with [css](#css) plugin:\n\n```js\nvar Fontmin = require('fontmin');\n\nvar fontmin = new Fontmin()\n .src('svgs/*.svg')\n .use(Fontmin.svgs2ttf('font.ttf', {fontName: 'iconfont'}))\n .use(Fontmin.css({\n glyph: true\n }));\n```\n\n### .otf2ttf()\n\nConvert otf to ttf.\n\n```js\nvar Fontmin = require('fontmin');\n\nvar fontmin = new Fontmin()\n .src('fonts/*.otf')\n .use(Fontmin.otf2ttf());\n```\n\n## CLI\n\n```bash\n$ npm install -g fontmin\n```\n\n```sh\n$ fontmin --help\n\n Usage\n $ fontmin [
![](\"https://raw.githubusercontent.com/ecomfe/fontmin/master/fontmin.png\")
\n \n