doc/md/dev/Theming.md

   1 # Theming
   2
   3 ## Foreword
   4
   5 There are two ways of customizing how Shaarli looks:
   6
   7 1. by using a custom CSS to override Shaarli's CSS
   8 2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources
   9
  10 ## Custom CSS
  11
  12 Shaarli's appearance can be modified by adding CSS rules to:
  13
  14 - Shaarli < `v0.9.0`: `inc/user.css`
  15 - Shaarli >= `v0.9.0`: `data/user.css`
  16
  17 This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme.
  18
  19 **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli.
  20
  21 ## Themes
  22
  23 Installation:
  24
  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 - [xfnw/shaarli-default-dark](https://github.com/xfnw/shaarli-default-dark) - The default theme but nice and dark for your eyeballs
  49
  50 ### Shaarli forks
  51
  52 - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template
  53 - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance
  54
  55 ## Example installation: AlbinoMouse theme
  56
  57 With the following configuration:
  58
  59 - Apache 2 / PHP 5.6
  60 - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir`
  61 - `http` is the name of the Apache user
  62
  63 ```bash
  64 $ cd ~/public_html
  65
  66 # clone repositories
  67 $ git clone https://github.com/shaarli/Shaarli.git shaarli
  68 $ pushd shaarli/tpl
  69 $ git clone https://github.com/alexisju/albinomouse-template.git
  70 $ popd
  71
  72 # set access rights for Apache
  73 $ chgrp -R http shaarli
  74 $ chmod g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp
  75 ```
  76
  77 Get config written:
  78 - go to the freshly installed site
  79 - fill the install form
  80 - log in to Shaarli
  81
  82 Edit Shaarli's [configuration](Shaarli-configuration):
  83 ```bash
  84 # the file should be owned by Apache, thus not writeable => sudo
  85 $ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php
  86 ```