Skip to main content

Easily embed GitHub Gists in your Pelican articles.

Project description

Pelican Gist Tag is a library to make it easy to GitHub Gists in your Pelican blogs.


To install pelican-gist, simply:

$ pip install pelican-gist

Then add a bit of code to your blog configuration:

    # ...
    # ...


In your articles, just add lines to your posts that look like:


This will tell the plugin to insert gist id 3254906 and choose the file into your post. The resulting HTML will look like:

<div class="gist">
    <script src=''></script>
        <pre><code>#!/bin/bash ...</code></pre>

If your gist has only a single file, you can also specify the gist like so:


Notice it is using the id only. The resulting HTML will look like:

<div class="gist">
    <script src=''></script>
        <pre><code>#!/bin/bash ...</code></pre>

There is also support for private gists where they have the gist id that looks like e34db4c532a6cfa1f711.


GIST_CACHE_ENABLED - Specifies whether to cache the gist on disk or not. Default is True. (Optional)


Install the necessary requirements with pip install -r requirements.txt. Once those are installed, you can run the tests with: py.test. So the whole workflow looks like:

$ pip install -r requrements.txt
Successfully installed pytest requests mock py
Cleaning up...
$ py.test
======================== test session starts =========================
platform darwin -- Python 2.7.6 -- pytest-2.5.1
collected 5 items

pelican_gist/ .....

====================== 5 passed in 0.11 seconds ======================


See contributors on GitHub.


  • 0.3.2 - Added universal wheel support
  • 0.3.1 - Fixed an issue with Python 3 and fetching gist content
  • 0.3.0 - Added Python 3 support


Uses the MIT license.

Project details

Release history Release notifications

History Node


History Node


This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pelican_gist-0.3.2-py2.py3-none-any.whl (7.3 kB) Copy SHA256 hash SHA256 Wheel 2.7 Jan 20, 2014
pelican-gist-0.3.2.tar.gz (5.4 kB) Copy SHA256 hash SHA256 Source None Jan 20, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page