From 992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Wed, 22 Jul 2015 05:02:10 +0200 Subject: Doc: sync from Wiki, generate HTML Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - Signed-off-by: VirtualTam --- doc/Usage.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 doc/Usage.md (limited to 'doc/Usage.md') diff --git a/doc/Usage.md b/doc/Usage.md new file mode 100644 index 00000000..30ad1466 --- /dev/null +++ b/doc/Usage.md @@ -0,0 +1,25 @@ +#Usage +### 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[](.html) + * 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. -- cgit v1.2.3