svgs2fonts

svgs2fonts

svg 图标转字体图标库（svgs -> svg,ttf,eot,woff,woff2）。English readme

版本

2.0.3

安装

1.全局安装(脚手架工具)

npm i -g svgs2fonts

验证

svgs2fonts -v

2.模块依赖安装

npm i --save svgs2fonts

使用

方式 1——模块引入（支持 TypeScript）

import Svgs2fonts from 'svgs2fonts';
// or
// const Svgs2fonts = require('svgs2fonts');

Svgs2fonts.init(options);

其中 options 参数：

字段	类型	默认值	描述
src	string	-	svg 图标文件的目录路径
dist	string	./dist	字体图标输出路径
fontName	string	iconfont	输出图标/字体名称
unicodeStart	number	10000	unicode 起始数字（设置此指是需要避开正常 unicode 范围），（v2.0之前对应字段为startNumber）
noDemo	boolean	true	是否需要输出 html Demo 文件
demoUnicodeHTML	string	demo_unicode.html	unicode 类型的示例 html 名称
demoFontClassHTML	string	demo_fontclass.html	fontClass 类型的示例 html 名称

*V2 废弃字段：

• debug(v2.1.0废弃)：${Boolean}，是否开启 debug 模式以输出更多执行信息，默认false
• timeout（v2.0废弃）：{Number}，执行超时时间，默认为 60s（60000）
• logger（v2.0废弃）：{Object}，日志记录。

demo

import Svgs2fonts from 'svgs2fonts';
import { join } from 'path';

Svgs2fonts.init({
  src: __dirname, // svg path
  dist: join(__dirname, 'dest'), // output path
  fontName: 'myIconfont', // font name
  noDemo: true, // no demo html files
})
  .then(() => console.log('task success!'))
  .catch(err => console.log(`task failed(${err})`));

方式 2——控制台

svgs2fonts {srcpath} {distpath} {options}

其中参数：

• srcpath: svg 源文件路径（相对当前窗口环境），传""时为当前窗口路径;
• distpath: 导出路径，默认在源文件路径下;
• options: 配置参数，见下文

example

svgs2fonts svg dist

options 配置参数

-n / --name

图标库的名字(default: "iconfont").

example

svgs2fonts svg dist -n myiconfont

--number

unicode 起始编码(default: 10000).

example

svgs2fonts svg dist --number 50000

--nodemo

不要 demo html(default: false).

example

svgs2fonts svg dist --nodemo

example

svgs2fonts svg dist

Project build

安装依赖：

npm i

构建：

npm run build

单测：

npm run test

demo 测试：

npm run test:example

Author

Micheal Wayne

引导文章-《svg、ttf、woff、woff2 图标的研究及转换（svgs2fonts）》

Build time

2018.08.26

Last modified

• 2024.09.28: v2.1.0 change log and remove debug;
• 2023.12.16: v2.0.3 add some defensive handing;
• 2023.06.03: v2.0.2 optimal variable control;
• 2022.11.03: v2.0.1 split css & support svg size options;
• 2022.10.07: code bug fixed;
• 2022.03.20: v2 support for ts;
• 2021.12.16: fix IE8 bug;