diff options
Diffstat (limited to 'doc/md/index.md')
-rw-r--r-- | doc/md/index.md | 120 |
1 files changed, 54 insertions, 66 deletions
diff --git a/doc/md/index.md b/doc/md/index.md index 220eeec1..2c4995f8 100644 --- a/doc/md/index.md +++ b/doc/md/index.md | |||
@@ -2,113 +2,101 @@ | |||
2 | 2 | ||
3 | The personal, minimalist, super-fast, database free, bookmarking service. | 3 | The personal, minimalist, super-fast, database free, bookmarking service. |
4 | 4 | ||
5 | Do you want to share the links you discover? | 5 | Do you want to share the links you discover? Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server. It is designed to be personal (single-user), fast and handy. |
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. | ||
8 | |||
9 | <!-- TODO screenshots --> | ||
10 | 6 | ||
11 | Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli. | 7 | Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli. |
12 | 8 | ||
13 | |||
14 | * [GitHub project page](https://github.com/shaarli/Shaarli) | 9 | * [GitHub project page](https://github.com/shaarli/Shaarli) |
15 | * [Online documentation](https://shaarli.readthedocs.io/) | 10 | * [Documentation](https://shaarli.readthedocs.io/) |
16 | * [Latest releases](https://github.com/shaarli/Shaarli/releases) | ||
17 | * [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md) | 11 | * [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md) |
18 | 12 | ||
19 | 13 | ||
20 | ### Demo | 14 | [![](https://i.imgur.com/8wEBRSG.png)](https://i.imgur.com/WWPfSj0.png) [![](https://i.imgur.com/93PpLLs.png)](https://i.imgur.com/V09kAQt.png) [![](https://i.imgur.com/rrsjWYy.png)](https://i.imgur.com/TZzGHMs.png) [![](https://i.imgur.com/8iRzHfe.png)](https://i.imgur.com/sfJJ6NT.png) [![](https://i.imgur.com/GjZGvIh.png)](https://i.imgur.com/QsedIuJ.png) [![](https://i.imgur.com/TFZ9PEq.png)](https://i.imgur.com/KdtF8Ll.png) [![](https://i.imgur.com/uICDOle.png)](https://i.imgur.com/27wYsbC.png) [![](https://i.imgur.com/tVvD3gH.png)](https://i.imgur.com/zGF4d6L.jpg) |
15 | |||
16 | |||
17 | |||
18 | ## Demo | ||
21 | 19 | ||
22 | You can use this [public demo instance of Shaarli](https://demo.shaarli.org). | 20 | You can use this [public demo instance of Shaarli](https://demo.shaarli.org). |
23 | It runs the latest development version of Shaarli and is updated/reset daily. | 21 | It runs the latest development version of Shaarli and is updated/reset daily. |
24 | 22 | ||
25 | Login: `demo`; Password: `demo` | 23 | Login: `demo`; Password: `demo` |
26 | 24 | ||
25 | |||
26 | ## Getting started | ||
27 | |||
28 | - [Configure your server](Server-configuration.md) | ||
29 | - [Install Shaarli](Installation.md) | ||
30 | - Or install Shaarli using [Docker](Docker.md) | ||
31 | |||
32 | |||
27 | ## Features | 33 | ## Features |
28 | 34 | ||
29 | Shaarli can be used: | 35 | Shaarli can be used: |
30 | 36 | ||
31 | - to share, comment and save interesting links and news | 37 | - to share, comment and save interesting links |
32 | - to bookmark useful/frequent links and share them between computers | 38 | - to bookmark useful/frequent links and share them between computers |
33 | - as a minimal blog/microblog/writing platform | 39 | - as a minimal blog/microblog/writing platform |
34 | - as a read-it-later list | 40 | - as a read-it-later/todo list |
35 | - to draft and save articles/posts/ideas | 41 | - as a notepad to draft and save articles/posts/ideas |
36 | - to keep notes, documentation and code snippets | 42 | - as a knowledge base to keep notes, documentation and code snippets |
37 | - as a shared clipboard/notepad/pastebin between machines | 43 | - as a shared clipboard/notepad/pastebin between computers |
38 | - as a todo list | 44 | - as playlist manager for online media |
39 | - to store media playlists | 45 | - to feed other blogs, aggregators, social networks... |
40 | - to keep extracts/comments from webpages that may disappear. | ||
41 | - to keep track of ongoing discussions | ||
42 | - to feed other blogs, aggregators, social networks... using RSS feeds | ||
43 | 46 | ||
44 | ### Edit, view and search your links | 47 | ### Edit, view and search your links |
45 | 48 | ||
46 | - Minimalist design | 49 | - Editable URL, title, description, tags, private/public status for all your [Shaares](Usage.md) |
47 | - FAST | 50 | - [Tags](Usage.md#tags) to organize your Shaares |
48 | - Customizable link titles and descriptions | 51 | - [Search](Usage.md#search) in all fields |
49 | - Tags to organize your links (features tag autocompletion, renaming, merging and deletion) | 52 | - Unique [permalinks](Usage.md#permalinks) for easy reference |
50 | - Search by tag or using the full-text search | 53 | - Paginated Shaares list view (with image and video thumbnails) |
51 | - Public and private links (visible only to logged-in users) | 54 | - [Tag cloud/list](Usage#tag-cloud) views |
52 | - Unique permalinks for easy reference | 55 | - [Picture wall](Usage#picture-wall)/thumbnails view (with lazy loading) |
53 | - Paginated link list (with image and video thumbnails) | 56 | - [ATOM and RSS feeds](Usage.md#rss-feeds) (can also be filtered using tags or text search) |
54 | - Tag cloud and list views | 57 | - [Daily](Usage.md#daily): newspaper-like daily digest (and daily RSS feed) |
55 | - Picture wall: image and video thumbnails view (with lazy loading) | 58 | - URL cleanup: automatic removal of `?utm_source=...`, `fb=...` tracking parameters |
56 | - ATOM and RSS feeds (can also be filtered using tags or text search) | 59 | - Extensible through [plugins](Plugins.md) |
57 | - Daily: newspaper-like daily digest (and daily RSS feed) | 60 | - Easily extensible by any client using the [REST API](REST-API.md) exposed by Shaarli |
58 | - URL cleanup: automatic removal of `?utm_source=...`, `fb=...` | 61 | - Bookmarklet and [other tools](Community-and-related-software.md) to share links in one click |
59 | - Extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) | 62 | - Responsive/support for mobile browsers, degrades gracefully with Javascript disabled |
63 | |||
60 | 64 | ||
61 | ### Easy setup | 65 | ### Easy setup |
62 | 66 | ||
63 | - Dead-simple installation: drop the files, open the page | 67 | - Dead-simple [installation](Installation.md): drop the files on your server, open the page |
64 | - Links are stored in a file (no database required, easy backup: simply copy the datastore file) | 68 | - Shaares are stored in a file (no database required, easy [backup](Backup-and-restore.md)) |
65 | - Import and export links as Netscape bookmarks compatible with most Web browsers | 69 | - [Configurable](Shaarli-configuration.md) from dialog and configuration file |
70 | - Extensible through third-party [plugins and themes](Community-and-related-software.md) | ||
66 | 71 | ||
67 | ### Accessibility | ||
68 | 72 | ||
69 | - Bookmarklet and other tools to share links in one click | 73 | ### Fast |
70 | - Support for mobile browsers | ||
71 | - Degrades gracefully with Javascript disabled | ||
72 | - Easy page customization through HTML/CSS/RainTPL | ||
73 | 74 | ||
74 | ### Security | 75 | - Fast! Small datastore file, write-once/read-many, served most of the time from OS disk caches (no disk I/O) |
76 | - Stays fast with even tens of thousands shaares! | ||
75 | 77 | ||
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 | ||
79 | 78 | ||
80 | <!-- TODO Limitations --> | 79 | ### Self-hosted |
81 | 80 | ||
82 | ### REST API | 81 | - Shaarli is an alternative to commercial services such as StumbleUpon, Delicio.us, Diigo... |
82 | - The data is yours, [import and export](Usage#import-export) it to HTML bookmarksformat compatible with most web browser, and from a variety of formats | ||
83 | - Shaarli does not send any telemetry/metrics/private information to developers | ||
84 | - Shaarli is Free and Open-Source software, inspect and change how the program works in the [source code](https://github.com/shaarli/Shaarli) | ||
85 | - Built-in [Security](dev/Development.md#security) features to help you protect your Shaarli instance | ||
83 | 86 | ||
84 | - Easily extensible by any client using the REST API exposed by Shaarli ([API documentation](http://shaarli.github.io/api-documentation/)). | ||
85 | 87 | ||
86 | ## About | 88 | ## About |
87 | 89 | ||
88 | ### Shaarli community fork | 90 | This [community fork](https://github.com/shaarli/Shaarli) of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/) (now [unmaintained](https://github.com/sebsauvage/Shaarli/issues/191)) has carried on the work to provide [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. |
89 | |||
90 | This friendly fork is maintained by the Shaarli community at <https://github.com/shaarli/Shaarli> | ||
91 | |||
92 | This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). | ||
93 | |||
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. | ||
95 | 91 | ||
96 | The Shaarli community has carried on the work to provide [many | 92 | The original Shaarli instance is still available [here](https://sebsauvage.net/links/) (+25000 shaares!) |
97 | patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for | ||
98 | [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) | ||
99 | in this repository, and will keep maintaining the project for the foreseeable | ||
100 | future, while keeping Shaarli simple and efficient. | ||
101 | 93 | ||
102 | 94 | ||
103 | ### Contributing and getting help | 95 | ### Contributing and getting help |
104 | 96 | ||
105 | Feedback is very appreciated! | 97 | Feedback is very appreciated! Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-) |
106 | 98 | ||
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). | 99 | See [Support](Troubleshooting.md#support) to get in touch with the Shaarli community. |
108 | - Have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls) | ||
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). | ||
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 :-) | ||
112 | 100 | ||
113 | 101 | ||
114 | ### License | 102 | ### License |