Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Easily embed Github files in your Pelican articles.

Project description

Pelican Git is a library that makes it easy to embed GitHub files in your Pelican blogs using simple syntax.

Installation

To install pelican-git, simply:

$ pip install pelican-git

Then add a bit of code to your blog configuration:

PLUGINS = [
    # ...
    'pelican_git',
    # ...
]

Usage

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

[git:repo=yourname/yourrepo,file=somefile,branch=master,hash=xxxxxxx]

branch and hash are optional. If you don’t specify branch, it will be master. If you specify hash it will overwrite the branch setting.

The generated code will embed css and html content directly into a div and replace the original tag. This is faster and cleaner than using javascript to rewrite the page content like what gist_it does.

Settings

GIT_CACHE_ENABLED - Specifies whether to cache the git files on disk or not. Default is False. (Optional)

Testing

$ make install
$ make test

Authors

Ha.Minh

Inspired by pelican_gist

Changelog

  • 0.1.8 - Fix link to original repo
  • 0.1.0 - Initial version

License

Uses the MIT license.

Bitdeli badge

Project details


Release history Release notifications

This version
History Node

0.1.10

History Node

0.1.9

History Node

0.1.8

History Node

0.1.7

History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

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_git-0.1.10-py2.py3-none-any.whl (9.0 kB) Copy SHA256 hash SHA256 Wheel 2.7 Oct 13, 2015
pelican-git-0.1.10.tar.gz (6.8 kB) Copy SHA256 hash SHA256 Source None Oct 13, 2015

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