caleb/pelican-plugins @ b998ad60e0ca0bb9fc97e85f73e65ecc22c42ce0

Geen omschrijving

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

		
				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