skins: describe the skins in the documentation
parent
9c990ab08a
commit
6620014b77
|
@ -1,11 +0,0 @@
|
||||||
# Custom static files
|
|
||||||
Etherpad allows you to include your own static files in the browser, by modifying the files in `static/custom`.
|
|
||||||
|
|
||||||
* `index.js` Javascript that'll be run in `/`
|
|
||||||
* `index.css` Stylesheet affecting `/`
|
|
||||||
* `pad.js` Javascript that'll be run in `/p/:padid`
|
|
||||||
* `pad.css` Stylesheet affecting `/p/:padid`
|
|
||||||
* `timeslider.js` Javascript that'll 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`.
|
|
|
@ -1,7 +1,7 @@
|
||||||
@include documentation
|
@include documentation
|
||||||
@include stats
|
@include stats
|
||||||
@include localization
|
@include localization
|
||||||
@include custom_static
|
@include skins
|
||||||
@include api/api
|
@include api/api
|
||||||
@include plugins
|
@include plugins
|
||||||
@include database
|
@include database
|
||||||
|
|
|
@ -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.
|
Loading…
Reference in New Issue