Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: getnikola/nikola-site
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 41be2f6a8745
Choose a base ref
...
head repository: getnikola/nikola-site
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 659ae036b394
Choose a head ref
  • 2 commits
  • 5 files changed
  • 1 contributor

Commits on Jul 24, 2015

  1. Update extending document

    Signed-off-by: Chris Warrick <kwpolska@gmail.com>
    Kwpolska committed Jul 24, 2015

    Unverified

    This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
    Copy the full SHA
    547545d View commit details
  2. Remove unused .meta files

    Signed-off-by: Chris Warrick <kwpolska@gmail.com>
    Kwpolska committed Jul 24, 2015
    Copy the full SHA
    659ae03 View commit details
Showing with 10 additions and 20 deletions.
  1. +0 −4 stories/extending.meta
  2. +10 −4 stories/extending.txt
  3. +0 −4 stories/internals.meta
  4. +0 −4 stories/quickref.meta
  5. +0 −4 stories/quickstart.meta
4 changes: 0 additions & 4 deletions stories/extending.meta

This file was deleted.

14 changes: 10 additions & 4 deletions stories/extending.txt
Original file line number Diff line number Diff line change
@@ -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
-------------------
4 changes: 0 additions & 4 deletions stories/internals.meta

This file was deleted.

4 changes: 0 additions & 4 deletions stories/quickref.meta

This file was deleted.

4 changes: 0 additions & 4 deletions stories/quickstart.meta

This file was deleted.