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