<a class="current" href=".">Home</a>
<ul class="subnav">
+ <li class="toctree-l2"><a href="#shaarli-documentation">Shaarli documentation</a></li>
+
+ <ul>
+
+ <li><a class="toctree-l3" href="#demo">Demo</a></li>
+
+ <li><a class="toctree-l3" href="#features">Features</a></li>
+
+ <li><a class="toctree-l3" href="#about">About</a></li>
+
+ </ul>
+
+
</ul>
</li>
<div role="main">
<div class="section">
- <p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki!</p>
+ <h1 id="shaarli-documentation"><a href="https://github.com/shaarli/Shaarli/">Shaarli</a> documentation</h1>
<p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p>
<p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p>
-<p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> (<a href="https://github.com/shaarli/Shaarli/issues/44">archive</a>) or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>. If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p>
+<p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>.
+If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p>
<p>If you would like a feature added to Shaarli, check the issues labeled <a href="https://github.com/shaarli/Shaarli/labels/feature"><code>feature</code></a>, <a href="https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement</code></a>, and <a href="https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin</code></a>.</p>
-<p><em>Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the <code>doc/</code> directory of your Shaarli installation.</em></p>
+<p><em>Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the <code>doc/html/</code> directory of your Shaarli installation.</em></p>
+<p><a href="https://gitter.im/shaarli/Shaarli"><img alt="Join the chat at https://gitter.im/shaarli/Shaarli" src="https://badges.gitter.im/Join%20Chat.svg" /></a>
+<a href="https://www.bountysource.com/teams/shaarli/issues"><img alt="Bountysource" src="https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received" /></a>
+<a href="https://hub.docker.com/r/shaarli/shaarli/"><img alt="Docker repository" src="https://img.shields.io/docker/pulls/shaarli/shaarli.svg" /></a></p>
+<h3 id="demo">Demo</h3>
+<p>You can use this <a href="https://demo.shaarli.org">public demo instance of Shaarli</a>.
+It runs the latest development version of Shaarli and is updated/reset daily.</p>
+<p>Login: <code>demo</code>; Password: <code>demo</code></p>
+<h2 id="features">Features</h2>
+<h3 id="interface">Interface</h3>
+<ul>
+<li>minimalist design (simple is beautiful)</li>
+<li>FAST</li>
+<li>ATOM and RSS feeds</li>
+<li>views:<ul>
+<li>paginated link list</li>
+<li>tag cloud</li>
+<li>picture wall: image and video thumbnails</li>
+<li>daily: newspaper-like daily digest</li>
+<li>daily RSS feed</li>
+</ul>
+</li>
+<li>permalinks for easy reference</li>
+<li>links can be public or private</li>
+<li>extensible through <a href="https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage">plugins</a></li>
+</ul>
+<h3 id="tag-view-and-search-your-links">Tag, view and search your links!</h3>
+<ul>
+<li>add a custom title and description to archived links</li>
+<li>add tags to classify and search links<ul>
+<li>features tag autocompletion, renaming, merging and deletion</li>
+</ul>
+</li>
+<li>full-text and tag search</li>
+</ul>
+<h3 id="easy-setup">Easy setup</h3>
+<ul>
+<li>dead-simple installation: drop the files, open the page</li>
+<li>links are stored in a file<ul>
+<li>compact storage</li>
+<li>no database required</li>
+<li>easy backup: simply copy the datastore file</li>
+</ul>
+</li>
+<li>import and export links as Netscape bookmarks</li>
+</ul>
+<h3 id="accessibility">Accessibility</h3>
+<ul>
+<li>Firefox bookmarlet to share links in one click</li>
+<li>support for mobile browsers</li>
+<li>works with Javascript disabled</li>
+<li>easy page customization through HTML/CSS/RainTPL</li>
+</ul>
+<h3 id="security">Security</h3>
+<ul>
+<li>bruteforce-proof login form</li>
+<li>protected against <a href="http://en.wikipedia.org/wiki/Cross-site_request_forgery">XSRF</a>
+and session cookie hijacking</li>
+</ul>
+<h3 id="goodies">Goodies</h3>
+<ul>
+<li>thumbnail generation for images and video services:
+dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...<ul>
+<li>lazy-loading with <a href="http://dinbror.dk/blazy/">bLazy</a></li>
+</ul>
+</li>
+<li><a href="https://code.google.com/p/pubsubhubbub/">PubSubHubbub</a> protocol support</li>
+<li>URL cleanup: automatic removal of <code>?utm_source=...</code>, <code>fb=...</code></li>
+<li>discreet pop-up notification when a new release is available</li>
+</ul>
+<h3 id="rest-api">REST API</h3>
+<p>Easily extensible by any client using the REST API exposed by Shaarli.</p>
+<p>See the <a href="http://shaarli.github.io/api-documentation/">API documentation</a>.</p>
+<h3 id="other-usages">Other usages</h3>
+<p>Though Shaarli is primarily a bookmarking application, it can serve other purposes
+(see <a href="https://github.com/shaarli/Shaarli/wiki#usage-examples">usage examples</a>):
+- micro-blogging
+- pastebin
+- online notepad
+- snippet archive</p>
+<h2 id="about">About</h2>
+<h3 id="shaarli-community-fork">Shaarli community fork</h3>
+<p>This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli</p>
+<p>This is a community fork of the original <a href="https://github.com/sebsauvage/Shaarli/">Shaarli</a> project by <a href="http://sebsauvage.net/">Sébastien Sauvage</a>.</p>
+<p>The original project is currently unmaintained, and the developer <a href="https://github.com/sebsauvage/Shaarli/issues/191">has informed us</a>
+that he would have no time to work on Shaarli in the near future.
+The Shaarli community has carried on the work to provide
+<a href="https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master">many patches</a>
+for <a href="https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+">bug fixes and enhancements</a>
+in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.</p>
+<h3 id="contributing">Contributing</h3>
+<p>If you'd like to help, please:
+- have a look at the open <a href="https://github.com/shaarli/Shaarli/issues">issues</a>
+and <a href="https://github.com/shaarli/Shaarli/pulls">pull requests</a>
+- feel free to report bugs (feedback is much appreciated)
+- suggest new features and improvements to both code and <a href="https://github.com/shaarli/Shaarli/wiki">documentation</a>
+- propose solutions to existing problems
+- submit pull requests :-)</p>
+<h3 id="license">License</h3>
+<p>Shaarli is <a href="http://en.wikipedia.org/wiki/Free_software">Free Software</a>. See <a href="./COPYING">COPYING</a> for a detail of the contributors and licenses for each individual component.</p>
</div>
</div>
<!--
MkDocs version : 0.16.3
-Build Date UTC : 2017-06-18 04:31:25
+Build Date UTC : 2017-07-04 19:29:47
-->
projects / github / shaarli / Shaarli.git / blobdiff