diff options
Diffstat (limited to 'doc/md')
-rw-r--r-- | doc/md/Browsing-and-searching.md | 18 | ||||
-rw-r--r-- | doc/md/Community-&-Related-software.md | 8 | ||||
-rw-r--r-- | doc/md/Download-and-Installation.md | 2 | ||||
-rw-r--r-- | doc/md/Firefox-share.md | 3 | ||||
-rw-r--r-- | doc/md/docker/shaarli-images.md | 14 | ||||
-rw-r--r-- | doc/md/index.md | 43 |
6 files changed, 61 insertions, 27 deletions
diff --git a/doc/md/Browsing-and-searching.md b/doc/md/Browsing-and-searching.md index bda619e1..16c69855 100644 --- a/doc/md/Browsing-and-searching.md +++ b/doc/md/Browsing-and-searching.md | |||
@@ -14,10 +14,24 @@ Use the `Filter by tags` field to restrict displayed links to entries tagged wit | |||
14 | 14 | ||
15 | **Hidden tags:** Tags starting with a dot `.` (example `.secret`) are private. They can only be seen and searched when logged in. | 15 | **Hidden tags:** Tags starting with a dot `.` (example `.secret`) are private. They can only be seen and searched when logged in. |
16 | 16 | ||
17 | Alternatively you can use the `Tag cloud` to discover all tags and click on any of them to display related links. | 17 | ### Tag cloud |
18 | 18 | ||
19 | To search for links that are not tagged, enter `""` in the tag search field. | 19 | The `Tag cloud` page diplays a "cloud" view of all tags in your Shaarli. |
20 | |||
21 | * The most frequently used tags are displayed with a bigger font size. | ||
22 | * When sorting by `Most used` or `Alphabetical`, tags are displayed as a _list_, along with counters and edit/delete buttons for each tag. | ||
23 | * Clicking on any tag will display a list of all Shaares matching this tag. | ||
24 | * Clicking on the counter next to a tag `example`, will filter the tag cloud to only display tags found in Shaares tagged `example`. Repeat this any number of times to further filter the tag cloud. Click `List all links with those tags` to display Shaares matching your current tag filter. | ||
20 | 25 | ||
21 | ## Filtering RSS feeds/Picture wall | 26 | ## Filtering RSS feeds/Picture wall |
22 | 27 | ||
23 | RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS-feeds). | 28 | RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS-feeds). |
29 | |||
30 | ## Filter buttons | ||
31 | |||
32 | Filter buttons can be found at the top left of the link list. They allow you to apply different filters to the list: | ||
33 | |||
34 | * **Private links:** When this toggle button is enabled, only shaares set to `private` will be shown. | ||
35 | * **Untagged links:** When the this toggle button is enabled (top left of the link list), only shaares _without any tags_ will be shown in the link list. | ||
36 | |||
37 | Filter buttons are only available when logged in. | ||
diff --git a/doc/md/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md index ad38ac96..086af7c1 100644 --- a/doc/md/Community-&-Related-software.md +++ b/doc/md/Community-&-Related-software.md | |||
@@ -49,10 +49,12 @@ See [Theming](Theming) for a list of community-contributed themes, and an instal | |||
49 | 49 | ||
50 | 50 | ||
51 | ### Mobile Apps | 51 | ### Mobile Apps |
52 | - [ShaarliOS](https://github.com/mro/ShaarliOS) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes, | 52 | - [ShaarliOS](https://github.com/mro/ShaarliOS) - Apple iOS share extension. |
53 | - [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider | 53 | - [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider |
54 | - [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli | 54 | - [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli |
55 | 55 | ||
56 | ### Browser addons | ||
57 | * [Shaarli Web Extension](https://github.com/ikipatang/shaarli-web-extension) - toolbar button to share your current tab with Shaarli. | ||
56 | 58 | ||
57 | ### Server apps | 59 | ### Server apps |
58 | - [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content | 60 | - [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content |
@@ -63,7 +65,5 @@ See [Theming](Theming) for a list of community-contributed themes, and an instal | |||
63 | - [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. [Another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for other shaarli instances (but is more resource consuming). | 65 | - [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. [Another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for other shaarli instances (but is more resource consuming). |
64 | - [Bookmark Archiver](https://github.com/pirate/bookmark-archiver) - Save an archived copy of all websites starred using browser bookmarks/Shaarli/Delicious/Instapaper/Unmark.it/Pocket/Pinboard. Outputs browseable html. | 66 | - [Bookmark Archiver](https://github.com/pirate/bookmark-archiver) - Save an archived copy of all websites starred using browser bookmarks/Shaarli/Delicious/Instapaper/Unmark.it/Pocket/Pinboard. Outputs browseable html. |
65 | 67 | ||
66 | |||
67 | ## Alternatives to Shaarli | 68 | ## Alternatives to Shaarli |
68 | See the [bookmarks & link sharing](https://github.com/Kickball/awesome-selfhosted/#bookmarks--link-sharing) | 69 | See [awesome-selfhosted: bookmarks & link sharing](https://github.com/Kickball/awesome-selfhosted/#bookmarks--link-sharing). |
69 | section on [awesome-selfhosted](https://github.com/Kickball/awesome-selfhosted/). | ||
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index e64d1a43..bbbfc26d 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md | |||
@@ -15,7 +15,7 @@ Using one of the following methods: | |||
15 | - by downloading full release archives including all dependencies | 15 | - by downloading full release archives including all dependencies |
16 | - by downloading Github archives | 16 | - by downloading Github archives |
17 | - by cloning the Git repository | 17 | - by cloning the Git repository |
18 | - using Docker: [see the documentation](docker/shaarli-images) | 18 | - using Docker: [see the documentation](docker/shaarli-images.md) |
19 | 19 | ||
20 | -------------------------------------------------------------------------------- | 20 | -------------------------------------------------------------------------------- |
21 | 21 | ||
diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md index 878884a4..9a46b185 100644 --- a/doc/md/Firefox-share.md +++ b/doc/md/Firefox-share.md | |||
@@ -1,3 +1,6 @@ | |||
1 | | Note | Firefox Share is no longer available for Firefox 57 and later versions. | | ||
2 | |---------|---------| | ||
3 | |||
1 | ### Add Shaarli as a sharing service to Firefox | 4 | ### Add Shaarli as a sharing service to Firefox |
2 | 5 | ||
3 | - Open your Shaarli and `Login` | 6 | - Open your Shaarli and `Login` |
diff --git a/doc/md/docker/shaarli-images.md b/doc/md/docker/shaarli-images.md index 1d19510a..5491ee76 100644 --- a/doc/md/docker/shaarli-images.md +++ b/doc/md/docker/shaarli-images.md | |||
@@ -1,3 +1,6 @@ | |||
1 | A brief guide on getting starting using docker is given in [Docker 101](docker-101.md). | ||
2 | To learn more about user data and how to keep it across versions, please see [Upgrade and Migration](../Upgrade-and-migration.md). | ||
3 | |||
1 | ## Get and run a Shaarli image | 4 | ## Get and run a Shaarli image |
2 | 5 | ||
3 | ### DockerHub repository | 6 | ### DockerHub repository |
@@ -78,3 +81,14 @@ backstabbing_galileo | |||
78 | $ docker ps -a | 81 | $ docker ps -a |
79 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | 82 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES |
80 | ``` | 83 | ``` |
84 | |||
85 | ### Automatic builds | ||
86 | |||
87 | 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): | ||
88 | ``` | ||
89 | MY_SHAARLI_VOLUME=$(cd /path/to/shaarli/data/ && pwd -P) | ||
90 | docker run -ti --rm \ | ||
91 | -p 8000:80 \ | ||
92 | -v $MY_SHAARLI_VOLUME:/var/www/shaarli/data \ | ||
93 | shaarli/shaarli | ||
94 | ``` | ||
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 |