path: root/ikiwiki/directive/orphans.mdwn
diff options
Diffstat (limited to 'ikiwiki/directive/orphans.mdwn')
1 files changed, 15 insertions, 0 deletions
diff --git a/ikiwiki/directive/orphans.mdwn b/ikiwiki/directive/orphans.mdwn
new file mode 100644
index 0000000..b03f5ac
--- /dev/null
+++ b/ikiwiki/directive/orphans.mdwn
@@ -0,0 +1,15 @@
+The `orphans` directive is supplied by the [[!iki plugins/orphans desc=orphans]] plugin.
+This directive generates a list of possibly orphaned pages -- pages that no
+other page links to. Example:
+ \[[!orphans pages="* and !blog/*"]]
+The optional parameter "pages" can be a [[ikiwiki/PageSpec]] specifying the
+pages to check for orphans, default is search them all.
+Note that it takes backlinks into account, but does not count inlining a
+page as linking to it, so will generally count many blog-type pages as
+[[!meta robots="noindex, follow"]]