summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ikiwiki.setup3
-rw-r--r--doc/plugins.mdwn2
-rw-r--r--doc/plugins/sidebar.mdwn12
-rw-r--r--doc/plugins/type/chrome.mdwn1
4 files changed, 16 insertions, 2 deletions
diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index e14991299..a0ce5a468 100644
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -80,7 +80,8 @@ use IkiWiki::Setup::Standard {
# To add plugins, list them here.
#add_plugins => [qw{meta tag pagecount brokenlinks search smiley
- # wikitext camelcase pagestats htmltidy fortune}],
+ # wikitext camelcase pagestats htmltidy fortune
+ # sidebar}],
# If you want to disable any of the default plugins, list them here.
#disable_plugins => [qw{inline htmlscrubber}],
}
diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn
index 1c04d09f5..efcf65a7d 100644
--- a/doc/plugins.mdwn
+++ b/doc/plugins.mdwn
@@ -1,7 +1,7 @@
Most of ikiwiki's [[features]] are implemented as plugins. Beyond the
[[type/core]] features, there are plugins to [[type/format]] text,
use [[type/tags]], show [[type/meta]] information, do other [[type/useful]]
-stuff, or just have [[type/fun]].
+stuff, add [[type/chrome]] to the wiki, or just have [[type/fun]].
There's documentation if you want to [[write]] your own plugins, or you can
install and use plugins contributed by others.
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]]
diff --git a/doc/plugins/type/chrome.mdwn b/doc/plugins/type/chrome.mdwn
new file mode 100644
index 000000000..d3f0eb3d3
--- /dev/null
+++ b/doc/plugins/type/chrome.mdwn
@@ -0,0 +1 @@
+These plugins affect the look and feel of the wiki.