svgs2fonts

svgs2fonts

svg icon to font icon library (svgs -> svg,ttf,eot,woff,woff2). English readme

Version

2.0.3

Install

1. Global installation (scaffolding tool)

npm i -g svgs2fonts

verify

svgs2fonts -v

2. Module dependency installation

npm i --save svgs2fonts

use

Method 1—Module introduction (Support TypeScript)

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

Svgs2fonts . init ( options ) ;

Where options parameters:

Fields	type	default value	describe
src	string	-	Directory path of svg icon file
dist	string	./dist	Font icon output path
fontName	string	iconfont	Output icon/font name
unicodeStart	number	10000	unicode start number (setting this means you need to avoid the normal unicode range), (the corresponding field before v2.0 is startNumber )
noDemo	boolean	true	Is it necessary to output the html demo file?
demoUnicodeHTML	string	demo_unicode.html	Example html name of unicode type
demoFontClassHTML	string	demo_fontclass.html	Sample html name of fontClass type

*V2 Abandoned fields:

• debug ( v2.1.0废弃): ${Boolean} , whether to enable debug mode to output more execution information, default false
• timeout ( v2.0废弃): {Number} , execution timeout, default is 60s ( 60000 )
• logger ( v2.0废弃): {Object} , logging.

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 } )` ) ) ;

Method 2—Console

svgs2fonts {srcpath} {distpath} {options}

Where parameters:

• srcpath: svg source file path (relative to the current window environment), the current window path is passed "";
• distpath: Export path, default to the source file path;
• options: Configuration parameters, see below

example

svgs2fonts svg dist

options configuration parameters

-n / --name

The name of the icon library (default: "iconfont" ).

example

svgs2fonts svg dist -n myiconfont

--number

unicode start encoding (default: 10000 ).

example

 svgs2fonts svg dist --number 50000

--nodemo

Don't demo html(default: false ).

example

 svgs2fonts svg dist --nodemo

example

 svgs2fonts svg dist

Project build

Installation dependencies:

 npm i

Build:

 npm run build

Single test:

 npm run test

demo test:

 npm run test:example

Author

Micheal Wayne

Guided article-"Research and conversion of svg, ttf, woff, woff2 icons (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 optical 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;