Merge remote branch 'smcv/ready/transient-autoindex'
[ikiwiki.git] / doc / plugins / wmd.mdwn
blob96c6e2e6c24c3c66144e979403b77346d819c663
1 [[!template id=plugin name=wmd author="[[Will]]"]]
2 [[!tag type/web]]
4 [WMD](http://wmd-editor.com/) is a What You See Is What You Mean editor for
5 [[mdwn]]. This plugin makes WMD be used for editing pages in the wiki.
7 To use the plugin, you will need to install WMD. Download the [WMD
8 source](http://wmd-editor.com/downloads/wmd-1.0.1.zip).  In that zip file
9 you'll find a few example html files, a readme and `wmd` directory.  Create
10 a 'wmd' subdirectory in the ikiwiki `underlaydir` directory (ie `sudo mkdir
11 /usr/share/ikiwiki/wmd`). Move the `wmd` directory into the directory you
12 made. You should now have a `wmd/wmd/wmd.js` file as well as some other
13 javascript files and an images directory in the same place.
15 Note that the WMD plugin does **not** handle ikiwiki directives.  For this
16 reason the normal `preview` button remains.