diff options
author | VirtualTam <virtualtam@flibidi.net> | 2015-07-22 05:02:10 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2015-08-04 16:02:21 +0200 |
commit | 992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 (patch) | |
tree | 4726baf18e7057eac3f9b6bdb5991fe6117814fc /doc/Usage.md | |
parent | 96db105e4c0833324f7168edb5673278de8ccd54 (diff) | |
download | Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.gz Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.zst Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.zip |
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 - <Page Name>
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/Usage.md')
-rw-r--r-- | doc/Usage.md | 25 |
1 files changed, 25 insertions, 0 deletions
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 @@ | |||
1 | #Usage | ||
2 | ### Main features | ||
3 | Shaarli is intended: | ||
4 | * to share, comment and save interesting links and news | ||
5 | * to bookmark useful/frequent personal links (as private links) and share them between computers | ||
6 | * as a minimal blog/microblog/writing platform (no character limit) | ||
7 | * as a read-it-later list (for example items tagged `readlater`) | ||
8 | * to draft and save articles/ideas | ||
9 | * to keep code snippets | ||
10 | * to keep notes and documentation | ||
11 | * as a shared clipboard between machines | ||
12 | * as a todo list | ||
13 | * to store playlists (e.g. with the `music` or `video` tags) | ||
14 | * to keep extracts/comments from webpages that may disappear | ||
15 | * to keep track of ongoing discussions (for example items tagged `discussion`) | ||
16 | * [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags[](.html) | ||
17 | * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) | ||
18 | |||
19 | ### Using Shaarli as a blog, notepad, pastebin... | ||
20 | |||
21 | * Go to your Shaarli setup and log in | ||
22 | * Click the `Add Link` button | ||
23 | * To share text only, do not enter any URL in the corresponding input field and click `Add Link` | ||
24 | * Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` | ||
25 | * VoilĂ ! Your article is now published (privately if you selected that option) and accessible using its permalink. | ||