diff options
Diffstat (limited to 'doc/RSS-feeds.md')
-rw-r--r-- | doc/RSS-feeds.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/RSS-feeds.md b/doc/RSS-feeds.md index 764b3a49..757bed9a 100644 --- a/doc/RSS-feeds.md +++ b/doc/RSS-feeds.md | |||
@@ -1,5 +1,17 @@ | |||
1 | #RSS feeds | 1 | #RSS feeds |
2 | ### Feeds options | ||
3 | |||
4 | Feeds are available in ATOM with `?do=atom` and RSS with `do=RSS`. | ||
5 | |||
6 | Options: | ||
7 | - You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL. | ||
8 | - E.G. `https://my.shaarli.domain/?do=atom&permalinks`. | ||
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. | ||
10 | - `https://my.shaarli.domain/?do=atom&permalinks&nb=42` | ||
11 | - `https://my.shaarli.domain/?do=atom&permalinks&nb=all` | ||
12 | |||
2 | ### RSS Feeds or Picture Wall for a specific search/tag | 13 | ### RSS Feeds or Picture Wall for a specific search/tag |
14 | |||
3 | It 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**. | 15 | It 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**. |
4 | 16 | ||
5 | For example, if you want to subscribe only to links tagged `photography`: | 17 | For example, if you want to subscribe only to links tagged `photography`: |