]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - doc/md/RSS-feeds.md
Merge pull request #1552 from ArthurHoaro/feature/better-initializer
[github/shaarli/Shaarli.git] / doc / md / RSS-feeds.md
CommitLineData
5409ade2
A
1### Feeds options
2
9c75f877 3Feeds are available in ATOM with `/feed/atom` and RSS with `/feed/rss`.
5409ade2
A
4
5Options:
43ad7c8e 6
5409ade2 7- You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
9c75f877 8 - E.G. `https://my.shaarli.domain/feed/atom?permalinks`.
5409ade2 9- You can use `nb` parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: `50`). The keyword `all` is available if you want everything.
9c75f877
A
10 - `https://my.shaarli.domain/feed/atom?permalinks&nb=42`
11 - `https://my.shaarli.domain/feed/atom?permalinks&nb=all`
5409ade2 12
992af0b9 13### RSS Feeds or Picture Wall for a specific search/tag
5409ade2 14
992af0b9
V
15It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to **only display results of a specific search, or for a specific tag**.
16
17For example, if you want to subscribe only to links tagged `photography`:
43ad7c8e 18
992af0b9
V
19- Go to the desired Shaarli instance.
20- Search for the `photography` tag in the _Filter by tag_ box. Links tagged `photography` are displayed.
21- Click on the `RSS Feed` button.
22- You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.
23- The same method **also works for a full-text search** (_Search_ box) **and for the Picture Wall** (want to only see pictures about `nature`?)
485b168a 24- You can also build the URLs manually:
992af0b9 25 - `https://my.shaarli.domain/?do=rss&searchtags=nature`
485b168a 26 - `https://my.shaarli.domain/links/picture-wall?searchterm=poney`
992af0b9 27
53ed6d7d 28![](images/rss-filter-1.png) ![](images/rss-filter-2.png)