summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ikiwiki.setup6
-rw-r--r--doc/plugins/mirrorlist.mdwn8
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index d23010fd5..52b112a44 100644
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -111,4 +111,10 @@ use IkiWiki::Setup::Standard {
# For use with the openid plugin, to give an url to a page users
# can use to signup for an OpenID.
#openidsignup => "http://myopenid.com/",
+
+ # For use with the mirrorlist plugin, a list of mirrors.
+ #mirrorlist => {
+ # mirror1 => "http://hostname1",
+ # mirror2 => "http://hostname2/mirror",
+ #},
}
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.