Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Workshape/icon-font-generator

Easy-to-use, pre-configured cli tool to generate webfont icon kits from a bunch of .svg files
https://github.com/Workshape/icon-font-generator

Last synced: 9 days ago
JSON representation

Easy-to-use, pre-configured cli tool to generate webfont icon kits from a bunch of .svg files

Host: GitHub
URL: https://github.com/Workshape/icon-font-generator
Owner: Workshape
License: mit
Created: 2016-03-30T16:23:41.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2023-04-21T12:38:23.000Z (over 1 year ago)
Last Synced: 2024-10-29T15:10:16.024Z (10 days ago)
Language: JavaScript
Size: 49.8 KB
Stars: 471
Watchers: 16
Forks: 76
Open Issues: 35
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

my-awesome-list - icon-font-generator - to-use, pre-configured cli tool to generate webfont icon kits from a bunch of .svg files | Workshape | 471 | (JavaScript)

README

> ### :warning: **Deprecated in favour of its complete re-write - please use [fantasticon](https://github.com/tancredi/fantasticon) instead**

![Icon](https://camo.githubusercontent.com/2b418776b6cc9cb7d90c68905d3381674f13d7ec/687474703a2f2f692e6375626575706c6f61642e636f6d2f4541367957612e706e67)

## Icon font generator

![Screenshot](https://camo.githubusercontent.com/7aaef96033be671fa29297c0efd6c50f97a502f6/68747470733a2f2f692e6375626575706c6f61642e636f6d2f65597736766a2e706e67)

> Easy-to-use, pre-configured cli tool to generate webfont icon kits from a bunch of .svg files

### Intro

This cli utility is ment to make webfont icon sets creation from the command line really simple - It wraps and pre-configures [webfonts-generator](https://www.npmjs.com/package/webfonts-generator), but allows for some degree of customisation.

It also does a couple extra things such as creating a .json file containing the icons to unicode characters map, which may be later used in styles, templates, etc..

#### Upgrading from v1.x.x

**!!** If you're upgrading from `v1.x.x` to `v2.x.x` - here's the changelog and thoubleshooting: https://github.com/Workshape/icon-font-generator/releases/tag/v2.1.2

**!!** `icon-font-generator` `v2.x.x >=` requires Node.js `>= v8.1.0` - is you wish to run on a lower version, use [v1.1.2](https://github.com/Workshape/icon-font-generator/releases/tag/v1.1.2)

### Install

```
npm install -g icon-font-generator
```

### Use

##### Quick usage

```
icon-font-generator my-icons/*.svg -o icon-dist
```

##### Cli params

```
Usage : icon-font-generator [ svg-icons-glob ] -o [ output-dir ] [ options ]
Example : icon-font-generator src/*.svg -o dist

Options:
-o, --out Output icon font set files to directory
-n, --name Name to use for generated fonts and files (Default: icons)
-s, --silent Do not produce output logs other than errors (Default: false)
-f, --fontspath Relative path to fonts directory to use in output files (Default: ./)
-c, --css Generate CSS file if true (Default: true)
--csspath CSS output path (Defaults to /.css)
--cssfontsurl CSS fonts directory url (Defaults to relative path)
--csstp CSS handlebars template path (Optional)
--html Generate HTML preview file if true (Default: true)
--htmlpath HTML output path (Defaults to /.html)
--types Font types - (Defaults to 'svg, ttf, woff, woff2, eot')
--htmltp HTML handlebars template path (Optional)
-j, --json Generate JSON map file if true (Default: true)
--jsonpath JSON output path (Defaults to /.json)
-p, --prefix CSS classname prefix for icons (Default: icon)
-t, --tag CSS base tag for icons (Default: i)
--selector Use a selector instead of 'tag + prefix' (Default: null)
--normalize Normalize icons sizes (Default: false)
--round Setup SVG rounding (Default: 10e12)
--descent Offset applied to the baseline (Default: 0)
--mono Make font monospace (Default: false)
--height Fixed font height value
--center Center font horizontally
```

### License