diff options
| author | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
|---|---|---|
| committer | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
| commit | 43ad7c8e825057747ccf02049050b323878952a7 (patch) | |
| tree | 3160fd640c42f41a38d6c1df2cd4e020f87942ae /doc/md/Features.md | |
| parent | b4ff0afb24db6e4cb3543bbd71f01bbb0716b144 (diff) | |
| download | Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.gz Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.zst Shaarli-43ad7c8e825057747ccf02049050b323878952a7.zip | |
documentation: fix rendering and internal references
This is mainly cleanup after switching from Github-flavoured Markdown
rendered by Github Pages, to standard Markdown rendered by MkDocs.
Changed:
- rephrase some section titles
Fixed:
- list rendering (items, sub-items))
- code rendering
- quotes
- dead links
Removed:
- extraneous navigational elements
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/md/Features.md')
| -rw-r--r-- | doc/md/Features.md | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/doc/md/Features.md b/doc/md/Features.md index 116b1c9c..eef88d03 100644 --- a/doc/md/Features.md +++ b/doc/md/Features.md | |||
| @@ -1,24 +1,25 @@ | |||
| 1 | ### Main features | 1 | ### Main features |
| 2 | Shaarli is intended: | 2 | Shaarli is intended: |
| 3 | * to share, comment and save interesting links and news | 3 | |
| 4 | * to bookmark useful/frequent personal links (as private links) and share them between computers | 4 | - to share, comment and save interesting links and news |
| 5 | * as a minimal blog/microblog/writing platform (no character limit) | 5 | - to bookmark useful/frequent personal links (as private links) and share them between computers |
| 6 | * as a read-it-later list (for example items tagged `readlater`) | 6 | - as a minimal blog/microblog/writing platform (no character limit) |
| 7 | * to draft and save articles/ideas | 7 | - as a read-it-later list (for example items tagged `readlater`) |
| 8 | * to keep code snippets | 8 | - to draft and save articles/ideas |
| 9 | * to keep notes and documentation | 9 | - to keep code snippets |
| 10 | * as a shared clipboard between machines | 10 | - to keep notes and documentation |
| 11 | * as a todo list | 11 | - as a shared clipboard between machines |
| 12 | * to store playlists (e.g. with the `music` or `video` tags) | 12 | - as a todo list |
| 13 | * to keep extracts/comments from webpages that may disappear | 13 | - to store playlists (e.g. with the `music` or `video` tags) |
| 14 | * to keep track of ongoing discussions (for example items tagged `discussion`) | 14 | - to keep extracts/comments from webpages that may disappear |
| 15 | * [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags | 15 | - to keep track of ongoing discussions (for example items tagged `discussion`) |
| 16 | * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) | 16 | - [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags |
| 17 | - to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) | ||
| 17 | 18 | ||
| 18 | ### Using Shaarli as a blog, notepad, pastebin... | 19 | ### Using Shaarli as a blog, notepad, pastebin... |
| 19 | 20 | ||
| 20 | * Go to your Shaarli setup and log in | 21 | - Go to your Shaarli setup and log in |
| 21 | * Click the `Add Link` button | 22 | - Click the `Add Link` button |
| 22 | * To share text only, do not enter any URL in the corresponding input field and click `Add Link` | 23 | - To share text only, do not enter any URL in the corresponding input field and click `Add Link` |
| 23 | * Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` | 24 | - Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` |
| 24 | * Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. | 25 | - Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. |