izaakschroeder/compass-fontcustom

Font Custom integration with Compass

Compass::Fontcustom

This is my attempt of integrating Font Custom with Compass.

Requirements

Made for ruby 1.9+. Tested on 1.9.3 and 2.0.0.
You'll need to have fontforge and the WOFF font toolset installed as outlined in the Font Custom installation instructions.

Installation

Add this line to your application's Gemfile:

gem 'compass-fontcustom'

or:

gem 'compass-fontcustom', :github => 'glaszig/compass-fontcustom'

And then execute:

$ bundle

Usage

Syntactically it works like Compass' sprites feature.
You can let Font Custom generate your fonts upon Compass' css compilation:

@import "myfont/*.svg";
@include all-myfont-glyphs;

This will setup a proper @font-face and generate icon classes named .icon-<font_name>-<glyph_name> for each glyph.

Custom class names

You can also use custom class names using the <font_name>-glyph() mixin:

.custom-class-name {
  @include myfont-glyph(glyph-file-name);
}

which will result into CSS along the lines of:

.myfont-font, .custom-class-name {
  font-family: "myfont";
}
.custom-class-name:before {
  content: "\f100";
}

Attention
Generated CSS class names will be normalized and reserved characters removed.
That means if you have a glyph file name of a_R3ally-eXotic f1Le+Name.svg the generated class name will be .icon-myfont-a_R3ally-eXotic-f1Le-Name.

Configuration options

Filename hashing

You can choose to disable file name hashes if you're already using an asset pipeline which handles this for you: Use the fontcustom_hash option in config.rb

compass_config do |config|
  config.fontcustom_hash = false
end

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

License

MIT