diff options
Diffstat (limited to 'doc/html/index.html')
-rw-r--r-- | doc/html/index.html | 121 |
1 files changed, 117 insertions, 4 deletions
diff --git a/doc/html/index.html b/doc/html/index.html index e6d4ef78..93f4ba5d 100644 --- a/doc/html/index.html +++ b/doc/html/index.html | |||
@@ -53,6 +53,19 @@ | |||
53 | <a class="current" href=".">Home</a> | 53 | <a class="current" href=".">Home</a> |
54 | <ul class="subnav"> | 54 | <ul class="subnav"> |
55 | 55 | ||
56 | <li class="toctree-l2"><a href="#shaarli-documentation">Shaarli documentation</a></li> | ||
57 | |||
58 | <ul> | ||
59 | |||
60 | <li><a class="toctree-l3" href="#demo">Demo</a></li> | ||
61 | |||
62 | <li><a class="toctree-l3" href="#features">Features</a></li> | ||
63 | |||
64 | <li><a class="toctree-l3" href="#about">About</a></li> | ||
65 | |||
66 | </ul> | ||
67 | |||
68 | |||
56 | </ul> | 69 | </ul> |
57 | </li> | 70 | </li> |
58 | 71 | ||
@@ -274,12 +287,112 @@ | |||
274 | <div role="main"> | 287 | <div role="main"> |
275 | <div class="section"> | 288 | <div class="section"> |
276 | 289 | ||
277 | <p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki!</p> | 290 | <h1 id="shaarli-documentation"><a href="https://github.com/shaarli/Shaarli/">Shaarli</a> documentation</h1> |
278 | <p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p> | 291 | <p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p> |
279 | <p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p> | 292 | <p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p> |
280 | <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> | 293 | <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>. |
294 | If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p> | ||
281 | <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> | 295 | <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> |
282 | <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> | 296 | <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> |
297 | <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> | ||
298 | <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> | ||
299 | <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> | ||
300 | <h3 id="demo">Demo</h3> | ||
301 | <p>You can use this <a href="https://demo.shaarli.org">public demo instance of Shaarli</a>. | ||
302 | It runs the latest development version of Shaarli and is updated/reset daily.</p> | ||
303 | <p>Login: <code>demo</code>; Password: <code>demo</code></p> | ||
304 | <h2 id="features">Features</h2> | ||
305 | <h3 id="interface">Interface</h3> | ||
306 | <ul> | ||
307 | <li>minimalist design (simple is beautiful)</li> | ||
308 | <li>FAST</li> | ||
309 | <li>ATOM and RSS feeds</li> | ||
310 | <li>views:<ul> | ||
311 | <li>paginated link list</li> | ||
312 | <li>tag cloud</li> | ||
313 | <li>picture wall: image and video thumbnails</li> | ||
314 | <li>daily: newspaper-like daily digest</li> | ||
315 | <li>daily RSS feed</li> | ||
316 | </ul> | ||
317 | </li> | ||
318 | <li>permalinks for easy reference</li> | ||
319 | <li>links can be public or private</li> | ||
320 | <li>extensible through <a href="https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage">plugins</a></li> | ||
321 | </ul> | ||
322 | <h3 id="tag-view-and-search-your-links">Tag, view and search your links!</h3> | ||
323 | <ul> | ||
324 | <li>add a custom title and description to archived links</li> | ||
325 | <li>add tags to classify and search links<ul> | ||
326 | <li>features tag autocompletion, renaming, merging and deletion</li> | ||
327 | </ul> | ||
328 | </li> | ||
329 | <li>full-text and tag search</li> | ||
330 | </ul> | ||
331 | <h3 id="easy-setup">Easy setup</h3> | ||
332 | <ul> | ||
333 | <li>dead-simple installation: drop the files, open the page</li> | ||
334 | <li>links are stored in a file<ul> | ||
335 | <li>compact storage</li> | ||
336 | <li>no database required</li> | ||
337 | <li>easy backup: simply copy the datastore file</li> | ||
338 | </ul> | ||
339 | </li> | ||
340 | <li>import and export links as Netscape bookmarks</li> | ||
341 | </ul> | ||
342 | <h3 id="accessibility">Accessibility</h3> | ||
343 | <ul> | ||
344 | <li>Firefox bookmarlet to share links in one click</li> | ||
345 | <li>support for mobile browsers</li> | ||
346 | <li>works with Javascript disabled</li> | ||
347 | <li>easy page customization through HTML/CSS/RainTPL</li> | ||
348 | </ul> | ||
349 | <h3 id="security">Security</h3> | ||
350 | <ul> | ||
351 | <li>bruteforce-proof login form</li> | ||
352 | <li>protected against <a href="http://en.wikipedia.org/wiki/Cross-site_request_forgery">XSRF</a> | ||
353 | and session cookie hijacking</li> | ||
354 | </ul> | ||
355 | <h3 id="goodies">Goodies</h3> | ||
356 | <ul> | ||
357 | <li>thumbnail generation for images and video services: | ||
358 | dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...<ul> | ||
359 | <li>lazy-loading with <a href="http://dinbror.dk/blazy/">bLazy</a></li> | ||
360 | </ul> | ||
361 | </li> | ||
362 | <li><a href="https://code.google.com/p/pubsubhubbub/">PubSubHubbub</a> protocol support</li> | ||
363 | <li>URL cleanup: automatic removal of <code>?utm_source=...</code>, <code>fb=...</code></li> | ||
364 | <li>discreet pop-up notification when a new release is available</li> | ||
365 | </ul> | ||
366 | <h3 id="rest-api">REST API</h3> | ||
367 | <p>Easily extensible by any client using the REST API exposed by Shaarli.</p> | ||
368 | <p>See the <a href="http://shaarli.github.io/api-documentation/">API documentation</a>.</p> | ||
369 | <h3 id="other-usages">Other usages</h3> | ||
370 | <p>Though Shaarli is primarily a bookmarking application, it can serve other purposes | ||
371 | (see <a href="https://github.com/shaarli/Shaarli/wiki#usage-examples">usage examples</a>): | ||
372 | - micro-blogging | ||
373 | - pastebin | ||
374 | - online notepad | ||
375 | - snippet archive</p> | ||
376 | <h2 id="about">About</h2> | ||
377 | <h3 id="shaarli-community-fork">Shaarli community fork</h3> | ||
378 | <p>This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli</p> | ||
379 | <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> | ||
380 | <p>The original project is currently unmaintained, and the developer <a href="https://github.com/sebsauvage/Shaarli/issues/191">has informed us</a> | ||
381 | that he would have no time to work on Shaarli in the near future. | ||
382 | The Shaarli community has carried on the work to provide | ||
383 | <a href="https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master">many patches</a> | ||
384 | for <a href="https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+">bug fixes and enhancements</a> | ||
385 | in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.</p> | ||
386 | <h3 id="contributing">Contributing</h3> | ||
387 | <p>If you'd like to help, please: | ||
388 | - have a look at the open <a href="https://github.com/shaarli/Shaarli/issues">issues</a> | ||
389 | and <a href="https://github.com/shaarli/Shaarli/pulls">pull requests</a> | ||
390 | - feel free to report bugs (feedback is much appreciated) | ||
391 | - suggest new features and improvements to both code and <a href="https://github.com/shaarli/Shaarli/wiki">documentation</a> | ||
392 | - propose solutions to existing problems | ||
393 | - submit pull requests :-)</p> | ||
394 | <h3 id="license">License</h3> | ||
395 | <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> | ||
283 | 396 | ||
284 | </div> | 397 | </div> |
285 | </div> | 398 | </div> |
@@ -328,5 +441,5 @@ | |||
328 | 441 | ||
329 | <!-- | 442 | <!-- |
330 | MkDocs version : 0.16.3 | 443 | MkDocs version : 0.16.3 |
331 | Build Date UTC : 2017-06-18 04:31:25 | 444 | Build Date UTC : 2017-07-04 19:29:47 |
332 | --> | 445 | --> |