Skip to content

Commit

Permalink
add information about installing the icons task
Browse files Browse the repository at this point in the history
  • Loading branch information
Arjen Smit committed Aug 2, 2016
1 parent 0252cdf commit 5f4d322
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,24 @@ Example configuration of config.json:
}
```

## icons task

With the icons tasks it's possible to convert a set of svg's to a font family. The result is a folder with fonts and an scss file with variables and mixins that can be used to use it in your project.

Example configuration:

```json
"icons": {
"src": [
"icons/*.svg"
],
"formats": ["ttf", "eot", "woff", "svg", "woff2"],
"dest": "web/assets/fonts/",
"webpath": "/assets/fonts/"
},
```

- `src` the path to the source svg's.
- `formats` (not required) but can be used to overwrite the font types that are generated (ttf, eot, woff, svg, woff2 is the default).
- `dest` the path on the disk where the font will be placed
- `webpath` the path used by the browser to request the fonts

0 comments on commit 5f4d322

Please sign in to comment.