Easily embed GitHub Gists in your Pelican articles.
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:
PLUGINS = [ # ... 'pelican_gist', # ... ]
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 brew-update-notifier.sh into your post. The resulting HTML will look like:
<div class="gist"> <script src='https://gist.github.com/3254906.js?file=brew-update-notifier.sh'></script> <noscript> <pre><code>#!/bin/bash ...</code></pre> </noscript> </div>
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='https://gist.github.com/3254906.js'></script> <noscript> <pre><code>#!/bin/bash ...</code></pre> </noscript> </div>
If a file type is specified, uses pygment to highlight the noscript version of the code:
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) GIST_PYGMENTS_STYLE - Style used by pygments for syntax highlighting. Possible values are the strings from pygments.styles.get_all_styles(). Default is 'default'. (Optional) GIST_PYGMENTS_LINENUM - Defines if pygments should add line numbers to the rendered HTML. Default is False. (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/test_plugin.py ..... ====================== 5 passed in 0.11 seconds ======================
- 0.3.4 - Fix regex to support filetype (credit [@andrlik](https://github.com/andrlik))
- 0.3.3 - Support gists with UTF-8 characters
- 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.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Hash SHA256 Hash Help||Version||File Type||Upload Date|
(8.3 kB) Copy SHA256 Hash SHA256
|2.7||Wheel||Jan 15, 2018|
(6.2 kB) Copy SHA256 Hash SHA256
|–||Source||Jan 15, 2018|