Octicons jekyll tag

Gem version Build Status

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 in your jekyll sites.

Install

  1. Add this to your Gemfile

    gem 'jekyll-octicons'

  2. Add this to your jekyll _config.yml

    gems:
  - jekyll-octicons

  3. Use this tag in your jekyll templates

    {% octicon alert size:large class:"right left" aria-label:hi %}

The minimum CSS you'll need in your jekyll site 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

Code License: MIT © GitHub

Font License: SIL OFL 1.1 © GitHub