[ikiwiki] / doc / plugins / rst.mdwn

[[template id=plugin name=rst author="martin f. krafft"]]
[[tag type/format]]

This plugin lets ikwiki convert files with names ending in ".rst" to html.
It uses the [reStructuredText](http://docutils.sourceforge.net/rst.html)
markup syntax. You need to have [[cpan RPC::XML]], python and the
python-docutils module installed to use it.

Note that this plugin does not interoperate very well with the rest of
ikiwiki. Limitations include:

* There are issues with inserting raw html into documents, as ikiwiki 
  does with [[WikiLinks|ikiwiki/WikiLink]] and many 
  [[PreprocessorDirectives|ikiwiki/PreprocessorDirective]].

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
this time.
Commit	Line	Data
65dca9f8	1	[[template id=plugin name=rst author="martin f. krafft"]]
9d7375c3	2	[[tag type/format]]
9d7375c3	3
63edea27	4	This plugin lets ikwiki convert files with names ending in ".rst" to html.
63edea27	5	It uses the [reStructuredText](http://docutils.sourceforge.net/rst.html)
65dca9f8	6	markup syntax. You need to have [[cpan RPC::XML]], python and the
65dca9f8	7	python-docutils module installed to use it.
63edea27	8
6887ef16	9	Note that this plugin does not interoperate very well with the rest of
	10	ikiwiki. Limitations include:
	11
	12	* There are issues with inserting raw html into documents, as ikiwiki
fa90bdf4	13	does with [[WikiLinks\|ikiwiki/WikiLink]] and many
79600311	14	[[PreprocessorDirectives\|ikiwiki/PreprocessorDirective]].
63edea27	15
	16	So while you may find this useful for importing old files into your wiki,
	17	using this as your main markup language in ikiwiki isn't recommended at
	18	this time.