aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-06-18 22:15:50 +0200
committernodiscc <nodiscc@gmail.com>2017-06-18 22:15:50 +0200
commit12e1877917dc6c29cd93bce7781e26c9f4415c16 (patch)
treeed2cb517b8b1fd04f29d41dbc4fd9adb10a6538e /doc/md
parent0433c688b9be6097b85a8fec31b3dacd0ab81677 (diff)
downloadShaarli-12e1877917dc6c29cd93bce7781e26c9f4415c16.tar.gz
Shaarli-12e1877917dc6c29cd93bce7781e26c9f4415c16.tar.zst
Shaarli-12e1877917dc6c29cd93bce7781e26c9f4415c16.zip
move README contents to doc/md/index.md
Diffstat (limited to 'doc/md')
-rw-r--r--doc/md/index.md109
1 files changed, 106 insertions, 3 deletions
diff --git a/doc/md/index.md b/doc/md/index.md
index 37a9c1fc..1106334b 100644
--- a/doc/md/index.md
+++ b/doc/md/index.md
@@ -1,11 +1,114 @@
1Welcome to the [Shaarli](https://github.com/shaarli/Shaarli/) wiki! 1# [Shaarli](https://github.com/shaarli/Shaarli/) documentation
2 2
3Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. 3Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
4 4
5For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). 5For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).
6 6
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) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). 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).
8 9
9If 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). 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).
10 11
11_Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ 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
25
26## Features
27
28### Interface
29- minimalist design (simple is beautiful)
30- FAST
31- ATOM and RSS feeds
32- views:
33 - paginated link list
34 - tag cloud
35 - picture wall: image and video thumbnails
36 - daily: newspaper-like daily digest
37 - daily RSS feed
38- permalinks for easy reference
39- links can be public or private
40- extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage)
41
42### Tag, view and search your links!
43- add a custom title and description to archived links
44- add tags to classify and search links
45 - features tag autocompletion, renaming, merging and deletion
46- full-text and tag search
47
48### Easy setup
49- dead-simple installation: drop the files, open the page
50- links are stored in a file
51 - compact storage
52 - no database required
53 - easy backup: simply copy the datastore file
54- import and export links as Netscape bookmarks
55
56### Accessibility
57- Firefox bookmarlet to share links in one click
58- support for mobile browsers
59- works with Javascript disabled
60- easy page customization through HTML/CSS/RainTPL
61
62### Security
63- bruteforce-proof login form
64- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
65and session cookie hijacking
66
67### Goodies
68- thumbnail generation for images and video services:
69dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
70 - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
71- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
72- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
73- discreet pop-up notification when a new release is available
74
75### REST API
76
77Easily extensible by any client using the REST API exposed by Shaarli.
78
79See the [API documentation](http://shaarli.github.io/api-documentation/).
80
81### Other usages
82Though Shaarli is primarily a bookmarking application, it can serve other purposes
83(see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)):
84- micro-blogging
85- pastebin
86- online notepad
87- snippet archive
88
89## About
90### Shaarli community fork
91This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
92
93This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
94
95The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191)
96that he would have no time to work on Shaarli in the near future.
97The Shaarli community has carried on the work to provide
98[many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master)
99for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
100in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
101
102### Contributing
103If you'd like to help, please:
104- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
105and [pull requests](https://github.com/shaarli/Shaarli/pulls)
106- feel free to report bugs (feedback is much appreciated)
107- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
108- propose solutions to existing problems
109- submit pull requests :-)
110
111
112### License
113Shaarli 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.
114