jekyll-octicons_v2 0.0.0.pre.2e689fb → 0.0.0.pre.02f9d7a
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +43 -2
- data/lib/build/data.json +1 -1
- data/lib/build/svg/grabber-3-24.svg +3 -0
- data/lib/jekyll-octicons/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4d8215eaa9e7861e0f994823bf23c4fefb5d0a67a19038583908e4ce5b7193f5
|
|
4
|
+
data.tar.gz: ad0f0ec7d96f01bfdfbd2bcb56c5c0ba8852f8de9a0f10a7da3674a0603eecc9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e8b069a73b574b70b0cd48d7268d81d44f289ecf2f9b02838ae617c980627737f8195c6bb8e860248b9a30316db8cbc5dd854f3b09161fe0531e7ad3c1b8a5bc
|
|
7
|
+
data.tar.gz: e62527b181a7c073bd314e2837478bbf6896b146853fe34607240c9ab8feb2b8142fc3efa7d07c5eac821c5dadb5df4310af561e5c68f9feea097f9c685712e7
|
data/README.md
CHANGED
|
@@ -1,5 +1,46 @@
|
|
|
1
|
-
# jekyll
|
|
1
|
+
# Octicons jekyll tag
|
|
2
2
|
|
|
3
3
|
[](https://rubygems.org/gems/jekyll-octicons)
|
|
4
|
+
[](https://travis-ci.org/primer/octicons)
|
|
4
5
|
|
|
5
|
-
|
|
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/
|