Skip to content

Jekyll

Table of contents
Table of contents

Gem version

The Jekyll liquid tag is a plugin that lets you include 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 height:32 class:"right left" aria-label:hi %}

We recommend including the CSS in the @primer/octicons npm module. You can also npm install that package and include build/build.css in your styles.