]>
Commit | Line | Data |
---|---|---|
1 | ## Foreword | |
2 | ||
3 | There are two ways of customizing how Shaarli looks: | |
4 | ||
5 | 1. by using a custom CSS to override Shaarli's CSS | |
6 | 2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources | |
7 | ||
8 | ## Custom CSS | |
9 | ||
10 | Shaarli's appearance can be modified by adding CSS rules to: | |
11 | - Shaarli < `v0.9.0`: `inc/user.css` | |
12 | - Shaarli >= `v0.9.0`: `data/user.css` | |
13 | ||
14 | This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme. | |
15 | ||
16 | **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. | |
17 | ||
18 | See also [Download CSS styles from an OPML list](Download CSS styles from an OPML list) | |
19 | ||
20 | ## Themes | |
21 | ||
22 | _WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental._ | |
23 | ||
24 | Installation: | |
25 | - find a theme you'd like to install | |
26 | - copy or clone the theme folder under `tpl/<a_sweet_theme>` | |
27 | - enable the theme: | |
28 | - Shaarli < `v0.9.0`: edit `data/config.json.php` and set the value of `raintpl_tpl` to the new theme name: | |
29 | `"raintpl_tpl": "tpl\/my-template\/"` | |
30 | - Shaarli >= `v0.9.0`: select the theme through the _Tools_ page | |
31 | ||
32 | ## Community CSS & themes | |
33 | ||
34 | ### Custom CSS | |
35 | ||
36 | - [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli | |
37 | - [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes) | |
38 | ||
39 | ### Themes | |
40 | ||
41 | - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli | |
42 | - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli | |
43 | - [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme | |
44 | - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli | |
45 | - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli | |
46 | - [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone | |
47 | - [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 | |
48 | ||
49 | ### Shaarli forks | |
50 | ||
51 | - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template | |
52 | - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance | |
53 | ||
54 | ## Example installation: AlbinoMouse theme | |
55 | ||
56 | With the following configuration: | |
57 | - Apache 2 / PHP 5.6 | |
58 | - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir` | |
59 | - `http` is the name of the Apache user | |
60 | ||
61 | ```bash | |
62 | $ cd ~/public_html | |
63 | ||
64 | # clone repositories | |
65 | $ git clone https://github.com/shaarli/Shaarli.git shaarli | |
66 | $ pushd shaarli/tpl | |
67 | $ git clone https://github.com/alexisju/albinomouse-template.git | |
68 | $ popd | |
69 | ||
70 | # set access rights for Apache | |
71 | $ chgrp -R http shaarli | |
72 | $ chmod g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp | |
73 | ``` | |
74 | ||
75 | Get config written: | |
76 | - go to the freshly installed site | |
77 | - fill the install form | |
78 | - log in to Shaarli | |
79 | ||
80 | Edit Shaarli's [configuration|Shaarli configuration](configuration|Shaarli configuration): | |
81 | ```bash | |
82 | # the file should be owned by Apache, thus not writeable => sudo | |
83 | $ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php | |
84 | ``` |