summaryrefslogtreecommitdiff
path: root/doc/ikiwiki
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ikiwiki')
-rw-r--r--doc/ikiwiki/directive/sidebar.mdwn8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/ikiwiki/directive/sidebar.mdwn b/doc/ikiwiki/directive/sidebar.mdwn
index 34f078672..401d7c786 100644
--- a/doc/ikiwiki/directive/sidebar.mdwn
+++ b/doc/ikiwiki/directive/sidebar.mdwn
@@ -1,8 +1,12 @@
The `sidebar` directive is supplied by the [[!iki plugins/sidebar desc=sidebar]] plugin.
-This directive specifies a custom sidebar to display on the page,
+This directive can specify a custom sidebar to display on the page,
overriding any sidebar that is displayed globally.
+If no custom sidebar content is specified, it forces the sidebar page to
+be used as the sidebar, even if the `global_sidebars` setting has been
+used to disable use of the sidebar page by default.
+
## examples
\[[!sidebar """
@@ -11,4 +15,6 @@ overriding any sidebar that is displayed globally.
\[[!calendar pages="posts/*"]]
"""]]
+ \[[!sidebar]]
+
[[!meta robots="noindex, follow"]]