aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki/directive/brokenlinks.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ikiwiki/directive/brokenlinks.mdwn')
-rw-r--r--doc/ikiwiki/directive/brokenlinks.mdwn14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/brokenlinks.mdwn b/doc/ikiwiki/directive/brokenlinks.mdwn
new file mode 100644
index 000000000..2cde5b64a
--- /dev/null
+++ b/doc/ikiwiki/directive/brokenlinks.mdwn
@@ -0,0 +1,14 @@
+The `brokenlinks` directive is supplied by the [[!iki plugins/brokenlinks]] plugin.
+
+This directive 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 [[ikiwiki/PageSpec]] specifying the
+pages to search for broken links, default is search them all.
+
+Example:
+
+ \[[!brokenlinks pages="* and !recentchanges"]]
+
+[[!meta robots="noindex, follow"]]