Compass font-icons generator
Ruby
Pull request Compare This branch is 16 commits behind krisbulman:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
lib
stylesheets
.gitignore
Gemfile
LICENSE.txt
README.markdown
Rakefile
VERSION.yml
font-icons.gemspec

README.markdown

Install

# Get the compass extension:
$ sudo gem install font-icons --pre

# Add the following lines to your compass configuration file:
require 'font-icons'

# Adding a font to your library is achieved by running the following command within an existing compass project:
$ compass install -r font-icons font-icons/FONTNAME

# The following paramaters are accepted:
iconic, entypo

# Optionally, you can install all fonts at once using: 
$ compass install -r font-icons font-icons

Update

# Uninstall the compass extension:
$ sudo gem uninstall font-icons

# Install the compass extension again:
$ sudo gem install font-icons --pre

Usage

// Import font-icons compass extension
@import "font-icons";

// Add the font family
@include font-icon-family(entypo);

// Style your heart out
ul.entypo {
  list-style: none;
  list-style-image: none;
  li {
    @include font-icon-base(entypo); 
    &.menu-item-001 { @extend %entypo-music; }
  }
}

// To any piece of content
.randomcontent {
    @include font-icon-base(entypo); 
    @extend %entypo-music;
}

Arguments

@include font-icon-base($family:"iconic", $font-size: 1em, $width: 1em, $margin: 0.8em)

Font Attribution

Fonts included from the Entypo font icon set created by Daniel Bruce
http://www.entypo.com
License: SIL Open Font License

Fonts included from the Iconic font icon set created by P.J. Onori
http://somerandomdude.com/work/iconic/
License: SIL Open Font License

License

See LICENSE.txt