diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plugins/rst.mdwn | 13 | ||||
| -rw-r--r-- | doc/todo/rst_plugin_python_rewrite.mdwn | 5 |
2 files changed, 8 insertions, 10 deletions
diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn index ff7f8991f..7d542646c 100644 --- a/doc/plugins/rst.mdwn +++ b/doc/plugins/rst.mdwn @@ -7,16 +7,9 @@ It uses the [reStructuredText](http://docutils.sourceforge.net/rst.html) markup syntax. You need to have the python-docutils module installed to use it. -Note that this plugin does not interoperate very well with the rest of -ikiwiki. Limitations include: - -* reStructuredText does not allow raw html to be inserted into - documents, but ikiwiki does so in many cases, including - [[WikiLinks|WikiLink]] and many - [[PreprocessorDirectives|PreprocessorDirective]]. -* It's slow; it forks a copy of python for each page. While there is a - perl version of the reStructuredText processor, it is not being kept in - sync with the standard version, so is not used. +Note that this plugin is rather slow; it forks a copy of python for each +page. While there is a perl version of the reStructuredText processor, it +is not being kept in sync with the standard version, so is not used. So while you may find this useful for importing old files into your wiki, using this as your main markup language in ikiwiki isn't recommended at diff --git a/doc/todo/rst_plugin_python_rewrite.mdwn b/doc/todo/rst_plugin_python_rewrite.mdwn new file mode 100644 index 000000000..7f7bdb525 --- /dev/null +++ b/doc/todo/rst_plugin_python_rewrite.mdwn @@ -0,0 +1,5 @@ +The [[plugin/rst]] plugin is slow because it forks python for each page +rendered. Now that ikiwiki supports plugins written in +[[other_languages|plugin/write/external]], it would be excellent if someone +could rewrite the rst plugin as a pure python external plugin. It would +then run nice and quick. |