From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc <nodiscc@gmail.com> Date: Thu, 26 Jan 2017 18:52:54 +0100 Subject: 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 --- doc/html/RSS-feeds/index.html | 367 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 367 insertions(+) create mode 100644 doc/html/RSS-feeds/index.html (limited to 'doc/html/RSS-feeds/index.html') diff --git a/doc/html/RSS-feeds/index.html b/doc/html/RSS-feeds/index.html new file mode 100644 index 00000000..bb6e412c --- /dev/null +++ b/doc/html/RSS-feeds/index.html @@ -0,0 +1,367 @@ +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + + <link rel="shortcut icon" href="../img/favicon.ico"> + <title>RSS feeds - Shaarli Documentation</title> + <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> + + <link rel="stylesheet" href="../css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" /> + <link rel="stylesheet" href="../css/highlight.css"> + <link href="../github-markdown.css" rel="stylesheet"> + + <script> + // Current page data + var mkdocs_page_name = "RSS feeds"; + var mkdocs_page_input_path = "RSS-feeds.md"; + var mkdocs_page_url = "/RSS-feeds/"; + </script> + + <script src="../js/jquery-2.1.1.min.js"></script> + <script src="../js/modernizr-2.8.3.min.js"></script> + <script type="text/javascript" src="../js/highlight.pack.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> + <div class="wy-side-nav-search"> + <a href=".." class="icon icon-home"> Shaarli Documentation</a> + <div role="search"> + <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + </form> +</div> + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + <ul class="current"> + + + <li class="toctree-l1"> + + <a class="" href="..">Home</a> + </li> + + <li class="toctree-l1"> + + <span class="caption-text">Setup</span> + <ul class="subnav"> + <li class=""> + + <a class="" href="../Download-and-Installation/">Download and Installation</a> + </li> + <li class=""> + + <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a> + </li> + <li class=""> + + <a class="" href="../Server-requirements/">Server requirements</a> + </li> + <li class=""> + + <a class="" href="../Server-configuration/">Server configuration</a> + </li> + <li class=""> + + <a class="" href="../Server-security/">Server security</a> + </li> + <li class=""> + + <a class="" href="../Shaarli-configuration/">Shaarli configuration</a> + </li> + <li class=""> + + <a class="" href="../Plugins/">Plugins</a> + </li> + </ul> + </li> + + <li class="toctree-l1"> + + <span class="caption-text">Docker</span> + <ul class="subnav"> + <li class=""> + + <a class="" href="../Docker-101/">Docker 101</a> + </li> + <li class=""> + + <a class="" href="../Shaarli-images/">Shaarli images</a> + </li> + <li class=""> + + <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> + </li> + <li class=""> + + <a class="" href="../Docker-resources/">Docker resources</a> + </li> + </ul> + </li> + + <li class="toctree-l1"> + + <span class="caption-text">Usage</span> + <ul class="subnav"> + <li class=""> + + <a class="" href="../Features/">Features</a> + </li> + <li class=""> + + <a class="" href="../Bookmarklet/">Bookmarklet</a> + </li> + <li class=""> + + <a class="" href="../Browsing-and-searching/">Browsing and searching</a> + </li> + <li class=""> + + <a class="" href="../Firefox-share/">Firefox share</a> + </li> + <li class=" current"> + + <a class="current" href="./">RSS feeds</a> + <ul class="subnav"> + + <li class="toctree-l3"><a href="#feeds-options">Feeds options</a></li> + + + <li class="toctree-l3"><a href="#rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</a></li> + + + </ul> + </li> + <li class=""> + + <a class="" href="../REST-API/">REST API</a> + </li> + </ul> + </li> + + <li class="toctree-l1"> + + <span class="caption-text">How To</span> + <ul class="subnav"> + <li class=""> + + <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> + </li> + <li class=""> + + <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> + </li> + <li class=""> + + <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> + </li> + <li class=""> + + <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> + </li> + <li class=""> + + <a class="" href="../Datastore-hacks/">Datastore hacks</a> + </li> + </ul> + </li> + + <li class="toctree-l1"> + + <a class="" href="../Troubleshooting/">Troubleshooting</a> + </li> + + <li class="toctree-l1"> + + <span class="caption-text">Development</span> + <ul class="subnav"> + <li class=""> + + <a class="" href="../Development-guidelines/">Development guidelines</a> + </li> + <li class=""> + + <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> + </li> + <li class=""> + + <a class="" href="../GnuPG-signature/">GnuPG signature</a> + </li> + <li class=""> + + <a class="" href="../Coding-guidelines/">Coding guidelines</a> + </li> + <li class=""> + + <a class="" href="../Directory-structure/">Directory structure</a> + </li> + <li class=""> + + <a class="" href="../3rd-party-libraries/">3rd party libraries</a> + </li> + <li class=""> + + <a class="" href="../Plugin-System/">Plugin System</a> + </li> + <li class=""> + + <a class="" href="../Release-Shaarli/">Release Shaarli</a> + </li> + <li class=""> + + <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> + </li> + <li class=""> + + <a class="" href="../Security/">Security</a> + </li> + <li class=""> + + <a class="" href="../Static-analysis/">Static analysis</a> + </li> + <li class=""> + + <a class="" href="../Theming/">Theming</a> + </li> + <li class=""> + + <a class="" href="../Unit-tests/">Unit tests</a> + </li> + </ul> + </li> + + <li class="toctree-l1"> + + <span class="caption-text">About</span> + <ul class="subnav"> + <li class=""> + + <a class="" href="../FAQ/">FAQ</a> + </li> + <li class=""> + + <a class="" href="../Community-&-Related-software/">Community & Related software</a> + </li> + </ul> + </li> + + </ul> + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="..">Shaarli Documentation</a> + </nav> + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="..">Docs</a> »</li> + + + + <li>Usage »</li> + + + + <li>RSS feeds</li> + <li class="wy-breadcrumbs-aside"> + + <a href="https://github.com/shaarli/Shaarli/edit/master/docs/RSS-feeds.md" + class="icon icon-github"> Edit on GitHub</a> + + </li> + </ul> + <hr/> +</div> + <div role="main"> + <div class="section"> + + <h3 id="feeds-options">Feeds options</h3> +<p>Feeds are available in ATOM with <code>?do=atom</code> and RSS with <code>do=RSS</code>.</p> +<p>Options: +- You can use <code>permalinks</code> in the feed URL to get permalink to Shaares instead of direct link to shaared URL. + - E.G. <code>https://my.shaarli.domain/?do=atom&permalinks</code>. +- 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. + - <code>https://my.shaarli.domain/?do=atom&permalinks&nb=42</code> + - <code>https://my.shaarli.domain/?do=atom&permalinks&nb=all</code></p> +<h3 id="rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</h3> +<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> +<p>For example, if you want to subscribe only to links tagged <code>photography</code>: +- Go to the desired Shaarli instance. +- Search for the <code>photography</code> tag in the <em>Filter by tag</em> box. Links tagged <code>photography</code> are displayed. +- Click on the <code>RSS Feed</code> button. +- You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag. +- 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>?) +- You can also build the URLs manually: + - <code>https://my.shaarli.domain/?do=rss&searchtags=nature</code> + - <code>https://my.shaarli.domain/links/?do=picwall&searchterm=poney</code></p> +<p><img alt="" src="../images/rss-filter-1.png" /> <img alt="" src="../images/rss-filter-2.png" /></p> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../REST-API/" class="btn btn-neutral float-right" title="REST API">Next <span class="icon icon-circle-arrow-right"></span></a> + + + <a href="../Firefox-share/" class="btn btn-neutral" title="Firefox share"><span class="icon icon-circle-arrow-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <!-- Copyright etc --> + + </div> + + Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. +</footer> + + </div> + </div> + + </section> + + </div> + + <div class="rst-versions" role="note" style="cursor: pointer"> + <span class="rst-current-version" data-toggle="rst-current-version"> + + <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> + + + <span><a href="../Firefox-share/" style="color: #fcfcfc;">« Previous</a></span> + + + <span style="margin-left: 15px"><a href="../REST-API/" style="color: #fcfcfc">Next »</a></span> + + </span> +</div> + <script src="../js/theme.js"></script> + +</body> +</html> -- cgit v1.2.3