diff --git a/docs/plugins.rst b/docs/plugins.rst
index c275c57c..83ef264c 100644
--- a/docs/plugins.rst
+++ b/docs/plugins.rst
@@ -59,7 +59,7 @@ Signal Arguments Description
============================= ============================ ===========================================================================
initialized pelican object
finalized pelican object invoked after all the generators are executed and just before pelican exits
- usefull for custom post processing actions, such as:
+ usefull for custom post processing actions, such as:
- minifying js/css assets.
- notify/ping search engines with an updated sitemap.
article_generate_context article_generator, metadata
@@ -75,23 +75,23 @@ pages_generator_init pages_generator invoked in the P
The list is currently small, don't hesitate to add signals and make a pull
request if you need them!
-.. note::
-
- The signal ``content_object_init`` can send different type of object as
+.. note::
+
+ The signal ``content_object_init`` can send different type of object as
argument. If you want to register only one type of object then you will
need to specify the sender when you are connecting to the signal.
-
+
::
-
+
from pelican import signals
from pelican import contents
-
+
def test(sender, instance):
print "%s : %s content initialized !!" % (sender, instance)
-
+
def register():
signals.content_object_init.connect(test, sender=contents.Article)
-
+
List of plugins
@@ -99,6 +99,7 @@ List of plugins
The following plugins are currently included with Pelican under ``pelican.plugins``:
+* `Asset management`_
* `GitHub activity`_
* `Global license`_
* `Gravatar`_
@@ -114,6 +115,76 @@ Ideas for plugins that haven't been written yet:
Plugin descriptions
===================
+Asset management
+----------------
+
+This plugin allows you to use the `webassets`_ module to manage assets such as
+CSS and JS files. The module must first be installed::
+
+ pip install webassets
+
+The `webassets` module allows you to perform a number of useful asset management
+functions, including:
+
+* CSS minifier (`cssmin`, `yuicompressor`, ...)
+* CSS compiler (`less`, `sass`, ...)
+* JS minifier (`uglifyjs`, `yuicompressor`, `closure`, ...)
+
+Others filters include gzip compression, integration of images in CSS via data
+URIs, and more. `webassets` can also append a version identifier to your asset
+URL to convince browsers to download new versions of your assets when you use
+far-future expires headers. Please refer to the `webassets documentation`_ for
+more information.
+
+When using with Pelican, `webassets` is configured to process assets in the
+``OUTPUT_PATH/theme`` directory. You can use `webassets` in your templates by
+including one or more template tags. For example...
+
+.. code-block:: jinja
+
+ {% assets filters="cssmin", output="css/style.min.css", "css/inuit.css", "css/pygment-monokai.css", "css/main.css" %}
+
+ {% endassets %}
+
+... will produce a minified css file with a version identifier:
+
+.. code-block:: html
+
+
+
+These filters can be combined. Here is an example that uses the SASS compiler
+and minifies the output:
+
+.. code-block:: jinja
+
+ {% assets filters="sass,cssmin", output="css/style.min.css", "css/style.scss" %}
+
+ {% endassets %}
+
+Another example for Javascript:
+
+.. code-block:: jinja
+
+ {% assets filters="uglifyjs,gzip", output="js/packed.js", "js/jquery.js", "js/base.js", "js/widgets.js" %}
+
+ {% endassets %}
+
+The above will produce a minified and gzipped JS file:
+
+.. code-block:: html
+
+
+
+Pelican's debug mode is propagated to `webassets` to disable asset packaging
+and instead work with the uncompressed assets. However, this also means that
+the LESS and SASS files are not compiled. This should be fixed in a future
+version of `webassets` (cf. the related `bug report
+`_).
+
+.. _webassets: https://github.com/miracle2k/webassets
+.. _webassets documentation: http://webassets.readthedocs.org/en/latest/builtin_filters.html
+
+
GitHub activity
---------------
diff --git a/docs/settings.rst b/docs/settings.rst
index ca2c7b0f..c4ac3584 100644
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@ -52,7 +52,7 @@ Setting name (default value) What doe
the datetime.datetime constructor.
`DELETE_OUTPUT_DIRECTORY` (``False``) Delete the content of the output directory before
generating new files.
-`FILES_TO_COPY` (``()``) A list of files to copy from the source (inside the content
+`FILES_TO_COPY` (``()``) A list of files to copy from the source (inside the content
directory) to the destination (inside the output directory).
For example: ``(('extra/robots.txt', 'robots.txt'),)``.
`JINJA_EXTENSIONS` (``[]``) A list of any Jinja2 extensions you want to use.
@@ -426,7 +426,6 @@ Setting name (default value) What does it do?
value is `static`, but if your theme has
other static paths, you can put them here.
`CSS_FILE` (``'main.css'``) Specify the CSS file you want to load.
-`WEBASSETS` (``False``) Asset management with `webassets` (see below)
================================================ =====================================================
@@ -487,75 +486,6 @@ adding the following to your configuration::
CSS_FILE = "wide.css"
-Asset management
-----------------
-
-The `WEBASSETS` setting allows you to use the `webassets`_ module to manage
-assets such as CSS and JS files. The module must first be installed::
-
- pip install webassets
-
-The `webassets` module allows you to perform a number of useful asset management
-functions, including:
-
-* CSS minifier (`cssmin`, `yuicompressor`, ...)
-* CSS compiler (`less`, `sass`, ...)
-* JS minifier (`uglifyjs`, `yuicompressor`, `closure`, ...)
-
-Others filters include gzip compression, integration of images in CSS via data
-URIs, and more. `webassets` can also append a version identifier to your asset
-URL to convince browsers to download new versions of your assets when you use
-far-future expires headers. Please refer to the `webassets documentation`_ for
-more information.
-
-When using with Pelican, `webassets` is configured to process assets in the
-``OUTPUT_PATH/theme`` directory. You can use `webassets` in your templates by
-including one or more template tags. For example...
-
-.. code-block:: jinja
-
- {% assets filters="cssmin", output="css/style.min.css", "css/inuit.css", "css/pygment-monokai.css", "css/main.css" %}
-
- {% endassets %}
-
-... will produce a minified css file with a version identifier:
-
-.. code-block:: html
-
-
-
-These filters can be combined. Here is an example that uses the SASS compiler
-and minifies the output:
-
-.. code-block:: jinja
-
- {% assets filters="sass,cssmin", output="css/style.min.css", "css/style.scss" %}
-
- {% endassets %}
-
-Another example for Javascript:
-
-.. code-block:: jinja
-
- {% assets filters="uglifyjs,gzip", output="js/packed.js", "js/jquery.js", "js/base.js", "js/widgets.js" %}
-
- {% endassets %}
-
-The above will produce a minified and gzipped JS file:
-
-.. code-block:: html
-
-
-
-Pelican's debug mode is propagated to `webassets` to disable asset packaging
-and instead work with the uncompressed assets. However, this also means that
-the LESS and SASS files are not compiled. This should be fixed in a future
-version of `webassets` (cf. the related `bug report
-`_).
-
-.. _webassets: https://github.com/miracle2k/webassets
-.. _webassets documentation: http://webassets.readthedocs.org/en/latest/builtin_filters.html
-
Example settings
================