aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/index.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2018-08-30 20:37:52 +0200
committernodiscc <nodiscc@gmail.com>2018-08-30 21:09:02 +0200
commitb817fb0d95f576a33d6582aa6e9b51f85e0ef345 (patch)
tree5add696339107c65cc2c83325b1f23714c62deb8 /doc/md/index.md
parentf28b73b21f705102f8536cd16ea28122aa870e49 (diff)
downloadShaarli-b817fb0d95f576a33d6582aa6e9b51f85e0ef345.tar.gz
Shaarli-b817fb0d95f576a33d6582aa6e9b51f85e0ef345.tar.zst
Shaarli-b817fb0d95f576a33d6582aa6e9b51f85e0ef345.zip
documentation: refactor documentation homepage
- simplify/organize feature list and contributing section - move bug reporting/contact information to Contributing section - unclutter Ref https://github.com/shaarli/Shaarli/issues/1148#issuecomment-397871451 and https://github.com/shaarli/Shaarli/issues/598
Diffstat (limited to 'doc/md/index.md')
-rw-r--r--doc/md/index.md120
1 files changed, 48 insertions, 72 deletions
diff --git a/doc/md/index.md b/doc/md/index.md
index c18332b4..725d33ac 100644
--- a/doc/md/index.md
+++ b/doc/md/index.md
@@ -1,25 +1,19 @@
1# [Shaarli](https://github.com/shaarli/Shaarli/) documentation 1# <img src="../../assets/default/img/favicon.png" width="20px" height="20px"> Shaarli
2 2
3The personal, minimalist, super-fast, database free, bookmarking service. 3The personal, minimalist, super-fast, database free, bookmarking service.
4 4
5Do you want to share the links you discover? 5Do you want to share the links you discover?
6Shaarli is a minimalist link sharing service that you can install on your own server. 6Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server.
7It is designed to be personal (single-user), fast and handy. 7It is designed to be personal (single-user), fast and handy.
8 8
9<!-- TODO screenshots --> 9<!-- TODO screenshots -->
10 10
11Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. 11Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli.
12For general information, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).
13 12
14If 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).
15
16If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
17
18If 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).
19 13
20* [GitHub project page](https://github.com/shaarli/Shaarli) 14* [GitHub project page](https://github.com/shaarli/Shaarli)
21* [Online documentation](https://shaarli.readthedocs.io/) (this page) 15* [Online documentation](https://shaarli.readthedocs.io/)
22* [Latest Shaarli releases](https://github.com/shaarli/Shaarli/releases) 16* [Latest releases](https://github.com/shaarli/Shaarli/releases)
23* [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md) 17* [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md)
24 18
25 19
@@ -30,87 +24,70 @@ It runs the latest development version of Shaarli and is updated/reset daily.
30 24
31Login: `demo`; Password: `demo` 25Login: `demo`; Password: `demo`
32 26
33<!-- TODO review everything below this point -->
34
35
36## Features 27## Features
37 28
38Shaarli can be used: 29Shaarli can be used:
39 30
40- to share, comment and save interesting links and news. 31- to share, comment and save interesting links and news
41- 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
42- as a minimal blog/microblog/writing platform (no character limit). 33- as a minimal blog/microblog/writing platform
43- as a read-it-later list (for example items tagged `readlater`). 34- as a read-it-later list
44- to draft and save articles/posts/ideas. 35- to draft and save articles/posts/ideas
45- to keep code snippets. 36- to keep notes, documentation and code snippets
46- to keep notes and documentation. 37- as a shared clipboard/notepad/pastebin between machines
47- as a shared clipboard/notepad/pastebin between machines. 38- as a todo list
48- as a todo list. 39- to store media playlists
49- to store playlists (e.g. with the `music` or `video` tags).
50- to keep extracts/comments from webpages that may disappear. 40- to keep extracts/comments from webpages that may disappear.
51- to keep track of ongoing discussions (for example items tagged `discussion`). 41- to keep track of ongoing discussions
52- [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags. 42- to feed other blogs, aggregators, social networks... using RSS feeds
53- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...).
54 43
55### Interface 44### Edit, view and search your links
56 45
57- minimalist design (simple is beautiful) 46- Minimalist design
58- FAST 47- FAST
59- ATOM and RSS feeds 48- Customizable link titles and descriptions
60- views: 49- Tags to organize your links (features tag autocompletion, renaming, merging and deletion)
61 - paginated link list (with image and video thumbnails) 50- Search by tag or using the full-text search
62 - tag cloud 51- Public and private links (visible only to logged-in users)
63 - picture wall: image and video thumbnails (with lazy loading) 52- Unique permalinks for easy reference
64 - daily: newspaper-like daily digest 53- Paginated link list (with image and video thumbnails)
65 - daily RSS feed 54- Tag cloud and list views
66- permalinks for easy reference 55- Picture wall: image and video thumbnails view (with lazy loading)
67- links can be public or private 56- ATOM and RSS feeds (can also be filtered using tags or text search)
68- thumbnail generation for images and video services 57- Daily: newspaper-like daily digest (and daily RSS feed)
69- URL cleanup: automatic removal of `?utm_source=...`, `fb=...` 58- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
70- extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) 59- Extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)
71
72### Tag, view and search your links
73
74- add a custom title and description to archived links
75- add tags to classify and search links
76 - features tag autocompletion, renaming, merging and deletion
77- full-text and tag search
78 60
79### Easy setup 61### Easy setup
80 62
81- dead-simple installation: drop the files, open the page 63- Dead-simple installation: drop the files, open the page
82- links are stored in a file 64- Links are stored in a file (no database required, easy backup: simply copy the datastore file)
83 - compact storage 65- Import and export links as Netscape bookmarks compatible with most Web browsers
84 - no database required
85 - easy backup: simply copy the datastore file
86- import and export links as Netscape bookmarks
87 66
88### Accessibility 67### Accessibility
89 68
90- bookmarlet to share links in one click 69- Bookmarklet and other tools to share links in one click
91- support for mobile browsers 70- Support for mobile browsers
92- degrades gracefully with Javascript disabled 71- Degrades gracefully with Javascript disabled
93- easy page customization through HTML/CSS/RainTPL 72- Easy page customization through HTML/CSS/RainTPL
94 73
95### Security 74### Security
96 75
97- discreet pop-up notification when a new release is available 76- Discreet pop-up notification when a new release is available
98- bruteforce protection on the login form 77- Bruteforce protection on the login form
99- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking 78- Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking
100 79
101<!-- TODO Limitations --> 80<!-- TODO Limitations -->
102 81
103### REST API 82### REST API
104 83
105Easily extensible by any client using the REST API exposed by Shaarli. 84- Easily extensible by any client using the REST API exposed by Shaarli ([API documentation](http://shaarli.github.io/api-documentation/)).
106
107See the [API documentation](http://shaarli.github.io/api-documentation/).
108 85
109## About 86## About
110 87
111### Shaarli community fork 88### Shaarli community fork
112 89
113This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli 90This friendly fork is maintained by the Shaarli community at <https://github.com/shaarli/Shaarli>
114 91
115This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). 92This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
116 93
@@ -123,16 +100,15 @@ in this repository, and will keep maintaining the project for the foreseeable
123future, while keeping Shaarli simple and efficient. 100future, while keeping Shaarli simple and efficient.
124 101
125 102
126### Contributing 103### Contributing and getting help
127 104
128If you'd like to help, please: 105Feedback is very appreciated!
129 106
130- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) 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).
131and [pull requests](https://github.com/shaarli/Shaarli/pulls) 108- Have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls)
132- feel free to report bugs (feedback is much appreciated) 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).
133- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/tree/master/doc/md/) 110- If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
134- propose solutions to existing problems 111- Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-)
135- submit pull requests :-)
136 112
137 113
138### License 114### License