skins: describe the skins in the documentation

ether · Aug 26, 2018 · 6620014 · 6620014
1 parent 9c990ab
commit 6620014
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 12 deletions.
diff --git a/doc/custom_static.md b/doc/custom_static.md
diff --git a/doc/index.md b/doc/index.md
@@ -1,7 +1,7 @@
 @include documentation
 @include stats
 @include localization
-@include custom_static
+@include skins
 @include api/api
 @include plugins
 @include database
diff --git a/doc/skins.md b/doc/skins.md
@@ -0,0 +1,19 @@
+# Skins
+You can customize Etherpad appearance using skins.
+A skin is a directory located under `static/skins/<skin_name>`, with the following contents:
+
+* `index.js`: javascript that will be run in `/`
+* `index.css`: stylesheet affecting `/`
+* `pad.js`: javascript that will be run in `/p/:padid`
+* `pad.css`: stylesheet affecting `/p/:padid`
+* `timeslider.js`: javascript that will be run in `/p/:padid/timeslider`
+* `timeslider.css`: stylesheet affecting `/p/:padid/timeslider`
+* `favicon.ico`: overrides the default favicon
+* `robots.txt`: overrides the default `robots.txt`
+
+You can choose a skin changing the parameter `skinName` in `settings.json`.
+
+Since Etherpad **1.8**, two skins are included:
+
+* `no-skin`: an empty skin, leaving the default Etherpad appearance unchanged, that you can use as a guidance to develop your own.
+* `colibris`: a new, experimental skin, that will become the default in Etherpad 2.0.