virt2/api/img/octicons/10.0.0/docs/content/packages/rails.mdx

26 lines
705 B
Plaintext
Executable File

---
title: Rails
status: Stable
source: 'https://github.com/primer/octicons/tree/master/lib/octicons_helper'
---
[![Gem version](https://img.shields.io/gem/v/octicons_helper.svg)](https://rubygems.org/gems/octicons_helper)
This rails helper lets you easily include svg octicons 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 [`@primer/octicons`](/packages/javascript) npm module. You can also npm install that package and include `build/build.css` in your styles.