aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/RSS-feeds.html
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/RSS-feeds.html
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-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/RSS-feeds.html')
-rw-r--r--doc/RSS-feeds.html99
1 files changed, 0 insertions, 99 deletions
diff --git a/doc/RSS-feeds.html b/doc/RSS-feeds.html
deleted file mode 100644
index 0ebfecc6..00000000
--- a/doc/RSS-feeds.html
+++ /dev/null
@@ -1,99 +0,0 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – RSS feeds</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
10 <!--[if lt IE 9]>
11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
12 <![endif]-->
13</head>
14<body>
15<div id="local-sidebar">
16<ul>
17<li><a href="Home.html">Home</a></li>
18<li>Setup
19<ul>
20<li><a href="Download-and-Installation.html">Download and Installation</a></li>
21<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
22<li><a href="Server-requirements.html">Server requirements</a></li>
23<li><a href="Server-configuration.html">Server configuration</a></li>
24<li><a href="Server-security.html">Server security</a></li>
25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugins.html">Plugins</a></li>
27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Usage.html">Usage</a>
30<ul>
31<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
32<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
33<li><a href="Firefox-share.html">Firefox share</a></li>
34<li><a href="RSS-feeds.html">RSS feeds</a></li>
35<li><a href="REST-API.html">REST API</a></li>
36</ul></li>
37<li>How To
38<ul>
39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
41<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
42<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
43<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
44</ul></li>
45<li><a href="Troubleshooting.html">Troubleshooting</a></li>
46<li><a href="Development.html">Development</a>
47<ul>
48<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
49<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
50<li><a href="Directory-structure.html">Directory structure</a></li>
51<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
52<li><a href="Plugin-System.html">Plugin System</a></li>
53<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
54<li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li>
55<li><a href="Security.html">Security</a></li>
56<li><a href="Static-analysis.html">Static analysis</a></li>
57<li><a href="Theming.html">Theming</a></li>
58<li><a href="Unit-tests.html">Unit tests</a></li>
59</ul></li>
60<li>About
61<ul>
62<li><a href="FAQ.html">FAQ</a></li>
63<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
64</ul></li>
65</ul>
66</div>
67<h1 id="rss-feeds">RSS feeds</h1>
68<h3 id="feeds-options">Feeds options</h3>
69<p>Feeds are available in ATOM with <code>?do=atom</code> and RSS with <code>do=RSS</code>.</p>
70<p>Options:</p>
71<ul>
72<li>You can use <code>permalinks</code> in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
73<ul>
74<li>E.G. <code>https://my.shaarli.domain/?do=atom&amp;permalinks</code>.</li>
75</ul></li>
76<li>You can use <code>nb</code> parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: <code>50</code>). The keyword <code>all</code> is available if you want everything.
77<ul>
78<li><code>https://my.shaarli.domain/?do=atom&amp;permalinks&amp;nb=42</code></li>
79<li><code>https://my.shaarli.domain/?do=atom&amp;permalinks&amp;nb=all</code></li>
80</ul></li>
81</ul>
82<h3 id="rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</h3>
83<p>It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to <strong>only display results of a specific search, or for a specific tag</strong>.</p>
84<p>For example, if you want to subscribe only to links tagged <code>photography</code>:</p>
85<ul>
86<li>Go to the desired Shaarli instance.</li>
87<li>Search for the <code>photography</code> tag in the <em>Filter by tag</em> box. Links tagged <code>photography</code> are displayed.</li>
88<li>Click on the <code>RSS Feed</code> button.</li>
89<li>You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.</li>
90<li>The same method <strong>also works for a full-text search</strong> (<em>Search</em> box) <strong>and for the Picture Wall</strong> (want to only see pictures about <code>nature</code>?)</li>
91<li>You can also build the URLs manually:
92<ul>
93<li><code>https://my.shaarli.domain/?do=rss&amp;searchtags=nature</code></li>
94<li><code>https://my.shaarli.domain/links/?do=picwall&amp;searchterm=poney</code></li>
95</ul></li>
96</ul>
97<p><embed src="(images/rss-filter-1.png)-!.html" />(images/rss-filter-2.png)</p>
98</body>
99</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-11 02:46:23 +0000