From: Simon McVittie <smcv@ http://smcv.pseudorandom.co.uk/>
Date: Sat, 1 Aug 2009 11:31:34 +0000 (+0100)
Subject: Document the getsource plugin
X-Git-Tag: 3.15~18^2~1
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=3f39e69b13851d3bed8e1cae0525d6ad8ac768cf;p=ikiwiki.git

Document the getsource plugin
---

diff --git a/doc/plugins/getsource.mdwn b/doc/plugins/getsource.mdwn
new file mode 100644
index 000000000..4fbf4be98
--- /dev/null
+++ b/doc/plugins/getsource.mdwn
@@ -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.