caleb/pelican-plugins @ 223e1829054f5039320d3dbaf2a0ac5f310c5a30

Bez popisu

2 Větve

Duncan Lock 223e182905 Added initial stab at figures and image widths plugin.		před 11 roky
assets	31ccbde072 teach plugins with dependencies to behave	před 11 roky
better_figures	223e182905 Added initial stab at figures and image widths plugin.	před 11 roky
extract_toc	45b3094247 Adds Extract table of contents plugin	před 11 roky
github_activity	31ccbde072 teach plugins with dependencies to behave	před 11 roky
global_license	9e70c17839 import plugins from core and restructure repo	před 11 roky
goodreads_activity	31ccbde072 teach plugins with dependencies to behave	před 11 roky
gravatar	9e70c17839 import plugins from core and restructure repo	před 11 roky
gzip_cache	c694cb404d move tests to plugin folder	před 11 roky
html_rst_directive	9e70c17839 import plugins from core and restructure repo	před 11 roky
latex	9e70c17839 import plugins from core and restructure repo	před 11 roky
multi_part	9e70c17839 import plugins from core and restructure repo	před 11 roky
neighbors	9e70c17839 import plugins from core and restructure repo	před 11 roky
random_article	9e70c17839 import plugins from core and restructure repo	před 11 roky
related_posts	9e70c17839 import plugins from core and restructure repo	před 11 roky
sitemap	9e70c17839 import plugins from core and restructure repo	před 11 roky
summary	c694cb404d move tests to plugin folder	před 11 roky
test_data	31ccbde072 teach plugins with dependencies to behave	před 11 roky
w3c_validate	a4df915490 Minor improvements to W3C Validator plugin README	před 11 roky
.gitignore	31ccbde072 teach plugins with dependencies to behave	před 11 roky
.travis.yml	31ccbde072 teach plugins with dependencies to behave	před 11 roky
Contributing.rst	31ccbde072 teach plugins with dependencies to behave	před 11 roky
LICENSE	66e83158ba Adding LICENSE file for Affero GPL	před 11 roky
Readme.rst	9e70c17839 import plugins from core and restructure repo	před 11 roky

		
				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