diff options
Diffstat (limited to 'doc/md/index.md')
| -rw-r--r-- | doc/md/index.md | 43 |
1 files changed, 23 insertions, 20 deletions
diff --git a/doc/md/index.md b/doc/md/index.md index 2b7d0f00..e77b4d3a 100644 --- a/doc/md/index.md +++ b/doc/md/index.md | |||
| @@ -22,20 +22,25 @@ It runs the latest development version of Shaarli and is updated/reset daily. | |||
| 22 | 22 | ||
| 23 | Login: `demo`; Password: `demo` | 23 | Login: `demo`; Password: `demo` |
| 24 | 24 | ||
| 25 | Docker users can start a personal instance from an [autobuild image](https://hub.docker.com/r/shaarli/shaarli/). For example to start a temporary Shaarli at ``localhost:8000``, and keep session data (config, storage): | ||
| 26 | ``` | ||
| 27 | MY_SHAARLI_VOLUME=$(cd /path/to/shaarli/data/ && pwd -P) | ||
| 28 | docker run -ti --rm \ | ||
| 29 | -p 8000:80 \ | ||
| 30 | -v $MY_SHAARLI_VOLUME:/var/www/shaarli/data \ | ||
| 31 | shaarli/shaarli | ||
| 32 | ``` | ||
| 33 | |||
| 34 | A brief guide on getting starting using docker is given in [Docker 101](docker/docker-101). | ||
| 35 | To learn more about user data and how to keep it across versions, please see [Upgrade and Migration](Upgrade-and-migration) documentation. | ||
| 36 | |||
| 37 | ## Features | 25 | ## Features |
| 38 | 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 | |||
| 39 | ### Interface | 44 | ### Interface |
| 40 | - minimalist design (simple is beautiful) | 45 | - minimalist design (simple is beautiful) |
| 41 | - FAST | 46 | - FAST |
| @@ -89,14 +94,12 @@ Easily extensible by any client using the REST API exposed by Shaarli. | |||
| 89 | 94 | ||
| 90 | See the [API documentation](http://shaarli.github.io/api-documentation/). | 95 | See the [API documentation](http://shaarli.github.io/api-documentation/). |
| 91 | 96 | ||
| 92 | ### Other usages | 97 | ### Using Shaarli as a blog, notepad, pastebin... |
| 93 | Though Shaarli is primarily a bookmarking application, it can serve other purposes | 98 | - Go to your Shaarli setup and log in |
| 94 | (see [Features](Features)): | 99 | - Click the `Add Link` button |
| 95 | 100 | - To share text only, do not enter any URL in the corresponding input field and click `Add Link` | |
| 96 | - micro-blogging | 101 | - Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` |
| 97 | - pastebin | 102 | - Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. |
| 98 | - online notepad | ||
| 99 | - snippet archive | ||
| 100 | 103 | ||
| 101 | ## About | 104 | ## About |
| 102 | ### Shaarli community fork | 105 | ### Shaarli community fork |