diff options
author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/RSS-feeds.md | |
parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
download | Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip |
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation.
Documentation source files are written in Markdown, and configured with a single YAML file.
* http://www.mkdocs.org/
* http://www.mkdocs.org/user-guide/configuration/
Ref. #312
* remove pandoc-generated HTML documentation
* move markdown doc to doc/md/,
* mkdocs.yml:
* generate HTML doc in doc/html
* add pages TOC/ordering
* use index.md as index page
* Makefile: remove execute permissions from generated files
* Makefile: rewrite htmlpages GFM to markdown conversion using sed:
awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks
* Add mkdocs.yml to .gitattributes, exclude this file from release archives
* Makefile: rename: htmldoc -> doc_html target
* run make doc: pull latest markdown documentation from wiki
* run make htmlpages: update html documentation
Diffstat (limited to 'doc/md/RSS-feeds.md')
-rw-r--r-- | doc/md/RSS-feeds.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/md/RSS-feeds.md b/doc/md/RSS-feeds.md new file mode 100644 index 00000000..9d718172 --- /dev/null +++ b/doc/md/RSS-feeds.md | |||
@@ -0,0 +1,26 @@ | |||
1 | ### Feeds options | ||
2 | |||
3 | Feeds are available in ATOM with `?do=atom` and RSS with `do=RSS`. | ||
4 | |||
5 | Options: | ||
6 | - You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL. | ||
7 | - E.G. `https://my.shaarli.domain/?do=atom&permalinks`. | ||
8 | - 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. | ||
9 | - `https://my.shaarli.domain/?do=atom&permalinks&nb=42` | ||
10 | - `https://my.shaarli.domain/?do=atom&permalinks&nb=all` | ||
11 | |||
12 | ### RSS Feeds or Picture Wall for a specific search/tag | ||
13 | |||
14 | 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 | |||
16 | For example, if you want to subscribe only to links tagged `photography`: | ||
17 | - Go to the desired Shaarli instance. | ||
18 | - Search for the `photography` tag in the _Filter by tag_ box. Links tagged `photography` are displayed. | ||
19 | - Click on the `RSS Feed` button. | ||
20 | - You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag. | ||
21 | - The same method **also works for a full-text search** (_Search_ box) **and for the Picture Wall** (want to only see pictures about `nature`?) | ||
22 | - You can also build the URLs manually: | ||
23 | - `https://my.shaarli.domain/?do=rss&searchtags=nature` | ||
24 | - `https://my.shaarli.domain/links/?do=picwall&searchterm=poney` | ||
25 | |||
26 | ![](images/rss-filter-1.png) ![](images/rss-filter-2.png) | ||