No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 2 commits ahead, 1280 commits behind getpelican:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
better_figures_and_images
code_include
disqus_static
ditaa
extract_toc
github_activity
global_license
goodreads_activity
gravatar
gzip_cache
html_rst_directive
ical
latex
multi_part
neighbors
optimize_images
post_stats
random_article
related_posts
sitemap
summary
test_data
thumbnailer
w3c_validate
.gitignore
.travis.yml
Contributing.rst
LICENSE
Readme.rst

Readme.rst

Pelican Plugins

Beginning with version 3.0, Pelican supports plugins. Plugins are a way to add features to Pelican without having to directly modify the Pelican core. Starting with 3.2, all plugins (including the ones previously in the core) are moved here, so this is the central place for all plugins.

How to use plugins

Easiest way to install and use these plugins is cloning this repo:

git clone https://github.com/getpelican/pelican-plugins

and activating the ones you want in your settings file:

PLUGIN_PATH = 'path/to/pelican-plugins'
PLUGINS = ['assets', 'sitemap', 'gravatar']

PLUGIN_PATH can be a path relative to your settings file or an absolute path.

Alternatively, if plugins are in an importable path, you can omit PLUGIN_PATH and list them:

PLUGINS = ['assets', 'sitemap', 'gravatar']

or you can import the plugin directly and give that:

import my_plugin
PLUGINS = [my_plugin, 'assets']

Please refer to the Readme file in a plugin's folder for detailed information about that plugin.

Contributing a plugin

Please refer to the Contributing file.