File tree Expand file tree Collapse file tree 2 files changed +24
-7
lines changed Expand file tree Collapse file tree 2 files changed +24
-7
lines changed Original file line number Diff line number Diff line change 11# Jekyll::Gist
22
3- TODO: Write a gem description
3+ Liquid tag for displaying GitHub Gists in Jekyll sites: ` {% gist %} ` .
44
55## Installation
66
@@ -18,11 +18,29 @@ Or install it yourself as:
1818
1919## Usage
2020
21- TODO: Write usage instructions here
21+ Use the tag as follows in your Jekyll pages, posts and collections:
22+
23+ ``` liquid
24+ {% gist parkr/c08ee0f2726fd0e3909d %}
25+ ```
26+
27+ This will create the associated script tag:
28+
29+ ``` html
30+ <script src =" https://gist.github.com/parkr/c08ee0f2726fd0e3909d.js" > </script >
31+ ```
32+
33+ You may optionally specify a ` filename ` after the ` gist_id ` :
34+
35+ ``` liquid
36+ {% gist parkr/c08ee0f2726fd0e3909d test.md %}
37+ ```
38+
39+ This will produce the correct URL to show just the specified file in your post rather than the entire Gist.
2240
2341## Contributing
2442
25- 1 . Fork it ( https://github.com/[my-github-username ] /jekyll-gist/fork )
43+ 1 . Fork it ( https://github.com/jekyll /jekyll-gist/fork )
26442 . Create your feature branch (` git checkout -b my-new-feature ` )
27453 . Commit your changes (` git commit -am 'Add some feature' ` )
28464 . Push to the branch (` git push origin my-new-feature ` )
Original file line number Diff line number Diff line change 11# coding: utf-8
22lib = File . expand_path ( '../lib' , __FILE__ )
33$LOAD_PATH. unshift ( lib ) unless $LOAD_PATH. include? ( lib )
4- require 'jekyll/ gist/version'
4+ require 'jekyll- gist/version'
55
66Gem ::Specification . new do |spec |
77 spec . name = "jekyll-gist"
88 spec . version = Jekyll ::Gist ::VERSION
99 spec . authors = [ "Parker Moore" ]
1010 spec . email = [ "parkrmoore@gmail.com" ]
11- spec . summary = %q{TODO: Write a short summary. Required.}
12- spec . description = %q{TODO: Write a longer description. Optional.}
13- spec . homepage = ""
11+ spec . summary = %q{Liquid tag for displaying GitHub Gists in Jekyll sites.}
12+ spec . homepage = "https://github.com/jekyll/jekyll-gist"
1413 spec . license = "MIT"
1514
1615 spec . files = `git ls-files -z` . split ( "\x0 " )
You can’t perform that action at this time.
0 commit comments