**General rewording, proof-reading, deduplication, shortening, reordering, simplification, cleanup/formatting/standardization**
- standardize page names, rework documentation structure, update TOC
- use same example paths everywhere
- level 1 titles on all pages
- fix broken links
- .md suffix on all page links (works both from readthedocs and github repository views)
**Server:**
A full and concise installation guide with examples is a frequent request. The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end. Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration.
- server: move most server-related info to server-configuration.md, cleanup/shorten
- server: update list of php dependencies/libraries, link to composer.json
- server: installation: support 3 install methods (from release zip, from sources, using docker)
- server: installation: use rsync instead of mv as mv results will change depending of taget directory already existing or not
- server: add example/basic usage of certbot
- server, upgrade, installation: update file permissions setup, use sudo for upgrade operations in webserver document root
- server: apache: add comments to configuration, fix and factorize file permissions setup, set cache-control header, deny access to dotfiles, add missing apache config steps, add http->https redirect example
- server: nginx: refactor nginx configuration, add comments, DO log access to denied/protected files
- server: add links to MDN for x-forwarded-* http headers explanation, cleanup/clarify robots.txt and crawlers section
- server: bump file upload size limit to 100MB we have reports of bookmark exports weighing +40MB - i have a 13MB one here
- server: simplify phpinfo documentation
- server: move backup and restore information to dedicated page
- docker: move all docker docs to Docker.md, simplify/ docker setup, add docker-compose.yml example, replace docker-101 with docker cheatsheet
- troubleshooting: move all troubleshooting documentation to troubleshooting.md
**Usage:**
- index: add getting started section on index page
- features/usage: move all usage-related documentation to usage.md, add links from the main feature list to corresponding usage docs, clarify/reword features list
- shaarli configuration: add note about configuring from web interface
**Removed:**
- remove obsolete/orphan images
- remove obsolete shaarchiver example
- remove outdated "decode datastore content" snippet
**Development:**
- development: move development-related docs (static analysis, CI, unit tests, 3rd party libs, link structure/directory, guidelines, security....) to dev/ directory
- development: Merge several pages to development.md
- **Breaking change?:** remove mentions of 'stable' branch, switch to new branch/release model (master=latest commit, release=latest tag)
- **Breaking change?:** refer to base sharing unit as "Shaare" everywhere (TODO: reflect changes in the code?) doc: update featues list/link to usage.md for details
- development: directory structure: add note about required file permissions
- .travis-ci.yml: add comments
- .htaccess: add comment
2020-05-16 12:54:51 +02:00
# Theming
2017-05-07 18:44:05 +02:00
## Foreword
2017-01-26 18:52:54 +01:00
2017-05-07 18:44:05 +02:00
There are two ways of customizing how Shaarli looks:
2015-07-22 05:02:10 +02:00
2017-05-07 18:44:05 +02:00
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
2015-07-22 05:02:10 +02:00
2017-05-07 18:44:05 +02:00
## Custom CSS
2017-01-26 18:52:54 +01:00
2017-05-07 18:44:05 +02:00
Shaarli's appearance can be modified by adding CSS rules to:
2017-08-05 11:56:24 +02:00
2017-05-07 18:44:05 +02:00
- Shaarli < `v0.9.0` : `inc/user.css`
- Shaarli >= `v0.9.0` : `data/user.css`
2015-07-22 05:02:10 +02:00
2017-05-07 18:44:05 +02:00
This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme.
2015-07-22 05:02:10 +02:00
2017-05-07 18:44:05 +02:00
**Note**: Do not edit `tpl/default/css/shaarli.css` ! Your changes would be overridden when updating Shaarli.
## Themes
2017-01-26 18:52:54 +01:00
2017-05-07 18:44:05 +02:00
Installation:
2017-08-05 11:56:24 +02:00
2017-05-07 18:44:05 +02:00
- 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` : 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
2015-07-22 05:02:10 +02:00
2017-05-07 18:44:05 +02:00
## Community CSS & themes
2017-01-26 18:52:54 +01:00
2017-05-07 18:44:05 +02:00
### Custom CSS
2017-01-26 18:52:54 +01:00
- [mrjovanovic/serious-theme-shaarli ](https://github.com/mrjovanovic/serious-theme-shaarli ) - A serious theme for Shaarli
- [shaarli/shaarli-themes ](https://github.com/shaarli/shaarli-themes )
2017-05-07 18:44:05 +02:00
### Themes
2017-01-26 18:52:54 +01:00
- [AkibaTech/Shaarli Superhero Theme ](https://github.com/AkibaTech/Shaarli---SuperHero-Theme ) - A template/theme for Shaarli
- [alexisju/albinomouse-template ](https://github.com/alexisju/albinomouse-template ) - A full template for Shaarli
- [ArthurHoaro/shaarli-launch ](https://github.com/ArthurHoaro/shaarli-launch ) - Customizable Shaarli theme
- [dhoko/ShaarliTemplate ](https://github.com/dhoko/ShaarliTemplate ) - A template/theme for Shaarli
- [kalvn/shaarli-blocks ](https://github.com/kalvn/shaarli-blocks ) - A template/theme for Shaarli
- [kalvn/Shaarli-Material ](https://github.com/kalvn/Shaarli-Material ) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone
- [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
2020-06-02 17:27:02 +02:00
- [xfnw/shaarli-default-dark ](https://github.com/xfnw/shaarli-default-dark ) - The default theme but nice and dark for your eyeballs
2017-05-07 18:44:05 +02:00
### Shaarli forks
2017-01-26 18:52:54 +01:00
- [misterair/Limonade ](https://github.com/misterair/limonade ) - A fork of (legacy) Shaarli with a new template
- [vivienhaese/shaarlitheme ](https://github.com/vivienhaese/shaarlitheme ) - A Shaarli fork meant to be run in an openshift instance
2015-07-22 05:02:10 +02:00
2017-05-07 18:44:05 +02:00
## Example installation: AlbinoMouse theme
2017-01-26 18:52:54 +01:00
2015-07-22 05:02:10 +02:00
With the following configuration:
2017-08-05 11:56:24 +02:00
2015-07-22 05:02:10 +02:00
- 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
```bash
$ 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
2017-08-05 11:56:24 +02:00
Edit Shaarli's [configuration ](Shaarli-configuration ):
2015-07-22 05:02:10 +02:00
```bash
# the file should be owned by Apache, thus not writeable => sudo
$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php
```
