diff options
author | ArthurHoaro <arthur@hoa.ro> | 2018-07-28 11:07:55 +0200 |
---|---|---|
committer | ArthurHoaro <arthur@hoa.ro> | 2018-07-28 11:07:55 +0200 |
commit | 83faedadff76c5bdca036f39f13943f63b27e164 (patch) | |
tree | 6f44cede16ec6a60f10b9699e211e0818f06d2c8 /doc/md/index.md | |
parent | 1d9eb22a3df85b67fe6652c0876cd7382c2fb525 (diff) | |
parent | 658988f3aeba7a5a938783249ccf2765251e5597 (diff) | |
download | Shaarli-83faedadff76c5bdca036f39f13943f63b27e164.tar.gz Shaarli-83faedadff76c5bdca036f39f13943f63b27e164.tar.zst Shaarli-83faedadff76c5bdca036f39f13943f63b27e164.zip |
Merge tag 'v0.9.7' into stable
Release v0.9.7
Diffstat (limited to 'doc/md/index.md')
-rw-r--r-- | doc/md/index.md | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/doc/md/index.md b/doc/md/index.md new file mode 100644 index 00000000..e77b4d3a --- /dev/null +++ b/doc/md/index.md | |||
@@ -0,0 +1,129 @@ | |||
1 | # [Shaarli](https://github.com/shaarli/Shaarli/) documentation | ||
2 | |||
3 | Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. | ||
4 | |||
5 | For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). | ||
6 | |||
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). | ||
8 | If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). | ||
9 | |||
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 | |||
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 | |||
20 | You can use this [public demo instance of Shaarli](https://demo.shaarli.org). | ||
21 | It runs the latest development version of Shaarli and is updated/reset daily. | ||
22 | |||
23 | Login: `demo`; Password: `demo` | ||
24 | |||
25 | ## Features | ||
26 | |||
27 | Shaarli 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 | |||
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 | ||
56 | - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) | ||
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) | ||
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 | |||
91 | ### REST API | ||
92 | |||
93 | Easily extensible by any client using the REST API exposed by Shaarli. | ||
94 | |||
95 | See the [API documentation](http://shaarli.github.io/api-documentation/). | ||
96 | |||
97 | ### Using Shaarli as a blog, notepad, pastebin... | ||
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 | |||
104 | ## About | ||
105 | ### Shaarli community fork | ||
106 | This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli | ||
107 | |||
108 | This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [SĂ©bastien Sauvage](http://sebsauvage.net/). | ||
109 | |||
110 | The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) | ||
111 | that he would have no time to work on Shaarli in the near future. | ||
112 | The Shaarli community has carried on the work to provide | ||
113 | [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) | ||
114 | for [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. | ||
116 | |||
117 | ### Contributing | ||
118 | If you'd like to help, please: | ||
119 | - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) | ||
120 | and [pull requests](https://github.com/shaarli/Shaarli/pulls) | ||
121 | - feel free to report bugs (feedback is much appreciated) | ||
122 | - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki) | ||
123 | - propose solutions to existing problems | ||
124 | - submit pull requests :-) | ||
125 | |||
126 | |||
127 | ### 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. | ||
129 | |||