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

34 lines
818 B
Plaintext
Executable File

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