https://github.com/vitch/ember-cli-webfont

Easily generate webfonts from svg files as part of your ember-cli build process
https://github.com/vitch/ember-cli-webfont

Last synced: 3 months ago
JSON representation

Easily generate webfonts from svg files as part of your ember-cli build process

• Host: GitHub
• URL: https://github.com/vitch/ember-cli-webfont
• Owner: vitch
• License: mit
• Created: 2015-06-25T16:17:41.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-06-01T06:24:01.000Z (over 3 years ago)
• Last Synced: 2024-11-02T04:51:43.529Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 114 KB
• Stars: 21
• Watchers: 1
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ember - ember-cli-webfont - Easily generate webfonts from svg files as part of your ember-cli build process. (Packages / Fonts)

README

        
# ember-cli-webfont

This addon wraps [webfonts-generator](https://github.com/sunflowerdeath/webfonts-generator) to allow you to easily generate webfonts as part of your ember build process.

## Installation

```js

ember install ember-cli-webfont

```

## Usage

By default the addon expects to find your SVG files in `app/webfont-svg` and will add CSS classes to your generated CSS.

To use the icons you just need to give an element these classes e.g.

```html



```

Will display the SVG from `app/webfont-svg/ember.svg` (with the default values for `path`, `classPrefix` and `baseSelector` - see below).

## Configuration

You can configure the behaviour of the addon by passing a hash of options when initialising your ember app. The names of parameters and default options are shown below:

```js

var app = new EmberApp({

  webfont: {

    path: 'app/webfont-svg/',

    options: {

      files: ['**/*.svg'],

      dest: 'assets/webfonts/',

      fontName: 'iconfont',

      cssDest: 'temp/ember-cli-webfont.css',

      cssFontsUrl: 'webfonts/',

      cssTemplate: webfont.templates.css,

      templateOptions: {

        classPrefix: 'iconfont-',

        baseSelector: '.iconfont'

      }

    }

  }

});

```

Documentation on these options can be found on the [webfonts-generator](https://github.com/sunflowerdeath/webfonts-generator#list-of-options) repository.

Additionally the `cssDest` option can go through some extra processing.

If left out, the default value is `temp/ember-cli-webfont.css` and the resulting file will be imported into `vendor.css` automatically.

Otherwise it has to be imported manually. The latter is useful when using `Sass`, `LESS`, or other CSS preprocessors.

# Developing addon

## Installation

* `git clone` this repository

* `npm install`

* `bower install`

## Running

* `ember server`

* Visit your app at http://localhost:4200.

## Running Tests

* `ember test`

* `ember test --server`

## Building

* `ember build`

For more information on using ember-cli, visit [http://www.ember-cli.com/](http://www.ember-cli.com/).