allow sidebar directive to enable use of sidebar page

[ikiwiki.git] / doc / ikiwiki / directive / sidebar.mdwn

diff --git a/doc/ikiwiki/directive/sidebar.mdwn b/doc/ikiwiki/directive/sidebar.mdwn
index 34f078672e4a60b5cf0e778b3aa24f2819206fc2..401d7c786c7ceb8e5bfcce270cb0e131ecab944c 100644 (file)
--- 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"]]