caleb/pelican-plugins @ 9e70c17839c440ecca7729a9501c403fed47bbe6

Nav apraksta

2 Atzari

Deniz Turgut 9e70c17839 import plugins from core and restructure repo		11 gadi atpakaļ
assets	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
github_activity	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
global_license	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
goodreads_activity	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
gravatar	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
gzip_cache	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
html_rst_directive	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
latex	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
multi_part	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
neighbors	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
random_article	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
related_posts	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
sitemap	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
summary	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
tests	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
.gitignore	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
.travis.yml	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
Contributing.rst	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ
LICENSE	66e83158ba Adding LICENSE file for Affero GPL	11 gadi atpakaļ
Readme.rst	9e70c17839 import plugins from core and restructure repo	11 gadi atpakaļ

		
				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