Sha256: f10095f8264710ed2f6f2fd7c4177df9dcb78ea5464dd0dd7ef08c18b708bc8f

Contents?: true

Size: 1.25 KB

Versions: 273

Compression:

Stored size: 1.25 KB

Contents

# Octicons jekyll tag

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

> A liquid jekyll tag that injects Octicon svg into the page

This jekyll liquid tag, is a plugin that will let you easily include svg [octicons][octicons-docs] in your jekyll sites.

## Install

1. Add this to your `Gemfile`

    ```rb
    gem 'jekyll-octicons'
    ```

2. Add this to your jekyll `_config.yml`

    ```yml
    gems:
      - jekyll-octicons
    ```

3. Use this tag in your jekyll templates

    ```
    {% 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

273 entries across 273 versions & 2 rubygems

Version Path
jekyll-octicons_v2-0.0.0.pre.fcf1e9b README.md
jekyll-octicons_v2-0.0.0.pre.bd1caad README.md
jekyll-octicons_v2-0.0.0.pre.6933f36 README.md
jekyll-octicons_v2-0.0.0.pre.02f9d7a README.md
jekyll-octicons-0.0.0.pre.d68b03f README.md
jekyll-octicons_v2-0.0.0.pre.064e3ab README.md
jekyll-octicons_v2-0.0.0.pre.117d2c0 README.md
jekyll-octicons_v2-0.0.0.pre.d090062 README.md
jekyll-octicons_v2-0.0.0.pre.cb6d341 README.md
jekyll-octicons_v2-0.0.0.pre.3ba887a README.md
jekyll-octicons_v2-0.0.0.pre.8694773 README.md
jekyll-octicons_v2-0.0.0.pre.60ee16f README.md
jekyll-octicons-0.0.0.pre.41dafc6 README.md
jekyll-octicons-0.0.0.pre.4e4ee6b README.md
jekyll-octicons-0.0.0.pre.3591cae README.md
jekyll-octicons-0.0.0.pre.9717ac6 README.md
jekyll-octicons-9.6.0 README.md
jekyll-octicons-0.0.0.pre.6471865 README.md
jekyll-octicons-9.6.0.pre.4570a32 README.md
jekyll-octicons-9.6.0.pre.dccb657 README.md