Snapshot of ecomfe/fontmin: 6.2k★, JavaScript. Minify font seamlessly
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
import Fontmin from 'fontmin';
const rename = require('gulp-rename');
const fontmin = new Fontmin()
.src('fonts/big.ttf')
.use(rename('small.ttf'));
API
new Fontmin()
Creates a new Fontmin instance.
.src(file)
Type: Array|Buffer|String
Set the files to be optimized. Takes a buffer, glob string or an array of glob strings
as argument.
.dest(folder)
Type: String
Set the destination folder to where your files will be written. If you don't set
any destination no files will be written.
.use(plugin)
Type: Function
Add a plugin to the middleware stack.
.run(cb)
Type: Function
Optimize your files with the given settings.
cb(err, files, stream)
The callback will return an array of vinyl files in files and a Readable/Writable
stream in stream
Plugins
The following plugins are bundled with fontmin:
glyph — Compress ttf by glyph.
ttf2eot — Convert ttf to eot.
ttf2woff — Convert ttf to woff.
ttf2woff2 — Convert ttf to woff2.
ttf2svg — Convert ttf to svg.
css — Generate css from ttf, often used to make iconfont.
svg2ttf — Convert font format svg to ttf.
svgs2ttf — Concat svg files to a ttf, just like css sprite.
otf2ttf — Convert otf to ttf.
.glyph()
Compress ttf by glyph.
import Fontmin from 'fontmin';
const fontmin = new Fontmin()
.use(Fontmin.glyph({
text: '天地玄黄 宇宙洪荒',
hinting: false // keep ttf hint info (fpgm, prep, cvt). default = true
}));
.ttf2eot()
Convert ttf to eot.
import Fontmin from 'fontmin';
const fontmin = new Fontmin()
.use(Fontmin.ttf2eot());
.ttf2woff()
Convert ttf to woff.
import Fontmin from 'fontmin';
const fontmin = new Fontmin()
.use(Fontmin.ttf2woff({
deflate: true // deflate woff. default = false
}));
.ttf2woff2()
Convert ttf to woff2.
import Fontmin from 'fontmin';
const fontmin = new Fontmin()
.use(Fontmin.ttf2woff2());
.ttf2svg()
Convert ttf to svg.
you can use imagemin-svgo to compress svg:
import Fontmin from 'fontmin';
const svgo = require('imagemin-svgo');
const fontmin = new Fontmin()
.use(Fontmin.ttf2svg())
.use(svgo());
.css()
Generate css from ttf, often used to make iconfont.
import Fontmin from 'fontmin';
const fontmin = new Fontmin()
.use(Fontmin.css({
fontPath: './', // location of font file
base64: true, // inject base64 data:application/x-font-ttf; (gzip font with css).
// default = false
glyph: true, // generate class for each glyph. default = false
iconPrefix: 'my-icon', // class prefix, only work when glyph is `true`. default to "icon"
fontFamily: 'myfont', // custom fontFamily, default to filename or get from analysed ttf file
asFileName: false, // rewrite fontFamily as filename force. default = false
local: true // boolean to add local font. default = false
}));
Alternatively, a transform function can be passed as fontFamily option.
import Fontmin from 'fontmin';
const fontmin = new Fontmin()
.use(Fontmin.css({
// ...
fontFamily: function(fontInfo, ttf) {
return "Transformed Font Family Name"
},
// ...
}));
.svg2ttf()
Convert font format svg to ttf.
import Fontmin from 'fontmin';
const fontmin = new Fontmin()
.src('font.svg')
.use(Fontmin.svg2ttf());
.svgs2ttf()
Concat svg files to a ttf, just like css sprite.
awesome work with css plugin:
import Fontmin from 'fontmin';
const fontmin = new Fontmin()
.src('svgs/*.svg')
.use(Fontmin.svgs2ttf('font.ttf', {fontName: 'iconfont'}))
.use(Fontmin.css({
glyph: true
}));
.otf2ttf()
Convert otf to ttf.
import Fontmin from 'fontmin';
const fontmin = new Fontmin()
.src('fonts/*.otf')
.use(Fontmin.otf2ttf());
CLI
$ npm install -g fontmin
$ fontmin --help
Usage
$ fontmin <file> [<output>]
$ fontmin <directory> [<output>]
$ fontmin <file> > <output>
$ cat <file> | fontmin > <output>
Example
$ fontmin fonts/* build
$ fontmin fonts build
$ fontmin foo.ttf > foo-optimized.ttf
$ cat foo.ttf | fontmin > foo-optimized.ttf
Options
-t, --text require glyphs by text
-b, --basic-text require glyphs with base chars
-d, --deflate-woff deflate woff
--font-family font-family for @font-face CSS
--css-glyph generate class for each glyf. default = false
-T, --show-time show time fontmin cost
you can use curl to generate font for websites running on PHP, ASP, Rails and more:
The most recent commit recorded on ecomfe/fontmin was 1.3 years ago, based on the GitHub push timestamp. The repository has 332 forks — one of the better signals of community interest.
How many stars does ecomfe/fontmin have?
ecomfe/fontmin has 6.2k GitHub stars — refresh the page for the live number, or check github.com/ecomfe/fontmin. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is ecomfe/fontmin open source?
Yes — ecomfe/fontmin ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/ecomfe/fontmin.
What is ecomfe/fontmin?
ecomfe/fontmin (ecomfe/fontmin) is a JavaScript project on GitHub. From the project's own README: Minify font seamlessly
What language is ecomfe/fontmin written in?
ecomfe/fontmin is written primarily in JavaScript. GitHub's language field is based on the largest share of bytes in the default branch.
What license does ecomfe/fontmin use?
ecomfe/fontmin is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where do I read more about ecomfe/fontmin?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/ecomfe/fontmin is the definitive source.
Read full README in the tab above.
Still deciding about fontmin?
One click hands the question to an AI along with this page — see what it says about fontmin.