From 992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Wed, 22 Jul 2015 05:02:10 +0200 Subject: Doc: sync from Wiki, generate HTML Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - Signed-off-by: VirtualTam --- doc/Theming.html | 138 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 doc/Theming.html (limited to 'doc/Theming.html') diff --git a/doc/Theming.html b/doc/Theming.html new file mode 100644 index 00000000..e814dadf --- /dev/null +++ b/doc/Theming.html @@ -0,0 +1,138 @@ + + + + + + + Shaarli - Theming + + + + + + + +

Theming

+

User CSS

+
    +
  • 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.
    • +
+

See also:

+ +

RainTPL template

+

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)
    • +
  • 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.php to have Shaarli use this template, e.g.

    +
    $GLOBALS['config'['RAINTPL_TPL'] = 'tpl/my-template/';]('RAINTPL_TPL']-=-'tpl/my-template/';.html)
    • +
+

Community themes & templates

+ +

Example installation: AlbinoMouse template

+

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
    • +
  • http is the name of the Apache user
    • +
+
$ cd ~/public_html
+
+# clone repositories
+$ git clone https://github.com/shaarli/Shaarli.git shaarli
+$ pushd shaarli/tpl
+$ git clone https://github.com/alexisju/albinomouse-template.git
+$ popd
+
+# set access rights for Apache
+$ chgrp -R http shaarli
+$ chmod g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp
+

Get config written:

+
    +
  • go to the freshly installed site
    • +
  • fill the install form
    • +
  • log in to Shaarli
    • +
+

Edit Shaarli's configuration|Shaarli configuration:

+
# the file should be owned by Apache, thus not writeable => sudo
+$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php
+ + -- cgit v1.2.3