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_v2_helper-0.0.0.pre.fcf1e9b README.md
octicons_v2_helper-0.0.0.pre.bd1caad README.md
octicons_v2_helper-0.0.0.pre.6933f36 README.md
octicons_v2_helper-0.0.0.pre.02f9d7a README.md
octicons_helper-0.0.0.pre.d68b03f README.md
octicons_v2_helper-0.0.0.pre.064e3ab README.md
octicons_v2_helper-0.0.0.pre.117d2c0 README.md
octicons_v2_helper-0.0.0.pre.d090062 README.md
octicons_v2_helper-0.0.0.pre.cb6d341 README.md
octicons_v2_helper-0.0.0.pre.3ba887a README.md
octicons_v2_helper-0.0.0.pre.8694773 README.md
octicons_v2_helper-0.0.0.pre.60ee16f README.md
octicons_helper-0.0.0.pre.41dafc6 README.md
octicons_helper-0.0.0.pre.4e4ee6b README.md
octicons_helper-0.0.0.pre.3591cae README.md
octicons_helper-0.0.0.pre.9717ac6 README.md
octicons_helper-9.6.0 README.md
octicons_helper-0.0.0.pre.6471865 README.md
octicons_helper-9.6.0.pre.4570a32 README.md
octicons_helper-9.6.0.pre.dccb657 README.md