]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/commitdiff
Document the getsource plugin
authorSimon McVittie <smcv@ http://smcv.pseudorandom.co.uk/>
Sat, 1 Aug 2009 11:31:34 +0000 (12:31 +0100)
committerSimon McVittie <smcv@ http://smcv.pseudorandom.co.uk/>
Sat, 1 Aug 2009 11:31:34 +0000 (12:31 +0100)
doc/plugins/getsource.mdwn [new file with mode: 0644]

diff --git a/doc/plugins/getsource.mdwn b/doc/plugins/getsource.mdwn
new file mode 100644 (file)
index 0000000..4fbf4be
--- /dev/null
@@ -0,0 +1,13 @@
+[[!template id=plugin name=getsource author="[[Will_Uther|Will]]"]]
+
+This plugin adds a `getsource` action to the IkiWiki CGI, and a "Source" link
+that uses it to display pages' source.
+
+Configuration for this plugin in the setup file:
+
+* `getsource_mimetype => "text/plain; charset=utf-8"`
+
+  Sets the MIME type used when page source is requested. The default is
+  usually appropriate, but you could set this to `application/octet-stream`
+  to encourage browsers to download the source to a file rather than showing
+  it in the browser.