Are you happy with your logging solution? Would you help us out by taking a 30-second survey? Click here

jekyll-gist

:page_with_curl: Liquid tag for displaying GitHub Gists in Jekyll sites.

Subscribe to updates I use jekyll-gist


Statistics on jekyll-gist

Number of watchers on Github 135
Number of open issues 3
Average time to close an issue 2 months
Main language Ruby
Average time to merge a PR 10 days
Open pull requests 1+
Closed pull requests 3+
Last commit over 1 year ago
Repo Created over 5 years ago
Repo Last Updated over 1 year ago
Size 95 KB
Homepage https://rubygems....
Organization / Authorjekyll
Latest Releasev1.5.0
Contributors7
Page Updated
Do you use jekyll-gist? Leave a review!
View open issues (3)
View jekyll-gist activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating jekyll-gist for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

Jekyll::Gist

Liquid tag for displaying GitHub Gists in Jekyll sites: {% gist %}.

Build Status

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

Then add the following to your site's _config.yml:

plugins:
  - jekyll-gist

If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.

Usage

Use the tag as follows in your Jekyll pages, posts and collections:

{% gist 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 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, add the following to your site's _config.yml:

gist:
  noscript: false

Contributing

  1. Fork it ( https://github.com/jekyll/jekyll-gist/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request
jekyll-gist open issues Ask a question     (View All Issues)
  • about 3 years Liquid Exception: GET 404 Not Found
  • over 4 years Support github enterprise gists
jekyll-gist open pull requests (View All Pulls)
  • Strip Octothorpe
jekyll-gist questions on Stackoverflow (View All Questions)
  • Automatically changing of script src when jekyll gist tag is used with private gist
jekyll-gist list of languages used
jekyll-gist latest release notes
v1.5.0 v1.5.0

Documentation

  • Replace 'plugins' key in config with 'gems' (#46)
  • Remove username in gist (#54)

Development Fixes

  • Drop support for Jekyll 2.x
  • Requires Ruby > 2.1
  • Define path with __dir__ (#47)
  • Inherit Jekyll's rubocop config for consistency (#48)
  • Define path with dir (#47)
v1.4.1 v1.4.1
  • Don't ask .empty? until it's a String. (#38)
  • rename Liquid 4 has_key? to key? to add compatibility for liquid 4 (#41)
  • Test against Ruby 2.1 to 2.4 (#45)
v1.4.0 v1.4.0
  • Allow noscript fallback to be disabled (#29)
  • Use Octokit to fetch Gist content when passed JEKYLL_GITHUB_TOKEN in env(#28)

This release is courtesy of @benbalter. Thanks, Ben!

Other projects in Ruby