summaryrefslogtreecommitdiff
path: root/doc/plugins/brokenlinks.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/brokenlinks.mdwn')
-rw-r--r--doc/plugins/brokenlinks.mdwn11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/plugins/brokenlinks.mdwn b/doc/plugins/brokenlinks.mdwn
new file mode 100644
index 000000000..05efe2806
--- /dev/null
+++ b/doc/plugins/brokenlinks.mdwn
@@ -0,0 +1,11 @@
+This plugin generates a list of broken links on pages in the wiki. This is
+a useful way to find pages that still need to be written, or links that
+are written wrong.
+
+The optional parameter "pages" can be a [[GlobList]] specifying the pages
+to search for broken links, default is search them all.
+
+This plugin is included in ikiwiki, but is not enabled by default.
+If it is turned on, here's a list of broken links on this wiki:
+
+[[brokenlinks ]]