diff options
author | nodiscc <nodiscc@gmail.com> | 2020-05-16 12:54:51 +0200 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2020-09-12 14:31:45 +0200 |
commit | 91a21c272960889afd4eaa431a3d29b7785b6efc (patch) | |
tree | 26e3ba62319964c5fd48d93fdfe47813d5dc9bf5 /doc/md/Theming.md | |
parent | 6128ab6a55430a2b705be31ff417c0c552a0db1f (diff) | |
download | Shaarli-91a21c272960889afd4eaa431a3d29b7785b6efc.tar.gz Shaarli-91a21c272960889afd4eaa431a3d29b7785b6efc.tar.zst Shaarli-91a21c272960889afd4eaa431a3d29b7785b6efc.zip |
**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
Diffstat (limited to 'doc/md/Theming.md')
-rw-r--r-- | doc/md/Theming.md | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/doc/md/Theming.md b/doc/md/Theming.md deleted file mode 100644 index eb84e11c..00000000 --- a/doc/md/Theming.md +++ /dev/null | |||
@@ -1,83 +0,0 @@ | |||
1 | ## Foreword | ||
2 | |||
3 | There are two ways of customizing how Shaarli looks: | ||
4 | |||
5 | 1. by using a custom CSS to override Shaarli's CSS | ||
6 | 2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources | ||
7 | |||
8 | ## Custom CSS | ||
9 | |||
10 | Shaarli's appearance can be modified by adding CSS rules to: | ||
11 | |||
12 | - Shaarli < `v0.9.0`: `inc/user.css` | ||
13 | - Shaarli >= `v0.9.0`: `data/user.css` | ||
14 | |||
15 | This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme. | ||
16 | |||
17 | **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. | ||
18 | |||
19 | ## Themes | ||
20 | |||
21 | Installation: | ||
22 | |||
23 | - find a theme you'd like to install | ||
24 | - copy or clone the theme folder under `tpl/<a_sweet_theme>` | ||
25 | - enable the theme: | ||
26 | - Shaarli < `v0.9.0`: edit `data/config.json.php` and set the value of `raintpl_tpl` to the new theme name: | ||
27 | `"raintpl_tpl": "tpl\/my-template\/"` | ||
28 | - Shaarli >= `v0.9.0`: select the theme through the _Tools_ page | ||
29 | |||
30 | ## Community CSS & themes | ||
31 | |||
32 | ### Custom CSS | ||
33 | |||
34 | - [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli | ||
35 | - [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes) | ||
36 | |||
37 | ### Themes | ||
38 | |||
39 | - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli | ||
40 | - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli | ||
41 | - [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme | ||
42 | - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli | ||
43 | - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli | ||
44 | - [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone | ||
45 | - [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 | ||
46 | |||
47 | ### Shaarli forks | ||
48 | |||
49 | - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template | ||
50 | - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance | ||
51 | |||
52 | ## Example installation: AlbinoMouse theme | ||
53 | |||
54 | With the following configuration: | ||
55 | |||
56 | - Apache 2 / PHP 5.6 | ||
57 | - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir` | ||
58 | - `http` is the name of the Apache user | ||
59 | |||
60 | ```bash | ||
61 | $ cd ~/public_html | ||
62 | |||
63 | # clone repositories | ||
64 | $ git clone https://github.com/shaarli/Shaarli.git shaarli | ||
65 | $ pushd shaarli/tpl | ||
66 | $ git clone https://github.com/alexisju/albinomouse-template.git | ||
67 | $ popd | ||
68 | |||
69 | # set access rights for Apache | ||
70 | $ chgrp -R http shaarli | ||
71 | $ chmod g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp | ||
72 | ``` | ||
73 | |||
74 | Get config written: | ||
75 | - go to the freshly installed site | ||
76 | - fill the install form | ||
77 | - log in to Shaarli | ||
78 | |||
79 | Edit Shaarli's [configuration](Shaarli-configuration): | ||
80 | ```bash | ||
81 | # the file should be owned by Apache, thus not writeable => sudo | ||
82 | $ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php | ||
83 | ``` | ||