diff options
Diffstat (limited to 'doc/md/index.md')
-rw-r--r-- | doc/md/index.md | 166 |
1 files changed, 79 insertions, 87 deletions
diff --git a/doc/md/index.md b/doc/md/index.md index e77b4d3a..220eeec1 100644 --- a/doc/md/index.md +++ b/doc/md/index.md | |||
@@ -1,19 +1,21 @@ | |||
1 | # [Shaarli](https://github.com/shaarli/Shaarli/) documentation | 1 | # <img src="images/icon.png" width="20px" height="20px"> Shaarli |
2 | 2 | ||
3 | Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. | 3 | The personal, minimalist, super-fast, database free, bookmarking service. |
4 | 4 | ||
5 | For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). | 5 | Do you want to share the links you discover? |
6 | Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server. | ||
7 | It is designed to be personal (single-user), fast and handy. | ||
6 | 8 | ||
7 | If 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). | 9 | <!-- TODO screenshots --> |
8 | If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). | ||
9 | 10 | ||
10 | If 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). | 11 | Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli. |
11 | 12 | ||
12 | _Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the `doc/html/` directory of your Shaarli installation._ | ||
13 | 13 | ||
14 | [![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli) | 14 | * [GitHub project page](https://github.com/shaarli/Shaarli) |
15 | [![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues) | 15 | * [Online documentation](https://shaarli.readthedocs.io/) |
16 | [![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) | 16 | * [Latest releases](https://github.com/shaarli/Shaarli/releases) |
17 | * [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md) | ||
18 | |||
17 | 19 | ||
18 | ### Demo | 20 | ### Demo |
19 | 21 | ||
@@ -26,104 +28,94 @@ Login: `demo`; Password: `demo` | |||
26 | 28 | ||
27 | Shaarli can be used: | 29 | Shaarli can be used: |
28 | 30 | ||
29 | - to share, comment and save interesting links and news. | 31 | - to share, comment and save interesting links and news |
30 | - to bookmark useful/frequent personal links (as private links) and share them between computers. | 32 | - to bookmark useful/frequent links and share them between computers |
31 | - as a minimal blog/microblog/writing platform (no character limit). | 33 | - as a minimal blog/microblog/writing platform |
32 | - as a read-it-later list (for example items tagged `readlater`). | 34 | - as a read-it-later list |
33 | - to draft and save articles/posts/ideas. | 35 | - to draft and save articles/posts/ideas |
34 | - to keep code snippets. | 36 | - to keep notes, documentation and code snippets |
35 | - to keep notes and documentation. | 37 | - as a shared clipboard/notepad/pastebin between machines |
36 | - as a shared clipboard/notepad/pastebin between machines. | 38 | - as a todo list |
37 | - as a todo list. | 39 | - to store media playlists |
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 extracts/comments from webpages that may disappear. |
40 | - to keep track of ongoing discussions (for example items tagged `discussion`). | 41 | - to keep track of ongoing discussions |
41 | - [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags. | 42 | - to feed other blogs, aggregators, social networks... using RSS feeds |
42 | - to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...). | 43 | |
44 | ### Edit, view and search your links | ||
43 | 45 | ||
44 | ### Interface | 46 | - Minimalist design |
45 | - minimalist design (simple is beautiful) | ||
46 | - FAST | 47 | - FAST |
47 | - ATOM and RSS feeds | 48 | - Customizable link titles and descriptions |
48 | - views: | 49 | - Tags to organize your links (features tag autocompletion, renaming, merging and deletion) |
49 | - paginated link list | 50 | - Search by tag or using the full-text search |
50 | - tag cloud | 51 | - Public and private links (visible only to logged-in users) |
51 | - picture wall: image and video thumbnails | 52 | - Unique permalinks for easy reference |
52 | - daily: newspaper-like daily digest | 53 | - Paginated link list (with image and video thumbnails) |
53 | - daily RSS feed | 54 | - Tag cloud and list views |
54 | - permalinks for easy reference | 55 | - Picture wall: image and video thumbnails view (with lazy loading) |
55 | - links can be public or private | 56 | - ATOM and RSS feeds (can also be filtered using tags or text search) |
56 | - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) | 57 | - Daily: newspaper-like daily digest (and daily RSS feed) |
57 | 58 | - URL cleanup: automatic removal of `?utm_source=...`, `fb=...` | |
58 | ### Tag, view and search your links! | 59 | - Extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) |
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 | 60 | ||
64 | ### Easy setup | 61 | ### Easy setup |
65 | - dead-simple installation: drop the files, open the page | 62 | |
66 | - links are stored in a file | 63 | - Dead-simple installation: drop the files, open the page |
67 | - compact storage | 64 | - Links are stored in a file (no database required, easy backup: simply copy the datastore file) |
68 | - no database required | 65 | - Import and export links as Netscape bookmarks compatible with most Web browsers |
69 | - easy backup: simply copy the datastore file | ||
70 | - import and export links as Netscape bookmarks | ||
71 | 66 | ||
72 | ### Accessibility | 67 | ### Accessibility |
73 | - Firefox bookmarlet to share links in one click | 68 | |
74 | - support for mobile browsers | 69 | - Bookmarklet and other tools to share links in one click |
75 | - works with Javascript disabled | 70 | - Support for mobile browsers |
76 | - easy page customization through HTML/CSS/RainTPL | 71 | - Degrades gracefully with Javascript disabled |
72 | - Easy page customization through HTML/CSS/RainTPL | ||
77 | 73 | ||
78 | ### Security | 74 | ### Security |
79 | - bruteforce-proof login form | ||
80 | - protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) | ||
81 | and session cookie hijacking | ||
82 | |||
83 | ### Goodies | ||
84 | - thumbnail generation for images and video services: | ||
85 | dailymotion, 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 | 75 | ||
91 | ### REST API | 76 | - Discreet pop-up notification when a new release is available |
77 | - Bruteforce protection on the login form | ||
78 | - Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking | ||
92 | 79 | ||
93 | Easily extensible by any client using the REST API exposed by Shaarli. | 80 | <!-- TODO Limitations --> |
94 | 81 | ||
95 | See the [API documentation](http://shaarli.github.io/api-documentation/). | 82 | ### REST API |
96 | 83 | ||
97 | ### Using Shaarli as a blog, notepad, pastebin... | 84 | - Easily extensible by any client using the REST API exposed by Shaarli ([API documentation](http://shaarli.github.io/api-documentation/)). |
98 | - Go to your Shaarli setup and log in | ||
99 | - Click the `Add Link` button | ||
100 | - To share text only, do not enter any URL in the corresponding input field and click `Add Link` | ||
101 | - Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` | ||
102 | - Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. | ||
103 | 85 | ||
104 | ## About | 86 | ## About |
87 | |||
105 | ### Shaarli community fork | 88 | ### Shaarli community fork |
106 | This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli | 89 | |
90 | This friendly fork is maintained by the Shaarli community at <https://github.com/shaarli/Shaarli> | ||
107 | 91 | ||
108 | This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). | 92 | This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). |
109 | 93 | ||
110 | The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) | 94 | The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) that he would have no time to work on Shaarli in the near future. |
111 | that he would have no time to work on Shaarli in the near future. | 95 | |
112 | The Shaarli community has carried on the work to provide | 96 | The Shaarli community has carried on the work to provide [many |
113 | [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) | 97 | patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for |
114 | for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) | 98 | [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) |
115 | in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. | 99 | in this repository, and will keep maintaining the project for the foreseeable |
100 | future, while keeping Shaarli simple and efficient. | ||
101 | |||
116 | 102 | ||
117 | ### Contributing | 103 | ### Contributing and getting help |
118 | If you'd like to help, please: | 104 | |
119 | - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) | 105 | Feedback is very appreciated! |
120 | and [pull requests](https://github.com/shaarli/Shaarli/pulls) | 106 | |
121 | - feel free to report bugs (feedback is much appreciated) | 107 | - If 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). |
122 | - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki) | 108 | - Have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls) |
123 | - propose solutions to existing problems | 109 | - If 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). |
124 | - submit pull requests :-) | 110 | - If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). |
111 | - Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-) | ||
125 | 112 | ||
126 | 113 | ||
127 | ### License | 114 | ### License |
128 | Shaarli 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. | 115 | |
116 | Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See | ||
117 | [COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail | ||
118 | of the contributors and licenses for each individual component. A list of | ||
119 | contributors is available | ||
120 | [here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS). | ||
129 | 121 | ||