No Description

Duncan Lock b998ad60e0 Updated to cope with multiple images and figures, and to deal with indivdual images. 11 years ago
assets 31ccbde072 teach plugins with dependencies to behave 11 years ago
better_figures_and_images b998ad60e0 Updated to cope with multiple images and figures, and to deal with indivdual images. 11 years ago
extract_toc 45b3094247 Adds Extract table of contents plugin 11 years ago
github_activity 31ccbde072 teach plugins with dependencies to behave 11 years ago
global_license 9e70c17839 import plugins from core and restructure repo 11 years ago
goodreads_activity 31ccbde072 teach plugins with dependencies to behave 11 years ago
gravatar 9e70c17839 import plugins from core and restructure repo 11 years ago
gzip_cache c694cb404d move tests to plugin folder 11 years ago
html_rst_directive 9e70c17839 import plugins from core and restructure repo 11 years ago
latex 9e70c17839 import plugins from core and restructure repo 11 years ago
multi_part 9e70c17839 import plugins from core and restructure repo 11 years ago
neighbors 9e70c17839 import plugins from core and restructure repo 11 years ago
random_article 9e70c17839 import plugins from core and restructure repo 11 years ago
related_posts 9e70c17839 import plugins from core and restructure repo 11 years ago
sitemap 9e70c17839 import plugins from core and restructure repo 11 years ago
summary c694cb404d move tests to plugin folder 11 years ago
test_data 31ccbde072 teach plugins with dependencies to behave 11 years ago
w3c_validate a4df915490 Minor improvements to W3C Validator plugin README 11 years ago
.gitignore 31ccbde072 teach plugins with dependencies to behave 11 years ago
.travis.yml 31ccbde072 teach plugins with dependencies to behave 11 years ago
Contributing.rst 31ccbde072 teach plugins with dependencies to behave 11 years ago
LICENSE 66e83158ba Adding LICENSE file for Affero GPL 11 years ago
Readme.rst 9e70c17839 import plugins from core and restructure repo 11 years ago

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.

.. _Contributing: Contributing.rst