Skip to content

Instantly share code, notes, and snippets.

Last active April 21, 2024 15:50
Show Gist options
  • Save benbalter/5555251 to your computer and use it in GitHub Desktop.
Save benbalter/5555251 to your computer and use it in GitHub Desktop.
Example of how to embed a Gist on GitHub Pages using Jekyll.

Here's an example of how to embed a Gist on GitHub Pages:

{% gist 5555251 %}

All you need to do is copy and paste the Gist's ID from the URL (here 5555251), and add it to a gist tag surrounded by {% and %}.

And here's what it would look like rendered:

Rendered Gist

Copy link

lowellk commented May 14, 2013

The rendered output looks odd for the gist link

Copy link

I wonder if being meta makes this harder to understand.

Copy link

zeke commented May 19, 2013


Copy link

slice commented May 22, 2013

Wow, this addition looks useful.

Copy link

Is there a way to embed a single file? Yes there is!

{% gist 5555251 %}

Copy link

kidlj commented Sep 14, 2013

Nice tip. forked.

Copy link

leahcim commented Mar 30, 2014

Cool, thanks!

Copy link

abhiesa commented Aug 5, 2014

No solution, till end, what is cool, i don't understand.
Just contacted Github, and put this as a feature request.
Hope, that anybody sees this, will also do the same.

Copy link

h4ckm03d commented Aug 7, 2014

very useful, thanks. 👯

Copy link

is this feature still working guys? i couldn't get it to work!!

Copy link

iplus26 commented Sep 26, 2015

Yes, it works and it's pretty!

Copy link

What about for non-gists?

Copy link

hndr91 commented Sep 21, 2016

I've tried and it doesn't work. I just paste gist embed code on page and it work

Copy link

alejobit commented Oct 28, 2016

It works by installing

But I prefer to use:

<script src=""></script>
<script src=""></script>

Copy link

ogurcan commented Mar 8, 2017

I tried to embed <script src=""></script> and other examples in an .md file, however it doesnt work :(

Copy link

palevell commented Oct 9, 2017

This didn't work for me . . .
Error: Liquid syntax error (line 3): Unknown tag 'gist'

But, using the Embed code from the gist page worked, just fine.

Copy link

weibeld commented Oct 29, 2017

Note that for this to work, you need to have the following in your Gemfile:

gem "github-pages", group: :jekyll_plugins

This installs, among others, the jekyll-gist gem which provides the {% gist %} tag. Without the jekyll-gist gem, Jekyll reports a Unknown tag 'gist' error when the site is built locally.

Of course, you could also have just gem "jekyll-gist" in your Gemfile, and the local build should work (and on GitHub Pages this gem is installed anyway). But if you're anyway deploying to GitHub Pages, it is much better to use the github-pages gem (which includes the jekyll-gist gem), as shown above, for the following reason:

The github-pages gem installs locally all the gems that are also installed on GitHub Pages, and the same versions of these gems. This ensures that your local build environment is the same as the build environment used on GitHub Pages. So, it is ensured that everything that works locally, will also work on GitHub Pages, and that the site will look the same on GitHub Pages as it looks on your local machine.

You basically don't need anything else than gem "github-pages", group: :jekyll_plugins in the Gemfile for best compatibility with GitHub Pages.

Copy link

Is there any way to link a revision of a gist file?

Copy link

^^^ I want this feature also!!! I want to be abled to embed each revision of a gist.

Copy link

What are you talking about

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment