From b230bf207df576fa2ad165702184edf21f674ce7 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sun, 7 May 2017 18:44:05 +0200 Subject: Bump version to v0.9.0 Signed-off-by: ArthurHoaro --- doc/Theming.html | 58 ++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 37 insertions(+), 21 deletions(-) (limited to 'doc/Theming.html') diff --git a/doc/Theming.html b/doc/Theming.html index 7cbf7aef..6b5dac35 100644 --- a/doc/Theming.html +++ b/doc/Theming.html @@ -69,6 +69,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf
  • Browsing and Searching
  • Firefox share
  • RSS feeds
  • +
  • REST API
  • How To

    Theming

    -

    User CSS

    +

    Foreword

    +

    There are two ways of customizing how Shaarli looks:

    +
      +
    1. by using a custom CSS to override Shaarli's CSS
    2. +
    3. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources
    4. +
    +

    Custom CSS

    +

    Shaarli's appearance can be modified by adding CSS rules to:

      -
    • 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.
    • +
    • Shaarli < v0.9.0: inc/user.css
    • +
    • Shaarli >= v0.9.0: data/user.css
    -

    See also:

    - -

    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

    +

    Themes

    WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental.

    +

    Installation:

      -
    • Find the template you'd like to install (see the list of available templates|Theming#community-themes--templates)
    • -
    • 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. +
    • find a theme you'd like to install
    • +
    • copy or clone the theme folder under tpl/<a_sweet_theme>
    • +
    • enable the theme:
        -
      • There should now be a my-template/ directory under the tpl/ dir, containing directly all the template files.
      • +
      • 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
    • -
    • Edit data/config.json.php to have Shaarli use this template, in "resource" e.g.

      -
      "raintpl_tpl": "tpl\/my-template\/",
    -

    Community themes & templates

    +

    Community CSS & themes

    +

    Custom CSS

    + +

    Themes

    +

    Shaarli forks

    + -

    Example installation: AlbinoMouse template

    +

    Example installation: AlbinoMouse theme

    With the following configuration:

    • Apache 2 / PHP 5.6
    • -- cgit v1.2.3