README_en.md

iconfont-creator

A simply CLI tool to create Iconfont and Icon Component from Sketch or SVGs.

forgive the author's poor English

简体中文

Installation

Prerequisites: Node.js ( >= 5.8.0 preferred ). 4.x should also work, but we haven't test it yet.

$ npm install -g iconfont-creator

If prompt permissions are insufficient, please use $ sudo npm install -g iconfont-creator.

Usage

Create Iconfont from a Sketch file

$ iconfont-creator sketch <sketch-file-path> [-o [output-path]>] [-t [slices-or-artboards]] [-c]

• <sketch-file-path>
  • required, Sketch file's directory
• -o [output-path]
  • optional, iconfont created path, default dist in current directory. preview html file and css file will be created in components under this path.
• -t [slices-or-artboards]
  • optional ( slices or artboards ), according to what for Sketch to export SVGs, slices (default) or artboards
• -c
  • optional, clear output directory before create
• -m
  • optional, create Components, here for more information

Create Iconfont from SVGs

$ iconfont-creator svg <svg-directory> [-o <output-path>] [-c]

• <svg-directory>
  • SVG files' directory
• -o <output-path>
  • optional, iconfont created path, default <svg-directory>/fonts. preview html file and css file will be created in components under this path.
• -c
  • optional, clear output directory before create
• -m
  • optional, create Components, here for more information

Create Vue/React/React-Native Components

easily add -m parameter when create Iconfont to create components, the parameters should be divided by comma, eg:

iconfont-creator sketch ./iconfont.sketch -m react-native,react

React-Native and React Component will be created in <output-path>/components.

TODO

• add create Iconfont from online css