add underlay files for listdirectives

[ikiwiki.git] / underlays / basewiki / directive / brokenlinks.mdwn

diff --git a/underlays/basewiki/directive/brokenlinks.mdwn b/underlays/basewiki/directive/brokenlinks.mdwn
new file mode 100644 (file)
index 0000000..3ae8909
--- /dev/null
+++ b/underlays/basewiki/directive/brokenlinks.mdwn
@@ -0,0 +1,12 @@
+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.
+
+If this plugin is turned on, here's a list of broken links on this wiki:
+
+[[!brokenlinks pages="* and !recentchanges"]]