summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/plugins/brokenlinks.mdwn8
-rw-r--r--underlays/basewiki/directive/brokenlinks.mdwn4
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/plugins/brokenlinks.mdwn b/doc/plugins/brokenlinks.mdwn
index f2e80d51f..c039a9d17 100644
--- a/doc/plugins/brokenlinks.mdwn
+++ b/doc/plugins/brokenlinks.mdwn
@@ -1,5 +1,9 @@
[[!template id=plugin name=brokenlinks author="[[Joey]]"]]
[[!tag type/link type/meta]]
-This plugin implements the [[ikiwiki/directive/brokenlinks]] [[ikiwiki/directive]].
-The directive generates a list of broken links on pages in the wiki.
+This plugin provides a [[ikiwiki/directive/brokenlinks]] [[ikiwiki/directive]]
+that generates a list of broken links on pages in the wiki.
+
+If this plugin is turned on, here's a list of broken links on this wiki:
+
+[[!brokenlinks pages="* and !recentchanges"]]
diff --git a/underlays/basewiki/directive/brokenlinks.mdwn b/underlays/basewiki/directive/brokenlinks.mdwn
index 3ae8909dc..27a333196 100644
--- a/underlays/basewiki/directive/brokenlinks.mdwn
+++ b/underlays/basewiki/directive/brokenlinks.mdwn
@@ -7,6 +7,6 @@ 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:
+Example:
-[[!brokenlinks pages="* and !recentchanges"]]
+ \[[!brokenlinks pages="* and !recentchanges"]]