# font-spider [![NPM Version][npm-image]][npm-url] [![NPM Downloads][downloads-image]][downloads-url] [![Node.js Version][node-version-image]][node-version-url] [![Build Status][travis-ci-image]][travis-ci-url] [[简体中文]](./README-ZH-CN.md) | [[English]](./README.md) | [[日本語]](./README-JA.md) Font-spider is a compress tool for WebFont which can analyze your web-page intelligently to find the fonts out which have been used and then compress them. 字蛛是一个智能 WebFont 压缩工具,它能自动分析出页面使用的 WebFont 并进行按需压缩。 フォント・スパイダー(font-spider)は、Webフォントを圧縮するためのスマートなツールです,Webページに使用されるWebフォントを分析し、必要に応じて圧縮することができます。 ------------------ font-spider ## Feature 1. Font subsetter: Our tool is based on HTML and CSS analysis and completely running in local so that. 2. Font converter: Support woff2, woff, eot, svg font format generation. ## Install ``` shell npm install font-spider -g ``` ## Use ### step one: code CSS ``` css @font-face { font-family: 'source'; src: url('../font/source.eot'); src: url('../font/source.eot?#font-spider') format('embedded-opentype'), url('../font/source.woff2') format('woff2'), url('../font/source.woff') format('woff'), url('../font/source.ttf') format('truetype'), url('../font/source.svg') format('svg'); font-weight: normal; font-style: normal; } .home h1, .demo > .test { font-family: 'source'; } ``` > Attention: the ".ttf" file must be existed which is referred in `src` property of `@font-face`, and our font-spider will automatically generate other formats of font. ### step two: compress WebFont by using font-spider ``` shell font-spider [options] ``` #### htmlFiles One or more web-page addresses which support the http form. Example: ``` shell font-spider dest/news.html dest/index.html dest/about.html ``` #### options ``` Usage: font-spider [options] Options: -h, --help output usage information -V, --version output the version number --info show only webfont information --ignore ignore the files --map mapping the remote path to the local --no-backup do not back up fonts --debug enable debug mode ``` #### sample of parameters usage Use the wildcard character to compress the WebFont of several HTML file: ``` shell font-spider dest/*.html ``` `--info` Show the WebFont that has been used on the website: ``` shell font-spider --info http://fontawesome.io ``` `--ignore` Ignore the file: ``` shell font-spider --ignore "icon\\.css$" dest/*.html ``` `--map` This parameter will map the WebFont of online page to local and then compress it (the local path must be an absolute path): ``` shell font-spider --map "http://font-spider.org/font,/Website/font" http://font-spider.org/index.html ``` ## Build plugins - [grunt-font-spider](https://github.com/aui/grunt-font-spider) - [gulp-font-spider](https://github.com/aui/gulp-font-spider) ## API See:[API.md](./API.md) ## Limitations - Only the constant texts and styles are supported, but not the dynamic elements and styles which is inserted by javascript. - The ".otf" format fonts should be transfered to ".ttf" format firstly, so that we can start our compressing work. - Only the HTML and CSS files which is encoded by `utf-8` are supported. [npm-image]: https://img.shields.io/npm/v/font-spider.svg [npm-url]: https://npmjs.org/package/font-spider [node-version-image]: https://img.shields.io/node/v/font-spider.svg [node-version-url]: http://nodejs.org/download/ [downloads-image]: https://img.shields.io/npm/dm/font-spider.svg [downloads-url]: https://npmjs.org/package/font-spider [travis-ci-image]: https://travis-ci.org/aui/font-spider.svg?branch=master [travis-ci-url]: https://travis-ci.org/aui/font-spider ----------------- [\[Link\] 让 font-spider 支持 js 动态内容](https://github.com/allanguys/font-spider-plus) [\[AD\] 前端招聘:在海边写代码](https://juejin.im/post/5a2651d06fb9a0451c3a40ad)