Skip to content
Permalink
Browse files

minor fixes in the extending document

  • Loading branch information
ralsina committed Jul 15, 2015
1 parent d9559f9 commit 3d0401b7ce8729613b1855a5e221040fb13a02b9
Showing with 18 additions and 4 deletions.
  1. +8 −0 CHANGES.txt
  2. +10 −4 docs/extending.txt
@@ -1,3 +1,11 @@
New in master
=============

Bugfixes
--------

Minor improvements in the extending document.

New in v7.6.1
=============

@@ -242,6 +242,7 @@ a stub for a hypothetical system called "Templater":
template search mechanism."""
pass

You can see a real example in `the Jinja plugin <https://github.com/getnikola/nikola/blob/master/nikola/plugins/template/jinja.py>`__

Task Plugins
------------
@@ -361,7 +362,7 @@ PageCompiler Plugins
--------------------

These plugins implement markup languages, they take sources for posts or pages and
create HTML or other output files. A good example is the ``misaka`` plugin.
create HTML or other output files. A good example is `the misaka plugin. <https://github.com/getnikola/plugins/tree/master/v7/misaka>`__

They must provide:

@@ -381,12 +382,15 @@ metadata contained in the file.
RestExtension Plugins
---------------------

Implement directives for reStructuredText, see ``media.py`` for a simple example.
Implement directives for reStructuredText, see `media.py <https://github.com/getnikola/nikola/blob/master/nikola/plugins/compile/rest/media.py>`__ for a simple example.

MarkdownExtension Plugins
-------------------------

Implement Markdown extensions, see ``mdx_nikola.py`` for a simple example.
Implement Markdown extensions, see `mdx_nikola.py <https://github.com/getnikola/nikola/blob/master/nikola/plugins/compile/markdown/mdx_nikola.py>`__ for a simple example.

Note that python markdown extensions are often also available as separate packages. This is only meant to ship extensions
along with Nikola.

SignalHandler Plugins
---------------------
@@ -424,13 +428,15 @@ Currently Nikola emits the following signals:
'undeployed': # all files not deployed since they are either future posts/drafts
}

One example is the `deploy_hooks plugin. <https://github.com/getnikola/plugins/tree/master/v6/deploy_hooks>`__

ConfigPlugin Plugins
--------------------

Does nothing specific, can be used to modify the site object (and thus the config).

Put all the magic you want in ``set_site()``, and don’t forget to run the one
from ``super()``.
from ``super()``. Example plugin: `navstories <https://github.com/getnikola/plugins/tree/master/v7/navstories>`__

PostScanner Plugins
-------------------

0 comments on commit 3d0401b

Please sign in to comment.
You can’t perform that action at this time.