diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Community-&-Related-software.html | 8 | ||||
-rw-r--r-- | doc/Community-&-Related-software.md | 8 | ||||
-rw-r--r-- | doc/Download-and-Installation.html | 17 | ||||
-rw-r--r-- | doc/Download-and-Installation.md | 21 | ||||
-rw-r--r-- | doc/Release-Shaarli.html | 39 | ||||
-rw-r--r-- | doc/Release-Shaarli.md | 42 | ||||
-rw-r--r-- | doc/Server-configuration.html | 33 | ||||
-rw-r--r-- | doc/Server-configuration.md | 44 | ||||
-rw-r--r-- | doc/Theming.html | 7 | ||||
-rw-r--r-- | doc/Theming.md | 9 |
10 files changed, 195 insertions, 33 deletions
diff --git a/doc/Community-&-Related-software.html b/doc/Community-&-Related-software.html index accbacdc..cbc73d54 100644 --- a/doc/Community-&-Related-software.html +++ b/doc/Community-&-Related-software.html | |||
@@ -81,10 +81,11 @@ | |||
81 | <ul> | 81 | <ul> |
82 | <li><a href="https://github.com/kalvn/shaarli-plugin-autosave">autosave</a> by <a href="https://github.com/kalvn">@kalvn</a>: Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.<a href=".html"></a></li> | 82 | <li><a href="https://github.com/kalvn/shaarli-plugin-autosave">autosave</a> by <a href="https://github.com/kalvn">@kalvn</a>: Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.<a href=".html"></a></li> |
83 | <li><a href="https://github.com/ArthurHoaro/code-coloration">Code Coloration</a> by <a href="https://github.com/ArthurHoaro">@ArthurHoaro</a>: client side code syntax highlighter.<a href=".html"></a></li> | 83 | <li><a href="https://github.com/ArthurHoaro/code-coloration">Code Coloration</a> by <a href="https://github.com/ArthurHoaro">@ArthurHoaro</a>: client side code syntax highlighter.<a href=".html"></a></li> |
84 | <li><a href="https://github.com/alexisju/social">social</a> by <a href="https://github.com/alexisju">@alexisju</a>: share links to social networks.<a href=".html"></a></li> | 84 | <li><a href="https://github.com/kalvn/shaarli-plugin-disqus">Disqus</a> by <a href="https://github.com/kalvn">@kalvn</a>: Adds Disqus comment system to your Shaarli.<a href=".html"></a></li> |
85 | <li><a href="https://github.com/NerosTie/emojione">emojione</a> by <a href="https://github.com/NerosTie">@NerosTie</a>: Add colorful emojis to your Shaarli.<a href=".html"></a></li> | 85 | <li><a href="https://github.com/NerosTie/emojione">emojione</a> by <a href="https://github.com/NerosTie">@NerosTie</a>: Add colorful emojis to your Shaarli.<a href=".html"></a></li> |
86 | <li><a href="https://github.com/ArthurHoaro/launch-plugin">launch</a> - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.<a href=".html"></a></li> | 86 | <li><a href="https://github.com/ArthurHoaro/launch-plugin">launch</a> - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.<a href=".html"></a></li> |
87 | <li><a href="https://github.com/kalvn/shaarli-plugin-disqus">Disqus</a> by <a href="https://github.com/kalvn">@kalvn</a>: Adds Disqus comment system to your Shaarli.<a href=".html"></a></li> | 87 | <li><a href="https://github.com/alexisju/social">social</a> by <a href="https://github.com/alexisju">@alexisju</a>: share links to social networks.<a href=".html"></a></li> |
88 | <li><a href="https://github.com/ArthurHoaro/shaarli2twitter">shaarli2twitter</a> by <a href="https://github.com/ArthurHoaro">@ArthurHoaro</a> - Automatically tweet your shared links from Shaarli<a href=".html"></a></li> | ||
88 | </ul> | 89 | </ul> |
89 | <h3 id="themes">Themes</h3> | 90 | <h3 id="themes">Themes</h3> |
90 | <p>See <a href="Theming.html">Theming</a> for the list of community-contributed themes, and an installation guide.</p> | 91 | <p>See <a href="Theming.html">Theming</a> for the list of community-contributed themes, and an installation guide.</p> |
@@ -95,7 +96,7 @@ | |||
95 | <li><a href="https://github.com/DMeloni/shaarlo">Shaarlo</a> - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: <a href="http://shaarli.fr/">shaarli.fr</a>)<a href=".html"></a></li> | 96 | <li><a href="https://github.com/DMeloni/shaarlo">Shaarlo</a> - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: <a href="http://shaarli.fr/">shaarli.fr</a>)<a href=".html"></a></li> |
96 | <li><a href="https://github.com/BoboTiG/shaarlimages">Shaarlimages</a> - An image-oriented aggregator for Shaarlis<a href=".html"></a></li> | 97 | <li><a href="https://github.com/BoboTiG/shaarlimages">Shaarlimages</a> - An image-oriented aggregator for Shaarlis<a href=".html"></a></li> |
97 | <li><a href="https://github.com/mknexen/shaarli-api">mknexen/shaarli-api</a> - A REST API for Shaarli<a href=".html"></a></li> | 98 | <li><a href="https://github.com/mknexen/shaarli-api">mknexen/shaarli-api</a> - A REST API for Shaarli<a href=".html"></a></li> |
98 | <li><a href="https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php">Self dead link</a> - Detect dead links on shaarli. This version use the database of shaarli. An <a href="https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php">another version</a>, can be used for others shaarli (but use most ressources).<a href=".html"></a></li> | 99 | <li><a href="https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php">Self dead link</a> - Detect dead links on shaarli. This version use the database of shaarli. <a href="https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php">Another version</a>, can be used for other shaarli instances (but is more resource consuming).<a href=".html"></a></li> |
99 | </ul> | 100 | </ul> |
100 | <h3 id="mobile-apps">Mobile Apps</h3> | 101 | <h3 id="mobile-apps">Mobile Apps</h3> |
101 | <ul> | 102 | <ul> |
@@ -107,6 +108,7 @@ | |||
107 | <ul> | 108 | <ul> |
108 | <li><a href="https://github.com/jcsaaddupuy/tt-rss-shaarli">tt-rss-shaarli</a> - <a href="http://tt-rss.org/">TinyTiny RSS</a> plugin that adds support for sharing articles with Shaarli<a href=".html"></a></li> | 109 | <li><a href="https://github.com/jcsaaddupuy/tt-rss-shaarli">tt-rss-shaarli</a> - <a href="http://tt-rss.org/">TinyTiny RSS</a> plugin that adds support for sharing articles with Shaarli<a href=".html"></a></li> |
109 | <li><a href="https://github.com/ahmet2mir/octopress-shaarli">octopress-shaarli</a> - Octopress plugin to retrieve Shaarli links on the sidebar<a href=".html"></a></li> | 110 | <li><a href="https://github.com/ahmet2mir/octopress-shaarli">octopress-shaarli</a> - Octopress plugin to retrieve Shaarli links on the sidebar<a href=".html"></a></li> |
111 | <li><a href="https://github.com/q2apro/scuttle-to-shaarli">Scuttle to Shaarli</a> - Import bookmarks from Scuttle<a href=".html"></a></li> | ||
110 | </ul> | 112 | </ul> |
111 | <h2 id="alternatives-to-shaarli">Alternatives to Shaarli</h2> | 113 | <h2 id="alternatives-to-shaarli">Alternatives to Shaarli</h2> |
112 | <ul> | 114 | <ul> |
diff --git a/doc/Community-&-Related-software.md b/doc/Community-&-Related-software.md index 3945d005..291bf643 100644 --- a/doc/Community-&-Related-software.md +++ b/doc/Community-&-Related-software.md | |||
@@ -20,10 +20,11 @@ _TODO: contact repos owners to see if they'd like to standardize their work with | |||
20 | 20 | ||
21 | * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.[](.html) | 21 | * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.[](.html) |
22 | * [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter.[](.html) | 22 | * [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter.[](.html) |
23 | * [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks.[](.html) | 23 | * [Disqus](https://github.com/kalvn/shaarli-plugin-disqus) by [@kalvn](https://github.com/kalvn): Adds Disqus comment system to your Shaarli.[](.html) |
24 | * [emojione](https://github.com/NerosTie/emojione) by [@NerosTie](https://github.com/NerosTie): Add colorful emojis to your Shaarli.[](.html) | 24 | * [emojione](https://github.com/NerosTie/emojione) by [@NerosTie](https://github.com/NerosTie): Add colorful emojis to your Shaarli.[](.html) |
25 | * [launch](https://github.com/ArthurHoaro/launch-plugin) - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.[](.html) | 25 | * [launch](https://github.com/ArthurHoaro/launch-plugin) - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.[](.html) |
26 | * [Disqus](https://github.com/kalvn/shaarli-plugin-disqus) by [@kalvn](https://github.com/kalvn): Adds Disqus comment system to your Shaarli.[](.html) | 26 | * [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks.[](.html) |
27 | * [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli[](.html) | ||
27 | 28 | ||
28 | 29 | ||
29 | ### Themes | 30 | ### Themes |
@@ -35,7 +36,7 @@ See [Theming](Theming.html) for the list of community-contributed themes, and an | |||
35 | - [Shaarlo](https://github.com/DMeloni/shaarlo) - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: [shaarli.fr](http://shaarli.fr/))[](.html) | 36 | - [Shaarlo](https://github.com/DMeloni/shaarlo) - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: [shaarli.fr](http://shaarli.fr/))[](.html) |
36 | - [Shaarlimages](https://github.com/BoboTiG/shaarlimages) - An image-oriented aggregator for Shaarlis[](.html) | 37 | - [Shaarlimages](https://github.com/BoboTiG/shaarlimages) - An image-oriented aggregator for Shaarlis[](.html) |
37 | - [mknexen/shaarli-api](https://github.com/mknexen/shaarli-api) - A REST API for Shaarli[](.html) | 38 | - [mknexen/shaarli-api](https://github.com/mknexen/shaarli-api) - A REST API for Shaarli[](.html) |
38 | - [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. An [another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for others shaarli (but use most ressources).[](.html) | 39 | - [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. [Another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for other shaarli instances (but is more resource consuming).[](.html) |
39 | 40 | ||
40 | ### Mobile Apps | 41 | ### Mobile Apps |
41 | - [Shaarli💫](http://app.mro.name/Shaarli💫) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes,[](.html) | 42 | - [Shaarli💫](http://app.mro.name/Shaarli💫) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes,[](.html) |
@@ -45,6 +46,7 @@ See [Theming](Theming.html) for the list of community-contributed themes, and an | |||
45 | ## Integration with other platforms | 46 | ## Integration with other platforms |
46 | - [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [TinyTiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli[](.html) | 47 | - [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [TinyTiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli[](.html) |
47 | - [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - Octopress plugin to retrieve Shaarli links on the sidebar[](.html) | 48 | - [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - Octopress plugin to retrieve Shaarli links on the sidebar[](.html) |
49 | - [Scuttle to Shaarli](https://github.com/q2apro/scuttle-to-shaarli) - Import bookmarks from Scuttle[](.html) | ||
48 | 50 | ||
49 | ## Alternatives to Shaarli | 51 | ## Alternatives to Shaarli |
50 | - [Shaarli alternatives](http://alternativeto.net/software/shaarli/) (alternativeto.net)[](.html) | 52 | - [Shaarli alternatives](http://alternativeto.net/software/shaarli/) (alternativeto.net)[](.html) |
diff --git a/doc/Download-and-Installation.html b/doc/Download-and-Installation.html index 17c7b69e..b9cac360 100644 --- a/doc/Download-and-Installation.html +++ b/doc/Download-and-Installation.html | |||
@@ -105,13 +105,14 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
105 | <p>Several releases are available:</p> | 105 | <p>Several releases are available:</p> |
106 | <hr /> | 106 | <hr /> |
107 | <h2 id="latest-release-recommended">Latest release (recommended)</h2> | 107 | <h2 id="latest-release-recommended">Latest release (recommended)</h2> |
108 | <p>Get the latest released version from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.<a href=".html"></a></p> | ||
109 | <p>The current latest released version is <code>v0.7.0</code>.</p> | ||
110 | <h3 id="download-as-an-archive">Download as an archive</h3> | 108 | <h3 id="download-as-an-archive">Download as an archive</h3> |
111 | <p>As a .zip archive:</p> | 109 | <p>Get the latest released version from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.<a href=".html"></a></p> |
112 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">wget</span> https://github.com/shaarli/Shaarli/archive/v0.7.0.zip | 110 | <p><strong>Download our <em>shaarli-full</em> archive</strong> to include dependencies.</p> |
113 | $ <span class="fu">unzip</span> Shaarli-v0.7.0.zip | 111 | <p>The current latest released version is <code>v0.8.0</code></p> |
114 | $ <span class="fu">mv</span> Shaarli-v0.7.0 /path/to/shaarli/</code></pre></div> | 112 | <p>Or in command lines:</p> |
113 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">wget</span> https://github.com/shaarli/Shaarli/releases/download/v0.8.0/shaarli-v0.8.0-full.zip | ||
114 | $ <span class="fu">unzip</span> shaarli-v0.8.0-full.zip | ||
115 | $ <span class="fu">mv</span> Shaarli /path/to/shaarli/</code></pre></div> | ||
115 | <table style="width:46%;"> | 116 | <table style="width:46%;"> |
116 | <colgroup> | 117 | <colgroup> |
117 | <col style="width: 8%" /> | 118 | <col style="width: 8%" /> |
@@ -126,6 +127,10 @@ $ <span class="fu">mv</span> Shaarli-v0.7.0 /path/to/shaarli/</code></pre></div> | |||
126 | <tbody> | 127 | <tbody> |
127 | </tbody> | 128 | </tbody> |
128 | </table> | 129 | </table> |
130 | <h3 id="using-git">Using git</h3> | ||
131 | <pre><code>mkdir -p /path/to/shaarli && cd /path/to/shaarli/ | ||
132 | git clone -b v0.8.0 https://github.com/shaarli/Shaarli.git . | ||
133 | composer update --no-dev</code></pre> | ||
129 | <hr /> | 134 | <hr /> |
130 | <h2 id="stable-version">Stable version</h2> | 135 | <h2 id="stable-version">Stable version</h2> |
131 | <p>The stable version has been experienced by Shaarli users, and will receive security updates.</p> | 136 | <p>The stable version has been experienced by Shaarli users, and will receive security updates.</p> |
diff --git a/doc/Download-and-Installation.md b/doc/Download-and-Installation.md index 77af25eb..32df8984 100644 --- a/doc/Download-and-Installation.md +++ b/doc/Download-and-Installation.md | |||
@@ -8,26 +8,31 @@ Several releases are available: | |||
8 | -------------------------------------------------------- | 8 | -------------------------------------------------------- |
9 | 9 | ||
10 | ## Latest release (recommended) | 10 | ## Latest release (recommended) |
11 | 11 | ### Download as an archive | |
12 | Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html) | 12 | Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html) |
13 | 13 | ||
14 | The current latest released version is `v0.7.0`. | 14 | **Download our *shaarli-full* archive** to include dependencies. |
15 | 15 | ||
16 | ### Download as an archive | 16 | The current latest released version is `v0.8.0` |
17 | 17 | ||
18 | As a .zip archive: | 18 | Or in command lines: |
19 | 19 | ||
20 | ```bash | 20 | ```bash |
21 | $ wget https://github.com/shaarli/Shaarli/archive/v0.7.0.zip | 21 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.0/shaarli-v0.8.0-full.zip |
22 | $ unzip Shaarli-v0.7.0.zip | 22 | $ unzip shaarli-v0.8.0-full.zip |
23 | $ mv Shaarli-v0.7.0 /path/to/shaarli/ | 23 | $ mv Shaarli /path/to/shaarli/ |
24 | ``` | 24 | ``` |
25 | 25 | ||
26 | |||
27 | | ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).|[](.html) | 26 | | ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).|[](.html) |
28 | |-----|--------------------------| | 27 | |-----|--------------------------| |
29 | 28 | ||
29 | ### Using git | ||
30 | 30 | ||
31 | ``` | ||
32 | mkdir -p /path/to/shaarli && cd /path/to/shaarli/ | ||
33 | git clone -b v0.8.0 https://github.com/shaarli/Shaarli.git . | ||
34 | composer update --no-dev | ||
35 | ``` | ||
31 | 36 | ||
32 | -------------------------------------------------------- | 37 | -------------------------------------------------------- |
33 | 38 | ||
diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html index cdefd3d6..0d9fa3e1 100644 --- a/doc/Release-Shaarli.html +++ b/doc/Release-Shaarli.html | |||
@@ -115,9 +115,35 @@ releases</a>.</p> | |||
115 | <li><code>origin</code> pointing to your GitHub fork</li> | 115 | <li><code>origin</code> pointing to your GitHub fork</li> |
116 | <li><code>upstream</code> pointing to the main Shaarli repository</li> | 116 | <li><code>upstream</code> pointing to the main Shaarli repository</li> |
117 | </ul></li> | 117 | </ul></li> |
118 | <li>maintainer permissions on the main Shaarli repository (to push the signed tag)</li> | 118 | <li>maintainer permissions on the main Shaarli repository, to: |
119 | <ul> | ||
120 | <li>push the signed tag</li> | ||
121 | <li>create a new release</li> | ||
122 | </ul></li> | ||
119 | <li><a href="https://getcomposer.org/">Composer</a> and <a href="http://pandoc.org/">Pandoc</a> need to be installed<a href=".html"></a></li> | 123 | <li><a href="https://getcomposer.org/">Composer</a> and <a href="http://pandoc.org/">Pandoc</a> need to be installed<a href=".html"></a></li> |
120 | </ul> | 124 | </ul> |
125 | <h2 id="github-release-draft-and-changelog.md">GitHub release draft and <code>CHANGELOG.md</code></h2> | ||
126 | <p>See <a href="http://keepachangelog.com/en/0.3.0/" class="uri">http://keepachangelog.com/en/0.3.0/</a> for changelog formatting.</p> | ||
127 | <h3 id="github-release-draft">GitHub release draft</h3> | ||
128 | <p>GitHub allows drafting the release note for the upcoming release, from the <a href="https://github.com/shaarli/Shaarli/releases">Releases</a> page. This way, the release note can be drafted while contributions are merged to <code>master</code>.<a href=".html"></a></p> | ||
129 | <h3 id="changelog.md"><code>CHANGELOG.md</code></h3> | ||
130 | <p>This file should contain the same information as the release note draft for the upcoming version.</p> | ||
131 | <p>Update it to:</p> | ||
132 | <ul> | ||
133 | <li>add new entries (additions, fixes, etc.)</li> | ||
134 | <li>mark the current version as released by setting its date and link</li> | ||
135 | <li>add a new section for the future unreleased version</li> | ||
136 | </ul> | ||
137 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli | ||
138 | |||
139 | $ <span class="fu">nano</span> CHANGELOG.md | ||
140 | |||
141 | [<span class="ex">...</span>][](.html) | ||
142 | <span class="co">## vA.B.C - UNRELEASED</span> | ||
143 | <span class="ex">TBA</span> | ||
144 | |||
145 | <span class="co">## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html)</span> | ||
146 | [<span class="ex">...</span>][](.html)</code></pre></div> | ||
121 | <h2 id="increment-the-version-code-create-and-push-a-signed-tag">Increment the version code, create and push a signed tag</h2> | 147 | <h2 id="increment-the-version-code-create-and-push-a-signed-tag">Increment the version code, create and push a signed tag</h2> |
122 | <h3 id="bump-shaarlis-version">Bump Shaarli's version</h3> | 148 | <h3 id="bump-shaarlis-version">Bump Shaarli's version</h3> |
123 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli | 149 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli |
@@ -165,7 +191,16 @@ $ <span class="fu">git</span> show-ref tags/v0.5.0 | |||
165 | $ <span class="fu">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 | 191 | $ <span class="fu">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 |
166 | <span class="ex">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F | 192 | <span class="ex">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F |
167 | <span class="ex">gpg</span>: Good signature from <span class="st">"VirtualTam <virtualtam@flibidi.net>"</span> [ultimate][](.html)</code></pre></div> | 193 | <span class="ex">gpg</span>: Good signature from <span class="st">"VirtualTam <virtualtam@flibidi.net>"</span> [ultimate][](.html)</code></pre></div> |
168 | <h2 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h2> | 194 | <h2 id="publish-the-github-release">Publish the GitHub release</h2> |
195 | <h3 id="create-a-github-release-from-a-git-tag">Create a GitHub release from a Git tag</h3> | ||
196 | <p>From the previously drafted release:</p> | ||
197 | <ul> | ||
198 | <li>edit the release notes (if needed)</li> | ||
199 | <li>specify the appropriate Git tag</li> | ||
200 | <li>publish the release</li> | ||
201 | <li>profit!</li> | ||
202 | </ul> | ||
203 | <h3 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h3> | ||
169 | <p>Users with a shared hosting may have:</p> | 204 | <p>Users with a shared hosting may have:</p> |
170 | <ul> | 205 | <ul> |
171 | <li>no SSH access</li> | 206 | <li>no SSH access</li> |
diff --git a/doc/Release-Shaarli.md b/doc/Release-Shaarli.md index 5cbcd79a..556a96ee 100644 --- a/doc/Release-Shaarli.md +++ b/doc/Release-Shaarli.md | |||
@@ -10,9 +10,39 @@ This guide assumes that you have: | |||
10 | - a local clone of your Shaarli fork, with the following remotes: | 10 | - a local clone of your Shaarli fork, with the following remotes: |
11 | - `origin` pointing to your GitHub fork | 11 | - `origin` pointing to your GitHub fork |
12 | - `upstream` pointing to the main Shaarli repository | 12 | - `upstream` pointing to the main Shaarli repository |
13 | - maintainer permissions on the main Shaarli repository (to push the signed tag) | 13 | - maintainer permissions on the main Shaarli repository, to: |
14 | - push the signed tag | ||
15 | - create a new release | ||
14 | - [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed[](.html) | 16 | - [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed[](.html) |
15 | 17 | ||
18 | ## GitHub release draft and `CHANGELOG.md` | ||
19 | See http://keepachangelog.com/en/0.3.0/ for changelog formatting. | ||
20 | |||
21 | ### GitHub release draft | ||
22 | GitHub allows drafting the release note for the upcoming release, from the [Releases](https://github.com/shaarli/Shaarli/releases) page. This way, the release note can be drafted while contributions are merged to `master`.[](.html) | ||
23 | |||
24 | ### `CHANGELOG.md` | ||
25 | This file should contain the same information as the release note draft for the upcoming version. | ||
26 | |||
27 | Update it to: | ||
28 | - add new entries (additions, fixes, etc.) | ||
29 | - mark the current version as released by setting its date and link | ||
30 | - add a new section for the future unreleased version | ||
31 | |||
32 | ```bash | ||
33 | $ cd /path/to/shaarli | ||
34 | |||
35 | $ nano CHANGELOG.md | ||
36 | |||
37 | [...][](.html) | ||
38 | ## vA.B.C - UNRELEASED | ||
39 | TBA | ||
40 | |||
41 | ## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html) | ||
42 | [...][](.html) | ||
43 | ``` | ||
44 | |||
45 | |||
16 | ## Increment the version code, create and push a signed tag | 46 | ## Increment the version code, create and push a signed tag |
17 | ### Bump Shaarli's version | 47 | ### Bump Shaarli's version |
18 | ```bash | 48 | ```bash |
@@ -72,7 +102,15 @@ gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F | |||
72 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html) | 102 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html) |
73 | ``` | 103 | ``` |
74 | 104 | ||
75 | ## Generate and upload all-in-one release archives | 105 | ## Publish the GitHub release |
106 | ### Create a GitHub release from a Git tag | ||
107 | From the previously drafted release: | ||
108 | - edit the release notes (if needed) | ||
109 | - specify the appropriate Git tag | ||
110 | - publish the release | ||
111 | - profit! | ||
112 | |||
113 | ### Generate and upload all-in-one release archives | ||
76 | Users with a shared hosting may have: | 114 | Users with a shared hosting may have: |
77 | - no SSH access | 115 | - no SSH access |
78 | - no possibility to install PHP packages or server extensions | 116 | - no possibility to install PHP packages or server extensions |
diff --git a/doc/Server-configuration.html b/doc/Server-configuration.html index 068900b8..2f1c25b5 100644 --- a/doc/Server-configuration.html +++ b/doc/Server-configuration.html | |||
@@ -193,6 +193,9 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
193 | ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span> | 193 | ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span> |
194 | CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span> | 194 | CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span> |
195 | <span class="fu"></VirtualHost></span></code></pre></div> | 195 | <span class="fu"></VirtualHost></span></code></pre></div> |
196 | <h3 id="htaccess">.htaccess</h3> | ||
197 | <p>Shaarli use <code>.htaccess</code> Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive <code>AllowOverride All</code> in your virtual host configuration for them to work.</p> | ||
198 | <p><strong>Warning</strong>: If you use Apache 2.2 or lower, you need <a href="https://httpd.apache.org/docs/current/mod/mod_version.html">mod_version</a> to be installed and enabled.<a href=".html"></a></p> | ||
196 | <h2 id="lighthttpd">LightHttpd</h2> | 199 | <h2 id="lighthttpd">LightHttpd</h2> |
197 | <h2 id="nginx">Nginx</h2> | 200 | <h2 id="nginx">Nginx</h2> |
198 | <h3 id="foreword">Foreword</h3> | 201 | <h3 id="foreword">Foreword</h3> |
@@ -233,7 +236,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
233 | <li>files may be located in a user's home directory</li> | 236 | <li>files may be located in a user's home directory</li> |
234 | <li>in this case, make sure both Nginx and PHP-FPM are running as the local user/group!</li> | 237 | <li>in this case, make sure both Nginx and PHP-FPM are running as the local user/group!</li> |
235 | </ul> | 238 | </ul> |
236 | <p>For all following examples, a development configuration will be used:</p> | 239 | <p>For all following configuration examples, this user/group pair will be used:</p> |
237 | <ul> | 240 | <ul> |
238 | <li><code>user:group = john:users</code>,</li> | 241 | <li><code>user:group = john:users</code>,</li> |
239 | </ul> | 242 | </ul> |
@@ -251,6 +254,24 @@ user john users; | |||
251 | http { | 254 | http { |
252 | [...][](.html) | 255 | [...][](.html) |
253 | }</code></pre> | 256 | }</code></pre> |
257 | <h3 id="optional-increase-the-maximum-file-upload-size">(Optional) Increase the maximum file upload size</h3> | ||
258 | <p>Some bookmark dumps generated by web browsers can be <em>huge</em> due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders.</p> | ||
259 | <p>To increase upload size, you will need to modify both nginx and PHP configuration:</p> | ||
260 | <pre class="nginx"><code># /etc/nginx/nginx.conf | ||
261 | |||
262 | http { | ||
263 | [...][](.html) | ||
264 | |||
265 | client_max_body_size 10m; | ||
266 | |||
267 | [...][](.html) | ||
268 | }</code></pre> | ||
269 | <div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="co"># /etc/php5/fpm/php.ini</span> | ||
270 | |||
271 | <span class="kw">[...][]</span><span class="dt">(.html)</span> | ||
272 | <span class="dt">post_max_size </span><span class="ot">=</span><span class="st"> 10M</span> | ||
273 | <span class="kw">[...][]</span><span class="dt">(.html)</span> | ||
274 | <span class="dt">upload_max_filesize </span><span class="ot">=</span><span class="st"> 10M</span></code></pre></div> | ||
254 | <h3 id="minimal-1">Minimal</h3> | 275 | <h3 id="minimal-1">Minimal</h3> |
255 | <p><em>WARNING: Use for development only!</em></p> | 276 | <p><em>WARNING: Use for development only!</em></p> |
256 | <pre class="nginx"><code>user john users; | 277 | <pre class="nginx"><code>user john users; |
@@ -350,6 +371,11 @@ http { | |||
350 | error_log /var/log/nginx/shaarli.error.log; | 371 | error_log /var/log/nginx/shaarli.error.log; |
351 | } | 372 | } |
352 | 373 | ||
374 | location = /shaarli/favicon.ico { | ||
375 | # serve the Shaarli favicon from its custom location | ||
376 | alias /var/www/shaarli/images/favicon.ico; | ||
377 | } | ||
378 | |||
353 | include deny.conf; | 379 | include deny.conf; |
354 | include static_assets.conf; | 380 | include static_assets.conf; |
355 | include php.conf; | 381 | include php.conf; |
@@ -403,6 +429,11 @@ http { | |||
403 | error_log /var/log/nginx/shaarli.error.log; | 429 | error_log /var/log/nginx/shaarli.error.log; |
404 | } | 430 | } |
405 | 431 | ||
432 | location = /shaarli/favicon.ico { | ||
433 | # serve the Shaarli favicon from its custom location | ||
434 | alias /var/www/shaarli/images/favicon.ico; | ||
435 | } | ||
436 | |||
406 | include deny.conf; | 437 | include deny.conf; |
407 | include static_assets.conf; | 438 | include static_assets.conf; |
408 | include php.conf; | 439 | include php.conf; |
diff --git a/doc/Server-configuration.md b/doc/Server-configuration.md index 1ab57a0a..df10feb2 100644 --- a/doc/Server-configuration.md +++ b/doc/Server-configuration.md | |||
@@ -102,6 +102,12 @@ See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache) | |||
102 | </VirtualHost> | 102 | </VirtualHost> |
103 | ``` | 103 | ``` |
104 | 104 | ||
105 | ### .htaccess | ||
106 | |||
107 | Shaarli use `.htaccess` Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive `AllowOverride All` in your virtual host configuration for them to work. | ||
108 | |||
109 | **Warning**: If you use Apache 2.2 or lower, you need [mod_version](https://httpd.apache.org/docs/current/mod/mod_version.html) to be installed and enabled.[](.html) | ||
110 | |||
105 | ## LightHttpd | 111 | ## LightHttpd |
106 | 112 | ||
107 | ## Nginx | 113 | ## Nginx |
@@ -136,7 +142,7 @@ On a development server: | |||
136 | - files may be located in a user's home directory | 142 | - files may be located in a user's home directory |
137 | - in this case, make sure both Nginx and PHP-FPM are running as the local user/group! | 143 | - in this case, make sure both Nginx and PHP-FPM are running as the local user/group! |
138 | 144 | ||
139 | For all following examples, a development configuration will be used: | 145 | For all following configuration examples, this user/group pair will be used: |
140 | - `user:group = john:users`, | 146 | - `user:group = john:users`, |
141 | 147 | ||
142 | which corresponds to the following service configuration: | 148 | which corresponds to the following service configuration: |
@@ -160,6 +166,32 @@ http { | |||
160 | } | 166 | } |
161 | ``` | 167 | ``` |
162 | 168 | ||
169 | ### (Optional) Increase the maximum file upload size | ||
170 | Some bookmark dumps generated by web browsers can be _huge_ due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders. | ||
171 | |||
172 | To increase upload size, you will need to modify both nginx and PHP configuration: | ||
173 | |||
174 | ```nginx | ||
175 | # /etc/nginx/nginx.conf | ||
176 | |||
177 | http { | ||
178 | [...][](.html) | ||
179 | |||
180 | client_max_body_size 10m; | ||
181 | |||
182 | [...][](.html) | ||
183 | } | ||
184 | ``` | ||
185 | |||
186 | ```ini | ||
187 | # /etc/php5/fpm/php.ini | ||
188 | |||
189 | [...][](.html) | ||
190 | post_max_size = 10M | ||
191 | [...][](.html) | ||
192 | upload_max_filesize = 10M | ||
193 | ``` | ||
194 | |||
163 | ### Minimal | 195 | ### Minimal |
164 | _WARNING: Use for development only!_ | 196 | _WARNING: Use for development only!_ |
165 | 197 | ||
@@ -271,6 +303,11 @@ http { | |||
271 | error_log /var/log/nginx/shaarli.error.log; | 303 | error_log /var/log/nginx/shaarli.error.log; |
272 | } | 304 | } |
273 | 305 | ||
306 | location = /shaarli/favicon.ico { | ||
307 | # serve the Shaarli favicon from its custom location | ||
308 | alias /var/www/shaarli/images/favicon.ico; | ||
309 | } | ||
310 | |||
274 | include deny.conf; | 311 | include deny.conf; |
275 | include static_assets.conf; | 312 | include static_assets.conf; |
276 | include php.conf; | 313 | include php.conf; |
@@ -328,6 +365,11 @@ http { | |||
328 | error_log /var/log/nginx/shaarli.error.log; | 365 | error_log /var/log/nginx/shaarli.error.log; |
329 | } | 366 | } |
330 | 367 | ||
368 | location = /shaarli/favicon.ico { | ||
369 | # serve the Shaarli favicon from its custom location | ||
370 | alias /var/www/shaarli/images/favicon.ico; | ||
371 | } | ||
372 | |||
331 | include deny.conf; | 373 | include deny.conf; |
332 | include static_assets.conf; | 374 | include static_assets.conf; |
333 | include php.conf; | 375 | include php.conf; |
diff --git a/doc/Theming.html b/doc/Theming.html index 13e6acf0..7cbf7aef 100644 --- a/doc/Theming.html +++ b/doc/Theming.html | |||
@@ -119,19 +119,20 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
119 | <ul> | 119 | <ul> |
120 | <li>There should now be a <code>my-template/</code> directory under the <code>tpl/</code> dir, containing directly all the template files.</li> | 120 | <li>There should now be a <code>my-template/</code> directory under the <code>tpl/</code> dir, containing directly all the template files.</li> |
121 | </ul></li> | 121 | </ul></li> |
122 | <li><p>Edit <code>data/config.php</code> to have Shaarli use this template, e.g.</p> | 122 | <li><p>Edit <code>data/config.json.php</code> to have Shaarli use this template, in <code>"resource"</code> e.g.</p> |
123 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'RAINTPL_TPL'</span><span class="ot">]</span> = <span class="st">'tpl/my-template/'</span><span class="ot">;](</span><span class="st">'RAINTPL_TPL'</span><span class="ot">]</span>-=-<span class="st">'tpl/my-template/'</span><span class="ot">;</span>.html<span class="ot">)</span></code></pre></div></li> | 123 | <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="er">"raintpl_tpl":</span> <span class="er">"tpl\/my-template\/",</span></code></pre></div></li> |
124 | </ul> | 124 | </ul> |
125 | <h2 id="community-themes-templates">Community themes & templates</h2> | 125 | <h2 id="community-themes-templates">Community themes & templates</h2> |
126 | <ul> | 126 | <ul> |
127 | <li><a href="https://github.com/AkibaTech/Shaarli---SuperHero-Theme">AkibaTech/Shaarli Superhero Theme</a> - A template/theme for Shaarli<a href=".html"></a></li> | 127 | <li><a href="https://github.com/AkibaTech/Shaarli---SuperHero-Theme">AkibaTech/Shaarli Superhero Theme</a> - A template/theme for Shaarli<a href=".html"></a></li> |
128 | <li><a href="https://github.com/alexisju/albinomouse-template">alexisju/albinomouse-template</a> - A full template for Shaarli<a href=".html"></a></li> | 128 | <li><a href="https://github.com/alexisju/albinomouse-template">alexisju/albinomouse-template</a> - A full template for Shaarli<a href=".html"></a></li> |
129 | <li><a href="https://github.com/ArthurHoaro/shaarli-launch">ArthurHoaro/shaarli-launch</a> - Customizable Shaarli theme.<a href=".html"></a></li> | ||
129 | <li><a href="https://github.com/dhoko/ShaarliTemplate">dhoko/ShaarliTemplate</a> - A template/theme for Shaarli<a href=".html"></a></li> | 130 | <li><a href="https://github.com/dhoko/ShaarliTemplate">dhoko/ShaarliTemplate</a> - A template/theme for Shaarli<a href=".html"></a></li> |
130 | <li><a href="https://github.com/kalvn/shaarli-blocks">kalvn/shaarli-blocks</a> - A template/theme for Shaarli<a href=".html"></a></li> | 131 | <li><a href="https://github.com/kalvn/shaarli-blocks">kalvn/shaarli-blocks</a> - A template/theme for Shaarli<a href=".html"></a></li> |
131 | <li><a href="https://github.com/kalvn/Shaarli-Material">kalvn/Shaarli-Material</a> - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone.<a href=".html"></a></li> | 132 | <li><a href="https://github.com/kalvn/Shaarli-Material">kalvn/Shaarli-Material</a> - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone.<a href=".html"></a></li> |
133 | <li><a href="https://github.com/ManufacturaInd/shaarli-2004licious-theme">ManufacturaInd/shaarli-2004licious-theme</a> - A template/theme as a humble homage to the early looks of the del.icio.us site.<a href=".html"></a></li> | ||
132 | <li><a href="https://github.com/misterair/limonade">misterair/Limonade</a> - A fork of (legacy) Shaarli with a new template<a href=".html"></a></li> | 134 | <li><a href="https://github.com/misterair/limonade">misterair/Limonade</a> - A fork of (legacy) Shaarli with a new template<a href=".html"></a></li> |
133 | <li><a href="https://github.com/mrjovanovic/serious-theme-shaarli">mrjovanovic/serious-theme-shaarli</a> - A serious theme for SHaarli.<a href=".html"></a></li> | 135 | <li><a href="https://github.com/mrjovanovic/serious-theme-shaarli">mrjovanovic/serious-theme-shaarli</a> - A serious theme for SHaarli.<a href=".html"></a></li> |
134 | <li><a href="https://github.com/Vinm/Blue-theme-for-Shaarli">Vinm/Blue-theme-for Shaarli</a> - A template/theme for Shaarli (<a href="https://github.com/Vinm/Blue-theme-for-Shaarli/issues/2">unmaintained</a>, compatibility unknown)<a href=".html"></a></li> | ||
135 | <li><a href="https://github.com/vivienhaese/shaarlitheme">vivienhaese/shaarlitheme</a> - A Shaarli fork meant to be run in an openshift instance<a href=".html"></a></li> | 136 | <li><a href="https://github.com/vivienhaese/shaarlitheme">vivienhaese/shaarlitheme</a> - A Shaarli fork meant to be run in an openshift instance<a href=".html"></a></li> |
136 | </ul> | 137 | </ul> |
137 | <h3 id="example-installation-albinomouse-template">Example installation: AlbinoMouse template</h3> | 138 | <h3 id="example-installation-albinomouse-template">Example installation: AlbinoMouse template</h3> |
diff --git a/doc/Theming.md b/doc/Theming.md index 7fb8d927..a21899c2 100644 --- a/doc/Theming.md +++ b/doc/Theming.md | |||
@@ -16,20 +16,21 @@ _WARNING - This feature is currently being worked on and will be improved in the | |||
16 | - Find it's git clone URL or download the zip archive for the template. | 16 | - Find it's git clone URL or download the zip archive for the template. |
17 | - In your Shaarli `tpl/` directory, run `git clone https://url/of/my-template/` or unpack the zip archive. | 17 | - In your Shaarli `tpl/` directory, run `git clone https://url/of/my-template/` or unpack the zip archive. |
18 | - There should now be a `my-template/` directory under the `tpl/` dir, containing directly all the template files. | 18 | - There should now be a `my-template/` directory under the `tpl/` dir, containing directly all the template files. |
19 | - Edit `data/config.php` to have Shaarli use this template, e.g. | 19 | - Edit `data/config.json.php` to have Shaarli use this template, in `"resource"` e.g. |
20 | ```php | 20 | ```json |
21 | $GLOBALS['config'['RAINTPL_TPL'] = 'tpl/my-template/';]('RAINTPL_TPL']-=-'tpl/my-template/';.html) | 21 | "raintpl_tpl": "tpl\/my-template\/", |
22 | ``` | 22 | ``` |
23 | 23 | ||
24 | ## Community themes & templates | 24 | ## Community themes & templates |
25 | - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli[](.html) | 25 | - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli[](.html) |
26 | - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli[](.html) | 26 | - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli[](.html) |
27 | - [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme.[](.html) | ||
27 | - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli[](.html) | 28 | - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli[](.html) |
28 | - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli[](.html) | 29 | - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli[](.html) |
29 | - [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone.[](.html) | 30 | - [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone.[](.html) |
31 | - [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.[](.html) | ||
30 | - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template[](.html) | 32 | - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template[](.html) |
31 | - [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for SHaarli.[](.html) | 33 | - [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for SHaarli.[](.html) |
32 | - [Vinm/Blue-theme-for Shaarli](https://github.com/Vinm/Blue-theme-for-Shaarli) - A template/theme for Shaarli ([unmaintained](https://github.com/Vinm/Blue-theme-for-Shaarli/issues/2), compatibility unknown)[](.html) | ||
33 | - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance[](.html) | 34 | - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance[](.html) |
34 | 35 | ||
35 | ### Example installation: AlbinoMouse template | 36 | ### Example installation: AlbinoMouse template |