Skip to content

Commit

Permalink
Merge pull request #43 from Arjen-Smit/updated-documentation
Browse files Browse the repository at this point in the history
Updated documentation
  • Loading branch information
ahoek committed Aug 2, 2016
2 parents 25f0407 + 5f4d322 commit 6b43707
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,14 +153,6 @@ Example configuration:
With the task inline-images you can create a 'sprite' of inline css images. The task
generates an scss file with the inline-image($name) mixin and .inline-image-* css classes.

Make sure the following packages are available:

```json
"gulp-add-src": "^0.2.0",
"gulp-concat": "^2.5.2",
"gulp-image-data-uri": "^1.2.1",
```

Example configuration of config.json:

```json
Expand All @@ -171,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 6b43707

Please sign in to comment.