From 6620014b775f570d6778fce8de119fa02b0f2c40 Mon Sep 17 00:00:00 2001 From: muxator Date: Sun, 26 Aug 2018 21:12:13 +0200 Subject: [PATCH] skins: describe the skins in the documentation --- doc/custom_static.md | 11 ----------- doc/index.md | 2 +- doc/skins.md | 19 +++++++++++++++++++ 3 files changed, 20 insertions(+), 12 deletions(-) delete mode 100644 doc/custom_static.md create mode 100644 doc/skins.md diff --git a/doc/custom_static.md b/doc/custom_static.md deleted file mode 100644 index 7bb290094..000000000 --- a/doc/custom_static.md +++ /dev/null @@ -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`. \ No newline at end of file diff --git a/doc/index.md b/doc/index.md index 09553f686..5b93bac68 100644 --- 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 new file mode 100644 index 000000000..1431dac8d --- /dev/null +++ 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/`, 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.