From 43ad7c8e825057747ccf02049050b323878952a7 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Sat, 5 Aug 2017 11:56:24 +0200 Subject: 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 --- doc/md/Features.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) (limited to 'doc/md/Features.md') 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 @@ ### Main features Shaarli is intended: - * to share, comment and save interesting links and news - * to bookmark useful/frequent personal links (as private links) and share them between computers - * as a minimal blog/microblog/writing platform (no character limit) - * as a read-it-later list (for example items tagged `readlater`) - * to draft and save articles/ideas - * to keep code snippets - * to keep notes and documentation - * as a shared clipboard between machines - * as a todo list - * to store playlists (e.g. with the `music` or `video` tags) - * to keep extracts/comments from webpages that may disappear - * to keep track of ongoing discussions (for example items tagged `discussion`) - * [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags - * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) + +- to share, comment and save interesting links and news +- to bookmark useful/frequent personal links (as private links) and share them between computers +- as a minimal blog/microblog/writing platform (no character limit) +- as a read-it-later list (for example items tagged `readlater`) +- to draft and save articles/ideas +- to keep code snippets +- to keep notes and documentation +- as a shared clipboard between machines +- as a todo list +- to store playlists (e.g. with the `music` or `video` tags) +- to keep extracts/comments from webpages that may disappear +- to keep track of ongoing discussions (for example items tagged `discussion`) +- [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags +- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) ### Using Shaarli as a blog, notepad, pastebin... - * Go to your Shaarli setup and log in - * Click the `Add Link` button - * To share text only, do not enter any URL in the corresponding input field and click `Add Link` - * Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` - * Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. +- Go to your Shaarli setup and log in +- Click the `Add Link` button +- To share text only, do not enter any URL in the corresponding input field and click `Add Link` +- Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` +- Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. -- cgit v1.2.3