Added some hint for users

[ikiwiki.git] / doc / plugins / theme.mdwn

diff --git a/doc/plugins/theme.mdwn b/doc/plugins/theme.mdwn
index 7149cc163019a68e449a2ed0544ce9cfad68b419..5261df111f91b1462f36d3f9731479ddb01a7ae2 100644 (file)
--- a/doc/plugins/theme.mdwn
+++ b/doc/plugins/theme.mdwn
@@ -4,8 +4,15 @@
 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/`.
+inside `/usr/share/ikiwiki/themes/`. See [[themes]] for an overview
+of the themes included in ikiwiki and the [[theme market]] for third party 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.
+You can set the theme via the **theme** option in your config file (after
+enabling the plugin). Refresh the wiki (with `ikiwiki -setup <file>`, `--setup` won't work, they are not interchangable) after changing it to see the changes.
+
+Hints for theme builders
+------------------------
+
+ * Start from an existing [[CSS file|css]], see also the [[css market]] for examples
+ * You can override the [[templates]] files by dropping them in a `templates` subdirectory
+ * Try to stick with modifying the CSS however, maintaining custom templates is harder