53ed6d7d1e
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation
3.4 KiB
3.4 KiB
Foreword
There are two ways of customizing how Shaarli looks:
- by using a custom CSS to override Shaarli's CSS
- by using a full theme that provides its own RainTPL templates, CSS and Javascript resources
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
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 a theme you'd like to install
- copy or clone the theme folder under
tpl/<a_sweet_theme> - enable the theme:
- Shaarli <
v0.9.0: editdata/config.json.phpand set the value ofraintpl_tplto the new theme name:"raintpl_tpl": "tpl\/my-template\/" - Shaarli >=
v0.9.0: select the theme through the Tools page
- Shaarli <
Community CSS & themes
Custom CSS
- mrjovanovic/serious-theme-shaarli - A serious theme for Shaarli
- shaarli/shaarli-themes
Themes
- AkibaTech/Shaarli Superhero Theme - A template/theme for Shaarli
- alexisju/albinomouse-template - A full template for Shaarli
- ArthurHoaro/shaarli-launch - Customizable Shaarli theme
- dhoko/ShaarliTemplate - A template/theme for Shaarli
- kalvn/shaarli-blocks - A template/theme for Shaarli
- kalvn/Shaarli-Material - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone
- ManufacturaInd/shaarli-2004licious-theme - A template/theme as a humble homage to the early looks of the del.icio.us site
Shaarli forks
- misterair/Limonade - A fork of (legacy) Shaarli with a new template
- vivienhaese/shaarlitheme - A Shaarli fork meant to be run in an openshift instance
Example installation: AlbinoMouse theme
With the following configuration:
- Apache 2 / PHP 5.6
- user sites are enabled, e.g.
/home/user/public_html/somediris served ashttp://localhost/~user/somedir httpis 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:
# the file should be owned by Apache, thus not writeable => sudo
$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php