jekyll-octicons_v2 0.0.0.pre.61b6959 → 0.0.0.pre.064e3ab

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 053be9ff54cd055a243aa6db78ba70b301a1f2df440c41388382631c9e191dbe
4
- data.tar.gz: ade2ef01d6b9f4165719de1e26adbebbda131a17ec11175270091bafe733176b
3
+ metadata.gz: 72cc587cc34abb19deaba58d0163da19458de93e9113e6e0a4ede570ea1fa8d6
4
+ data.tar.gz: 5542c6c191d25c172e5b7bde4acb23204cfa7059fe1471eeb937d2aa0066d7cd
5
5
  SHA512:
6
- metadata.gz: e518fc6a0533fd476adac7865771a38fb05194f4c352c84e9f7908ff149ea631fb094f90f5f047657a8639b381cf0ac2a8b096865c8bee8fb3515de4feb4b7b4
7
- data.tar.gz: 758278f8ea55da198d24188e02ee80ee3ce5e1854d75978a6d4edc45785f2c412f756d350ce56821987c187bb923811f24323c500ae2703ade8989298e6e4285
6
+ metadata.gz: 9656706517d00025da6e05361392c2b5b7d08a32b4e0364a75a35e0e547b2eca0c21fe4a0bfc29aa0ebeb36a260d5876f43f1b96a4f869020d42d94f77aa9270
7
+ data.tar.gz: 14f0c75fdcdf71a289bc7c16c6a7f001bfd0e7d9df077b6994324e8863a542932261db91b9392c73b0f3f8df8d0cf189ae48f7cfa516e072edbadc02b49474e1
data/README.md CHANGED
@@ -1,5 +1,46 @@
1
- # jekyll-octicons
1
+ # Octicons jekyll tag
2
2
 
3
3
  [![Gem version](https://img.shields.io/gem/v/jekyll-octicons.svg)](https://rubygems.org/gems/jekyll-octicons)
4
+ [![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)
4
5
 
5
- See https://primer.style/octicons/packages/jekyll
6
+ > A liquid jekyll tag that injects Octicon svg into the page
7
+
8
+ This jekyll liquid tag, is a plugin that will let you easily include svg [octicons][octicons-docs] in your jekyll sites.
9
+
10
+ ## Install
11
+
12
+ 1. Add this to your `Gemfile`
13
+
14
+ ```rb
15
+ gem 'jekyll-octicons'
16
+ ```
17
+
18
+ 2. Add this to your jekyll `_config.yml`
19
+
20
+ ```yml
21
+ gems:
22
+ - jekyll-octicons
23
+ ```
24
+
25
+ 3. Use this tag in your jekyll templates
26
+
27
+ ```
28
+ {% octicon alert height:32 class:"right left" aria-label:hi %}
29
+ ```
30
+
31
+ 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.
32
+
33
+ ## Documentation
34
+
35
+ For a full list of options available, see the [octicons_gem documentation](../octicons_gem/#documentation)
36
+
37
+ ## License
38
+
39
+ (c) GitHub, Inc.
40
+
41
+ When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
42
+
43
+ [MIT](./LICENSE)
44
+
45
+ [octicons]: https://github.com/primer/octicons
46
+ [octicons-docs]: https://octicons.github.com/