summaryrefslogtreecommitdiff
path: root/doc/plugins/mirrorlist.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/mirrorlist.mdwn')
-rw-r--r--doc/plugins/mirrorlist.mdwn8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/plugins/mirrorlist.mdwn b/doc/plugins/mirrorlist.mdwn
new file mode 100644
index 000000000..05d3dc910
--- /dev/null
+++ b/doc/plugins/mirrorlist.mdwn
@@ -0,0 +1,8 @@
+[[template id=plugin name=mirror included=1 author="[[Joey]]"]]
+[[tag type/special-purpose]]
+
+This plugin allows adding links a list of mirrors to each page in the
+wiki. For each mirror, a name and an url should be specified. Pages are
+assumed to exist in the same location under the specified url on each
+mirror. The [[ikiwiki.setup]] file has an example of configuring a list of
+mirrors.