diff options
Diffstat (limited to 'doc/Theming.md')
-rw-r--r-- | doc/Theming.md | 54 |
1 files changed, 33 insertions, 21 deletions
diff --git a/doc/Theming.md b/doc/Theming.md index a21899c2..23877e5d 100644 --- a/doc/Theming.md +++ b/doc/Theming.md | |||
@@ -1,39 +1,51 @@ | |||
1 | #Theming | 1 | #Theming |
2 | ## User CSS | 2 | ## Foreword |
3 | There are two ways of customizing how Shaarli looks: | ||
3 | 4 | ||
4 | - Shaarli's apparence can be modified by editing CSS rules in `inc/user.css`. This file allows to override rules defined in the main `inc/shaarli.css` (only add changed rules), or define a whole new theme. | 5 | 1. by using a custom CSS to override Shaarli's CSS |
5 | - Do not edit `inc/shaarli.css`! Your changes would be overriden when updating Shaarli. | 6 | 2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources |
6 | - Some themes are available at https://github.com/shaarli/shaarli-themes. | ||
7 | 7 | ||
8 | See also: | 8 | ## Custom CSS |
9 | - [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html) | 9 | Shaarli's appearance can be modified by adding CSS rules to: |
10 | - Shaarli < `v0.9.0`: `inc/user.css` | ||
11 | - Shaarli >= `v0.9.0`: `data/user.css` | ||
10 | 12 | ||
11 | ## RainTPL template | 13 | This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme. |
12 | 14 | ||
15 | **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. | ||
16 | |||
17 | See also [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html) | ||
18 | |||
19 | ## Themes | ||
13 | _WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental._ | 20 | _WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental._ |
14 | 21 | ||
15 | - Find the template you'd like to install (see the list of [available templates|Theming#community-themes--templates](available-templates|Theming#community-themes--templates.html)) | 22 | Installation: |
16 | - Find it's git clone URL or download the zip archive for the template. | 23 | - find a theme you'd like to install |
17 | - In your Shaarli `tpl/` directory, run `git clone https://url/of/my-template/` or unpack the zip archive. | 24 | - copy or clone the theme folder under `tpl/<a_sweet_theme>` |
18 | - There should now be a `my-template/` directory under the `tpl/` dir, containing directly all the template files. | 25 | - enable the theme: |
19 | - Edit `data/config.json.php` to have Shaarli use this template, in `"resource"` e.g. | 26 | - Shaarli < `v0.9.0`: edit `data/config.json.php` and set the value of `raintpl_tpl` to the new theme name: |
20 | ```json | 27 | `"raintpl_tpl": "tpl\/my-template\/"` |
21 | "raintpl_tpl": "tpl\/my-template\/", | 28 | - Shaarli >= `v0.9.0`: select the theme through the _Tools_ page |
22 | ``` | ||
23 | 29 | ||
24 | ## Community themes & templates | 30 | ## Community CSS & themes |
31 | ### Custom CSS | ||
32 | - [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli[](.html) | ||
33 | - [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes)[](.html) | ||
34 | |||
35 | ### Themes | ||
25 | - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli[](.html) | 36 | - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli[](.html) |
26 | - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli[](.html) | 37 | - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli[](.html) |
27 | - [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme.[](.html) | 38 | - [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme[](.html) |
28 | - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli[](.html) | 39 | - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli[](.html) |
29 | - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli[](.html) | 40 | - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli[](.html) |
30 | - [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone.[](.html) | 41 | - [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone[](.html) |
31 | - [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site.[](.html) | 42 | - [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site[](.html) |
43 | |||
44 | ### Shaarli forks | ||
32 | - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template[](.html) | 45 | - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template[](.html) |
33 | - [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for SHaarli.[](.html) | ||
34 | - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance[](.html) | 46 | - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance[](.html) |
35 | 47 | ||
36 | ### Example installation: AlbinoMouse template | 48 | ## Example installation: AlbinoMouse theme |
37 | With the following configuration: | 49 | With the following configuration: |
38 | - Apache 2 / PHP 5.6 | 50 | - Apache 2 / PHP 5.6 |
39 | - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir` | 51 | - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir` |