caleb/pelican-plugins @ 31ccbde072e4a7df204a73374d32010cd1180404

Ei kuvausta

2 Haarat

Deniz Turgut 31ccbde072 teach plugins with dependencies to behave		11 vuotta sitten
assets	31ccbde072 teach plugins with dependencies to behave	11 vuotta sitten
github_activity	31ccbde072 teach plugins with dependencies to behave	11 vuotta sitten
global_license	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten
goodreads_activity	31ccbde072 teach plugins with dependencies to behave	11 vuotta sitten
gravatar	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten
gzip_cache	c694cb404d move tests to plugin folder	11 vuotta sitten
html_rst_directive	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten
latex	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten
multi_part	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten
neighbors	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten
random_article	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten
related_posts	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten
sitemap	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten
summary	c694cb404d move tests to plugin folder	11 vuotta sitten
test_data	31ccbde072 teach plugins with dependencies to behave	11 vuotta sitten
.gitignore	31ccbde072 teach plugins with dependencies to behave	11 vuotta sitten
.travis.yml	31ccbde072 teach plugins with dependencies to behave	11 vuotta sitten
Contributing.rst	31ccbde072 teach plugins with dependencies to behave	11 vuotta sitten
LICENSE	66e83158ba Adding LICENSE file for Affero GPL	11 vuotta sitten
Readme.rst	9e70c17839 import plugins from core and restructure repo	11 vuotta sitten

		
				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