]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - doc/md/index.md
Merge pull request #1151 from kramred/master
[github/shaarli/Shaarli.git] / doc / md / index.md
CommitLineData
12e18779 1# [Shaarli](https://github.com/shaarli/Shaarli/) documentation
1acc87ee 2
992af0b9 3Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
1acc87ee 4
53ed6d7d 5For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).
1acc87ee 6
12e18779 7If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) or read the current [issues](https://github.com/shaarli/Shaarli/issues).
8If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
1acc87ee 9
53ed6d7d 10If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin).
1acc87ee 11
12e18779 12_Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the `doc/html/` directory of your Shaarli installation._
13
14[![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli)
15[![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues)
16[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
17
18### Demo
19
20You can use this [public demo instance of Shaarli](https://demo.shaarli.org).
21It runs the latest development version of Shaarli and is updated/reset daily.
22
23Login: `demo`; Password: `demo`
24
12e18779 25## Features
26
4ada0d31 27Shaarli can be used:
28
29- to share, comment and save interesting links and news.
30- to bookmark useful/frequent personal links (as private links) and share them between computers.
31- as a minimal blog/microblog/writing platform (no character limit).
32- as a read-it-later list (for example items tagged `readlater`).
33- to draft and save articles/posts/ideas.
34- to keep code snippets.
35- to keep notes and documentation.
36- as a shared clipboard/notepad/pastebin between machines.
37- as a todo list.
38- to store playlists (e.g. with the `music` or `video` tags).
39- to keep extracts/comments from webpages that may disappear.
40- to keep track of ongoing discussions (for example items tagged `discussion`).
41- [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags.
42- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...).
43
12e18779 44### Interface
45- minimalist design (simple is beautiful)
46- FAST
47- ATOM and RSS feeds
48- views:
49 - paginated link list
50 - tag cloud
51 - picture wall: image and video thumbnails
52 - daily: newspaper-like daily digest
53 - daily RSS feed
54- permalinks for easy reference
55- links can be public or private
cc8f572b 56- extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)
12e18779 57
58### Tag, view and search your links!
59- add a custom title and description to archived links
60- add tags to classify and search links
61 - features tag autocompletion, renaming, merging and deletion
62- full-text and tag search
63
64### Easy setup
65- dead-simple installation: drop the files, open the page
66- links are stored in a file
67 - compact storage
68 - no database required
69 - easy backup: simply copy the datastore file
70- import and export links as Netscape bookmarks
71
72### Accessibility
73- Firefox bookmarlet to share links in one click
74- support for mobile browsers
75- works with Javascript disabled
76- easy page customization through HTML/CSS/RainTPL
77
78### Security
79- bruteforce-proof login form
80- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
81and session cookie hijacking
82
83### Goodies
84- thumbnail generation for images and video services:
85dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
86 - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
87- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
88- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
89- discreet pop-up notification when a new release is available
90
91### REST API
92
93Easily extensible by any client using the REST API exposed by Shaarli.
94
95See the [API documentation](http://shaarli.github.io/api-documentation/).
96
12e18779 97## About
98### Shaarli community fork
99This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
100
101This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
102
103The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191)
104that he would have no time to work on Shaarli in the near future.
105The Shaarli community has carried on the work to provide
106[many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master)
107for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
108in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
109
110### Contributing
111If you'd like to help, please:
112- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
113and [pull requests](https://github.com/shaarli/Shaarli/pulls)
114- feel free to report bugs (feedback is much appreciated)
115- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
116- propose solutions to existing problems
117- submit pull requests :-)
118
119
120### License
121Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See [COPYING](COPYING) for a detail of the contributors and licenses for each individual component.
122