Octicons rails helper

Gem version Build Status

A rails helper that inlines SVG octicons

This rails helper let's you easily include svg octicons in your rails apps.

Install

  1. Add this to your Gemfile

    gem 'octicons_helper'
    
  2. Use this tag in your erbs

    <%= octicon "alert", :height => 32,  :class => "right left", :"aria-label" => "hi" %>
    

The minimum CSS you'll need in your rails app is in the octicons repository. You can also npm install that package and include build/octicons.css in your styles.

Documentation

For a full list of options available, see the octicons_gem documentation

License

(c) 2012-2016 GitHub, Inc.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

Font License: SIL OFL 1.1
Applies to all font files and SVG files

Code License: MIT
Applies to all other files