X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2FTheming.md;h=23877e5d9c57856ee30fb9108f778696fcc8936a;hb=b230bf207df576fa2ad165702184edf21f674ce7;hp=a21899c27ec0379e6ee2cc8ef2f442d736a96763;hpb=f501caed215bd12caced5106f9226638b2b15fb4;p=github%2Fshaarli%2FShaarli.git 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 @@ #Theming -## User CSS +## Foreword +There are two ways of customizing how Shaarli looks: -- 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. -- Do not edit `inc/shaarli.css`! Your changes would be overriden when updating Shaarli. -- Some themes are available at https://github.com/shaarli/shaarli-themes. +1. by using a custom CSS to override Shaarli's CSS +2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources -See also: -- [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html) +## Custom CSS +Shaarli's appearance can be modified by adding CSS rules to: +- Shaarli < `v0.9.0`: `inc/user.css` +- Shaarli >= `v0.9.0`: `data/user.css` -## RainTPL template +This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme. +**Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. + +See also [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html) + +## Themes _WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental._ -- 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)) -- Find it's git clone URL or download the zip archive for the template. -- In your Shaarli `tpl/` directory, run `git clone https://url/of/my-template/` or unpack the zip archive. - - There should now be a `my-template/` directory under the `tpl/` dir, containing directly all the template files. -- Edit `data/config.json.php` to have Shaarli use this template, in `"resource"` e.g. -```json -"raintpl_tpl": "tpl\/my-template\/", -``` +Installation: +- find a theme you'd like to install +- copy or clone the theme folder under `tpl/` +- enable the theme: + - Shaarli < `v0.9.0`: edit `data/config.json.php` and set the value of `raintpl_tpl` to the new theme name: + `"raintpl_tpl": "tpl\/my-template\/"` + - Shaarli >= `v0.9.0`: select the theme through the _Tools_ page -## Community themes & templates +## Community CSS & themes +### Custom CSS +- [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli[](.html) +- [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes)[](.html) + +### Themes - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli[](.html) - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli[](.html) -- [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme.[](.html) +- [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme[](.html) - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli[](.html) - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli[](.html) -- [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) -- [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) +- [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) +- [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) + +### Shaarli forks - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template[](.html) -- [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for SHaarli.[](.html) - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance[](.html) -### Example installation: AlbinoMouse template +## Example installation: AlbinoMouse theme With the following configuration: - Apache 2 / PHP 5.6 - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir`