Svg2icon NPM | npm.io

svg2icon

use iconfont has never been so simple

Why use it

not rely on a third party to generate font and copy link or download again and again
simply manage your iconfont svg in multiple develop git branch, no longer worry about conflict or your partner cover lost your icon
provide demo.html for view all already existing icon
faster and more simple to generate font

How it work

Install

// global
npm install svg2icon -g

// local
npm install svg2icon --save-dev

Usage

configure the priority: command > .svg2iconrc.js > default

example 1 with command param

svg2icon -n app-icon -i ./icon/svg -o ./icon/ -a true

example 2 with file `.svg2iconrc.js` config

// recommend
module.exports = {
  auto: true,
  name: 'app-icon',
  svgPath: './icon/svg',
  outPath: './icon'
}

$ svg2icon -h

Usage: svg2icon [options]
选项：
  --name, -n     iontFont name use in calss like class="app-icon-xxx"
                                                   [字符串] [默认值: "app-icon"]
  --svgPath, -i  input svg path, read from {svgPath}/*.svg
                                                   [字符串] [默认值: "icon/svg"]
  --outPath, -o  output for font、css、demo path       [字符串] [默认值: "icon"]
  --auto, -a     auto open demo.html in browser, when run generate it
                                                           [布尔] [默认值: true]
  -h, --help     显示帮助信息                                             [布尔]
  -v, --version  显示版本号                                               [布尔]

示例：
  svg2icon -n app-icon -i ./icon/svg -o ./icon/ -a true
  svg2icon : just simple command with a .svg2iconrc.js config file
  more detail : https://www.npmjs.com/package/svg2icon