wmd stuff

[ikiwiki.git] / doc / plugins / wmd.mdwn

diff --git a/doc/plugins/wmd.mdwn b/doc/plugins/wmd.mdwn
new file mode 100644 (file)
index 0000000..31a508c
--- /dev/null
+++ b/doc/plugins/wmd.mdwn
@@ -0,0 +1,15 @@
+[[!template id=plugin name=wmd author="[[Will]]"]]
+[[!tag type/chrome]]
+
+[WMD](http://wmd-editor.com/) is a What You See Is What You Mean editor for
+[[mdwn]]. This plugin makes WMD be used for editing pages in the wiki.
+
+To use the plugin, you will need to install WMD. Download the [WMD
+source](http://wmd-editor.com/downloads/wmd-1.0.1.zip).  In that zip file
+you'll find a few example html files, a readme and `wmd` directory.  Move the
+`wmd` directory into the ikiwiki `underlaydir` directory (ie
+`/usr/share/ikiwiki/`).  You should now have a `wmd/wmd.js` file as well as
+some other javascript files and an images directory in the same place.
+
+Note that the WMD plugin does **not** handle ikiwiki directives.  For this
+reason the normal `preview` button remains.