summaryrefslogtreecommitdiff
path: root/doc/plugins/sidebar.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/sidebar.mdwn')
-rw-r--r--doc/plugins/sidebar.mdwn12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn
new file mode 100644
index 000000000..644d1e630
--- /dev/null
+++ b/doc/plugins/sidebar.mdwn
@@ -0,0 +1,12 @@
+If this plugin is enabled, then a sidebar is added to pages in the wiki.
+The content of the sidebar is simply the content of a page named
+"sidebar".
+
+Typically this will be a page in the root of the wiki, but it can also be a
+[[SubPage]]. In fact, this page, [[plugins/sidebar|plugins/sidebar]], will
+be treated as a sidebar for the [[plugins]] page, and of all of its
+SubPages, if the plugin is enabled.
+
+This plugin is included in ikiwiki, but is not enabled by default.
+
+[[tag type/chrome]]