Jekyll::Gist
Liquid tag for displaying GitHub Gists in Jekyll sites: {% gist %}.
Installation
Add this line to your application's Gemfile:
gem 'jekyll-gist'
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-gist
Finally, add the following to your site's _config.yml:
gems:
- jekyll-gist
Usage
Use the tag as follows in your Jekyll pages, posts and collections:
{% gist parkr/c08ee0f2726fd0e3909d %}
This will create the associated script tag:
<script src="https://gist.github.com/parkr/c08ee0f2726fd0e3909d.js"> </script>
You may optionally specify a filename after the gist_id:
{% gist parkr/c08ee0f2726fd0e3909d test.md %}
This will produce the correct URL to show just the specified file in your post rather than the entire Gist.
Pro-tip: If you provide a personal access token with Gist scope, as the environmental variable JEKYLL_GITHUB_TOKEN, Jekyll Gist will use the Gist API to speed up site generation.
Disabling noscript support
By default, Jekyll Gist will make an HTTP call per Gist to retrieve the raw content of the Gist. This information is used to propagate noscript tags for search engines and browsers without Javascript support. If you'd like to disable this feature, for example, to speed up builds locally, simply add the following to your site's _config.yml:
gist:
noscript: false
Contributing
- Fork it ( https://github.com/jekyll/jekyll-gist/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request