diff --git a/doc/md/Browsing-and-searching.md b/doc/md/Browsing-and-searching.md index bda619e..16c6985 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 **Hidden tags:** Tags starting with a dot `.` (example `.secret`) are private. They can only be seen and searched when logged in. -Alternatively you can use the `Tag cloud` to discover all tags and click on any of them to display related links. +### Tag cloud -To search for links that are not tagged, enter `""` in the tag search field. +The `Tag cloud` page diplays a "cloud" view of all tags in your Shaarli. + + * The most frequently used tags are displayed with a bigger font size. + * When sorting by `Most used` or `Alphabetical`, tags are displayed as a _list_, along with counters and edit/delete buttons for each tag. + * Clicking on any tag will display a list of all Shaares matching this tag. + * 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. ## Filtering RSS feeds/Picture wall RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS-feeds). + +## Filter buttons + +Filter buttons can be found at the top left of the link list. They allow you to apply different filters to the list: + + * **Private links:** When this toggle button is enabled, only shaares set to `private` will be shown. + * **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. + +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 2b7c659..f2271c7 100644 --- a/doc/md/Community-&-Related-software.md +++ b/doc/md/Community-&-Related-software.md @@ -1,23 +1,7 @@ _Unofficial but related work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork._ -## Community -- [Liens en vrac de sebsauvage](http://sebsauvage.net/links/) - the original Shaarli -- [A large list of Shaarlis](http://porneia.free.fr/pub/links/ou-est-shaarli.html) -- [A list of working Shaarli aggregators](https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json) -- [A list of some known Shaarlis](https://github.com/Oros42/shaarlis_list) -- [Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net](http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-) (fr) _16/09/2011 - the original post about Shaarli_ -- [Original ideas/fixme/TODO page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas) -- [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr) -- [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history) -- [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni) - - -### Articles and social media discussions -- 2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176 -- 2015-08-15 - Reddit - [Question about migrating from WordPress to Shaarli.](https://www.reddit.com/r/selfhosted/comments/3h3zwh/question_about_migrating_from_wordpress_to_shaarli/) -- 2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366 -- 2015-05-12 - Reddit - [shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)](https://www.reddit.com/r/selfhosted/comments/35pkkc/shaarli_self_hosted_bookmarking_delicious_php/) +## Related software ### REST API clients @@ -29,6 +13,7 @@ See [REST API](REST-API) for a list of official and community clients. - [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter. - [Disqus](https://github.com/kalvn/shaarli-plugin-disqus) by [@kalvn](https://github.com/kalvn): Adds Disqus comment system to your Shaarli. - [emojione](https://github.com/NerosTie/emojione) by [@NerosTie](https://github.com/NerosTie): Add colorful emojis to your Shaarli. +- [twemoji](https://github.com/NerosTie/twemoji) by [@NerosTie](https://github.com/NerosTie): Add colorful emojis to your Shaarli (Twemoji version) - [google analytics](https://github.com/ericjuden/Shaarli-Google-Analytics-Plugin) by [@ericjuden](http://github.com/ericjuden): Adds Google Analytics tracking support - [launch](https://github.com/ArthurHoaro/launch-plugin) - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli. - [related](https://github.com/ilesinge/shaarli-related) by [@ilesinge](https://github.com/ilesinge) - Show related links based on the number of identical tags. @@ -41,17 +26,19 @@ See [REST API](REST-API) for a list of official and community clients. See [Theming](Theming) for a list of community-contributed themes, and an installation guide. -## Integration with other platforms +### Integration with other platforms - [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [Tiny-Tiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli - [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - Octopress plugin to retrieve Shaarli links on the sidebar - [Scuttle to Shaarli](https://github.com/q2apro/scuttle-to-shaarli) - Import bookmarks from Scuttle ### Mobile Apps -- [ShaarliOS](https://github.com/mro/ShaarliOS) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes, +- [ShaarliOS](https://github.com/mro/ShaarliOS) - Apple iOS share extension. - [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider - [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli +### Browser addons + * [Shaarli Web Extension](https://github.com/ikipatang/shaarli-web-extension) - toolbar button to share your current tab with Shaarli. ### Server apps - [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content @@ -62,7 +49,22 @@ See [Theming](Theming) for a list of community-contributed themes, and an instal - [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). - [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. - ## Alternatives to Shaarli -See the [bookmarks & link sharing](https://github.com/Kickball/awesome-selfhosted/#bookmarks--link-sharing) -section on [awesome-selfhosted](https://github.com/Kickball/awesome-selfhosted/). +See [awesome-selfhosted: bookmarks & link sharing](https://github.com/Kickball/awesome-selfhosted/#bookmarks--link-sharing). + +## Community +- [Liens en vrac de sebsauvage](http://sebsauvage.net/links/) - the original Shaarli +- [A large list of Shaarlis](http://porneia.free.fr/pub/links/ou-est-shaarli.html) +- [A list of working Shaarli aggregators](https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json) +- [A list of some known Shaarlis](https://github.com/Oros42/shaarlis_list) +- [Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net](http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-) (fr) _16/09/2011 - the original post about Shaarli_ +- [Original ideas/fixme/TODO page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas) +- [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr) +- [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history) +- [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni) + +### Articles and social media discussions +- 2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176 +- 2015-08-15 - Reddit - [Question about migrating from WordPress to Shaarli.](https://www.reddit.com/r/selfhosted/comments/3h3zwh/question_about_migrating_from_wordpress_to_shaarli/) +- 2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366 +- 2015-05-12 - Reddit - [shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)](https://www.reddit.com/r/selfhosted/comments/35pkkc/shaarli_self_hosted_bookmarking_delicious_php/) diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index e64d1a4..bbbfc26 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: - by downloading full release archives including all dependencies - by downloading Github archives - by cloning the Git repository -- using Docker: [see the documentation](docker/shaarli-images) +- using Docker: [see the documentation](docker/shaarli-images.md) -------------------------------------------------------------------------------- diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md index 878884a..9a46b18 100644 --- a/doc/md/Firefox-share.md +++ b/doc/md/Firefox-share.md @@ -1,3 +1,6 @@ +| Note | Firefox Share is no longer available for Firefox 57 and later versions. | +|---------|---------| + ### Add Shaarli as a sharing service to Firefox - Open your Shaarli and `Login` diff --git a/doc/md/docker/shaarli-images.md b/doc/md/docker/shaarli-images.md index 1d19510..5491ee7 100644 --- a/doc/md/docker/shaarli-images.md +++ b/doc/md/docker/shaarli-images.md @@ -1,3 +1,6 @@ +A brief guide on getting starting using docker is given in [Docker 101](docker-101.md). +To learn more about user data and how to keep it across versions, please see [Upgrade and Migration](../Upgrade-and-migration.md). + ## Get and run a Shaarli image ### DockerHub repository @@ -78,3 +81,14 @@ backstabbing_galileo $ docker ps -a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES ``` + +### Automatic builds + +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): +``` +MY_SHAARLI_VOLUME=$(cd /path/to/shaarli/data/ && pwd -P) +docker run -ti --rm \ + -p 8000:80 \ + -v $MY_SHAARLI_VOLUME:/var/www/shaarli/data \ + shaarli/shaarli +``` diff --git a/doc/md/index.md b/doc/md/index.md index 2b7d0f0..e77b4d3 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. Login: `demo`; Password: `demo` -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): -``` -MY_SHAARLI_VOLUME=$(cd /path/to/shaarli/data/ && pwd -P) -docker run -ti --rm \ - -p 8000:80 \ - -v $MY_SHAARLI_VOLUME:/var/www/shaarli/data \ - shaarli/shaarli -``` - -A brief guide on getting starting using docker is given in [Docker 101](docker/docker-101). -To learn more about user data and how to keep it across versions, please see [Upgrade and Migration](Upgrade-and-migration) documentation. - ## Features +Shaarli can be used: + +- 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/posts/ideas. +- to keep code snippets. +- to keep notes and documentation. +- as a shared clipboard/notepad/pastebin 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 ...). + ### Interface - minimalist design (simple is beautiful) - FAST @@ -89,14 +94,12 @@ Easily extensible by any client using the REST API exposed by Shaarli. See the [API documentation](http://shaarli.github.io/api-documentation/). -### Other usages -Though Shaarli is primarily a bookmarking application, it can serve other purposes -(see [Features](Features)): - -- micro-blogging -- pastebin -- online notepad -- snippet archive +### 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. ## About ### Shaarli community fork diff --git a/mkdocs.yml b/mkdocs.yml index 8617ea4..443c3a0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,16 +22,15 @@ pages: - Reverse proxy configuration: docker/reverse-proxy-configuration.md - Docker resources: docker/resources.md - Usage: - - Features: Features.md - Bookmarklet: Bookmarklet.md - Browsing and searching: Browsing-and-searching.md - Firefox share: Firefox-share.md - RSS feeds: RSS-feeds.md - REST API: REST-API.md + - Community & Related software: Community-&-Related-software.md - How To: - Backup, restore, import and export: Backup,-restore,-import-and-export.md - Various hacks: Various-hacks.md -- Troubleshooting: Troubleshooting.md - Development: - Development guidelines: Development-guidelines.md - Continuous integration tools: Continuous-integration-tools.md @@ -47,6 +46,5 @@ pages: - Theming: Theming.md - Unit tests: Unit-tests.md - Unit tests inside Docker: Unit-tests-Docker.md -- About: - - FAQ: FAQ.md - - Community & Related software: Community-&-Related-software.md +- FAQ: FAQ.md +- Troubleshooting: Troubleshooting.md