Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

documentation: refactor documentation homepage

Browse source 
- 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
This commit is contained in:
nodiscc 2018-08-30 20:37:52 +02:00
parent f28b73b21f
commit b817fb0d95
1 changed files with 48 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

120
doc/md/index.md
View file

@ -1,25 +1,19 @@
# [Shaarli](https://github.com/shaarli/Shaarli/) documentation # <img src="../../assets/default/img/favicon.png" width="20px" height="20px"> Shaarli
The personal, minimalist, super-fast, database free, bookmarking service. The personal, minimalist, super-fast, database free, bookmarking service.
Do you want to share the links you discover? Do you want to share the links you discover?
Shaarli is a minimalist link sharing service that you can install on your own server. 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. It is designed to be personal (single-user), fast and handy.
<!-- TODO screenshots --> <!-- TODO screenshots -->
Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli.
For general information, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).
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).
If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
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).
* [GitHub project page](https://github.com/shaarli/Shaarli) * [GitHub project page](https://github.com/shaarli/Shaarli)
* [Online documentation](https://shaarli.readthedocs.io/) (this page) * [Online documentation](https://shaarli.readthedocs.io/)
* [Latest Shaarli releases](https://github.com/shaarli/Shaarli/releases) * [Latest releases](https://github.com/shaarli/Shaarli/releases)
* [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md) * [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md)
@ -30,87 +24,70 @@ It runs the latest development version of Shaarli and is updated/reset daily.
Login: `demo`; Password: `demo` Login: `demo`; Password: `demo`
<!-- TODO review everything below this point -->
## Features ## Features
Shaarli can be used: Shaarli can be used:
- to share, comment and save interesting links and news. - to share, comment and save interesting links and news
- to bookmark useful/frequent personal links (as private links) and share them between computers. - to bookmark useful/frequent links and share them between computers
- as a minimal blog/microblog/writing platform (no character limit). - as a minimal blog/microblog/writing platform
- as a read-it-later list (for example items tagged `readlater`). - as a read-it-later list
- to draft and save articles/posts/ideas. - to draft and save articles/posts/ideas
- to keep code snippets. - to keep notes, documentation and code snippets
- to keep notes and documentation. - as a shared clipboard/notepad/pastebin between machines
- as a shared clipboard/notepad/pastebin between machines. - as a todo list
- as a todo list. - to store media playlists
- to store playlists (e.g. with the `music` or `video` tags).
- to keep extracts/comments from webpages that may disappear. - to keep extracts/comments from webpages that may disappear.
- to keep track of ongoing discussions (for example items tagged `discussion`). - to keep track of ongoing discussions
- [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags. - to feed other blogs, aggregators, social networks... using RSS feeds
- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...).
### Interface ### Edit, view and search your links
- minimalist design (simple is beautiful) - Minimalist design
- FAST - FAST
- ATOM and RSS feeds - Customizable link titles and descriptions
- views: - Tags to organize your links (features tag autocompletion, renaming, merging and deletion)
- paginated link list (with image and video thumbnails) - Search by tag or using the full-text search
- tag cloud - Public and private links (visible only to logged-in users)
- picture wall: image and video thumbnails (with lazy loading) - Unique permalinks for easy reference
- daily: newspaper-like daily digest - Paginated link list (with image and video thumbnails)
- daily RSS feed - Tag cloud and list views
- permalinks for easy reference - Picture wall: image and video thumbnails view (with lazy loading)
- links can be public or private - ATOM and RSS feeds (can also be filtered using tags or text search)
- thumbnail generation for images and video services - Daily: newspaper-like daily digest (and daily RSS feed)
- URL cleanup: automatic removal of `?utm_source=...`, `fb=...` - URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
- extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) - Extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)
### Tag, view and search your links
- add a custom title and description to archived links
- add tags to classify and search links
- features tag autocompletion, renaming, merging and deletion
- full-text and tag search
### Easy setup ### Easy setup
- dead-simple installation: drop the files, open the page - Dead-simple installation: drop the files, open the page
- links are stored in a file - Links are stored in a file (no database required, easy backup: simply copy the datastore file)
- compact storage - Import and export links as Netscape bookmarks compatible with most Web browsers
- no database required
- easy backup: simply copy the datastore file
- import and export links as Netscape bookmarks
### Accessibility ### Accessibility
- bookmarlet to share links in one click - Bookmarklet and other tools to share links in one click
- support for mobile browsers - Support for mobile browsers
- degrades gracefully with Javascript disabled - Degrades gracefully with Javascript disabled
- easy page customization through HTML/CSS/RainTPL - Easy page customization through HTML/CSS/RainTPL
### Security ### Security
- discreet pop-up notification when a new release is available - Discreet pop-up notification when a new release is available
- bruteforce protection on the login form - Bruteforce protection on the login form
- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking - Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking
<!-- TODO Limitations --> <!-- TODO Limitations -->
### REST API ### REST API
Easily extensible by any client using the REST API exposed by Shaarli. - Easily extensible by any client using the REST API exposed by Shaarli ([API documentation](http://shaarli.github.io/api-documentation/)).
See the [API documentation](http://shaarli.github.io/api-documentation/).
## About ## About
### Shaarli community fork ### Shaarli community fork
This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli This friendly fork is maintained by the Shaarli community at <https://github.com/shaarli/Shaarli>
This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
@ -123,16 +100,15 @@ in this repository, and will keep maintaining the project for the foreseeable
future, while keeping Shaarli simple and efficient. future, while keeping Shaarli simple and efficient.
### Contributing ### Contributing and getting help
If you'd like to help, please: Feedback is very appreciated!
- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) - 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).
and [pull requests](https://github.com/shaarli/Shaarli/pulls) - Have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls)
- feel free to report bugs (feedback is much appreciated) - 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).
- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/tree/master/doc/md/) - If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
- propose solutions to existing problems - Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-)
- submit pull requests :-)
### License ### License