aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/theme.pm
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/theme.pm')
-rw-r--r--doc/plugins/theme.pm11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/plugins/theme.pm b/doc/plugins/theme.pm
new file mode 100644
index 000000000..7149cc163
--- /dev/null
+++ b/doc/plugins/theme.pm
@@ -0,0 +1,11 @@
+[[!template id=plugin name=theme author="[[Joey]]"]]
+[[!tag type/web]]
+
+The theme plugin allows easily applying a theme to your wiki, by
+configuring the `theme` setting in the setup file with the name of a theme
+to use. The themes you can choose from are all subdirectories, typically
+inside `/usr/share/ikiwiki/themes/`.
+
+A theme provides, via the underlay, an enhanced version of the regular
+[[style.css]]. This leaves [[local.css]] free for you to further
+customise. Themes can also provide header and background images.