Sha256: c67565bb9551eecf2adbc68216790f4cf3e136df1b97215851927d01f6b64450

Contents?: true

Size: 1.13 KB

Versions: 276

Compression:

Stored size: 1.13 KB

Contents

# Octicons rails helper

[![Gem version](https://img.shields.io/gem/v/octicons_helper.svg)](https://rubygems.org/gems/octicons_helper)
[![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)

> A rails helper that inlines SVG octicons

This rails helper let's you easily include svg [octicons][octicons-docs] in your rails apps.

## Install

1. Add this to your `Gemfile`

    ```rb
    gem 'octicons_helper'
    ```

3. Use this tag in your erbs

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

We recommend including the CSS in the [octicons_node](../octicons_node/) module. You can also npm install that package and include `build/build.css` in your styles.

## Documentation

For a full list of options available, see the [octicons_gem documentation](../octicons_gem/#documentation)

## License

(c) GitHub, Inc.

When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).

[MIT](./LICENSE)  

[octicons]: https://github.com/primer/octicons
[octicons-docs]: https://octicons.github.com/

Version data entries

276 entries across 276 versions & 2 rubygems

Version Path
octicons_helper-0.0.0.pre.8fec3b3 README.md
octicons_helper-0.0.0.pre.162f0a7 README.md
octicons_helper-0.0.0.pre.9974e2e README.md
octicons_helper-0.0.0.pre.29e70d1 README.md
octicons_helper-0.0.0.pre.47c1571 README.md
octicons_helper-0.0.0.pre.1eb8378 README.md
octicons_helper-0.0.0.pre.27f6545 README.md
octicons_helper-0.0.0.pre.1241cfc README.md
octicons_helper-0.0.0.pre.309dc1d README.md
octicons_helper-0.0.0.pre.4c77211 README.md
octicons_v2_helper-0.0.0.pre.6e304cc README.md
octicons_v2_helper-0.0.0.pre.06b15aa README.md
octicons_helper-0.0.0.pre.3c65f8d README.md
octicons_helper-0.0.0.pre.5ab3fff README.md
octicons_v2_helper-0.0.0.pre.69c00e6 README.md
octicons_v2_helper-0.0.0.pre.617ea40 README.md
octicons_v2_helper-0.0.0.pre.e992db1 README.md
octicons_v2_helper-0.0.0.pre.71df20a README.md
octicons_v2_helper-0.0.0.pre.d793318 README.md
octicons_v2_helper-0.0.0.pre.08562a6 README.md