https://github.com/codersakl/laravel-elixir-fonts
This is a simple gulp-iconfont wrapper for Laravel Elixir
https://github.com/codersakl/laravel-elixir-fonts
elixir fonts icon icon-fonts laravel laravel-elixir
Last synced: about 1 month ago
JSON representation
This is a simple gulp-iconfont wrapper for Laravel Elixir
- Host: GitHub
- URL: https://github.com/codersakl/laravel-elixir-fonts
- Owner: CodersAKL
- License: mit
- Created: 2016-04-06T18:57:09.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-08-05T16:38:44.000Z (almost 4 years ago)
- Last Synced: 2025-05-09T00:53:00.275Z (about 1 month ago)
- Topics: elixir, fonts, icon, icon-fonts, laravel, laravel-elixir
- Language: JavaScript
- Size: 20.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Elixir Icon fonts
This is a simple [gulp-iconfont](https://github.com/nfroidure/gulp-iconfont)
and [gulp-iconfont-css](https://github.com/backflip/gulp-iconfont-css) wrapper for [Laravel Elixir](https://github.com/laravel/elixir).
## Install
Install this package over npm.
```sh
npm install laravel-elixir-fonts --save-dev
```
Require it in your `gulpfile.js` and use it.
```javascript
var elixir = require('laravel-elixir');
require('laravel-elixir-fonts');
elixir(function(mix) {
mix.fonts([elixir.config.assetsPath + '/svg/**/*.svg'], elixir.config.publicPath + '/fonts/', { font: { fontName: 'my_icons' } });
});
```
## How To
If you run `mix.fonts()` without parameters, it looks for all SVG-Files in `resources/assets/svg` (folders included).
The output of the `icons.css` file is in `resources/assets/css`.
The output of your `fonts` is in `public/assets/fonts`.
These are the default paths, they can be overwritten by `elixir.config.assetsPath` and `elixir.config.css.outputFolder` or by pass options. See the [config](https://github.com/laravel/elixir/blob/master/src/Config.js) file from elixir for more options.
## Options
#### Default options
```
{
font: {
normalize: true,
fontName: fontName, // required
prependUnicode: false, // recommended option
formats: ['ttf', 'eot', 'woff', 'woff2', 'svg'], // default, 'woff2' and 'svg' are available
timestamp: runTimestamp // recommended to get consistent builds when watching files
},
css: {
fontName: fontName,
targetPath: '../../' + elixirConfig.assetsPath + '/' + elixirConfig.css.sass.folder + '/' + fontName + '.scss',
fontPath: '../fonts/'
}
}
```