]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/rst.mdwn
* Add first draft at a Restructured Text (rst) plugin, by Sergio
[ikiwiki.git] / doc / plugins / rst.mdwn
1 This plugin lets ikwiki convert files with names ending in ".rst" to html.
2 It uses the [reStructuredText](http://docutils.sourceforge.net/rst.html)
3 markup syntax. You need to have the python-docutils module installed to use
4 it.
5
6 Note that this plugin does not interoperate very well with the rest of
7 ikiwiki. Limitations include:
8
9 * reStructuredText does not allow raw html to be inserted into
10   documents, but ikiwiki does so in many cases, including
11   [[WikiLinks|WikiLink]] and many
12   [[PreprocessorDirectives|PreprocessorDirective]].
13 * It's slow; it forks a copy of python for each page. While there is a
14   perl version of the reStructuredText processor, it is not being kept in
15   sync with the standard version, so is not used.
16
17 So while you may find this useful for importing old files into your wiki,
18 using this as your main markup language in ikiwiki isn't recommended at
19 this time.
20
21 This plugin is included in ikiwiki, but not enabled by default.
22 It was contributed by Sergio Talens-Oliag.
23
24 [[tag type/format]]