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/FAQ/index.html | 388 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 388 insertions(+)
create mode 100644 doc/html/FAQ/index.html
(limited to 'doc/html/FAQ/index.html')
diff --git a/doc/html/FAQ/index.html b/doc/html/FAQ/index.html
new file mode 100644
index 00000000..c48e11f8
--- /dev/null
+++ b/doc/html/FAQ/index.html
@@ -0,0 +1,388 @@
+<!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>FAQ - 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 = "FAQ";
+ var mkdocs_page_input_path = "FAQ.md";
+ var mkdocs_page_url = "/FAQ/";
+ </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="">
+
+ <a class="" href="../RSS-feeds/">RSS feeds</a>
+ </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=" current">
+
+ <a class="current" href="./">FAQ</a>
+ <ul class="subnav">
+
+ <li class="toctree-l3"><a href="#why-did-you-create-shaarli">Why did you create Shaarli ?</a></li>
+
+
+ <li class="toctree-l3"><a href="#why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</a></li>
+
+
+ <li class="toctree-l3"><a href="#what-does-shaarli-mean">What does Shaarli mean?</a></li>
+
+
+ <li class="toctree-l3"><a href="#my-shaarli-is-broken">My Shaarli is broken!</a></li>
+
+
+ <li class="toctree-l3"><a href="#why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</a></li>
+
+
+ </ul>
+ </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>About »</li>
+
+
+
+ <li>FAQ</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/shaarli/Shaarli/edit/master/docs/FAQ.md"
+ class="icon icon-github"> Edit on GitHub</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h3 id="why-did-you-create-shaarli">Why did you create Shaarli ?</h3>
+<p>I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… <strong>their Firefox addon sends to Diigo every single URL you visit</strong> (Don't believe me ? Use <a href="https://addons.mozilla.org/en-US/firefox/addon/tamper-data/">Tamper Data</a> and open any page).</p>
+<p>Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server.</p>
+<h3 id="why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</h3>
+<p>With Shaarli:</p>
+<ul>
+<li>The data is yours: It's hosted on your server.</li>
+<li>Never fear of having your data locked-in.</li>
+<li>Never fear to have your data sold to third party.</li>
+<li>Your private links are not hosted on a third party server.</li>
+<li>You are not tracked by browser addons (like Diigo does)</li>
+<li>You can change the look and feel of the pages if you want.</li>
+<li>You can change the behaviour of the program.</li>
+<li>It's magnitude faster than most bookmarking services.</li>
+</ul>
+<h3 id="what-does-shaarli-mean">What does Shaarli mean?</h3>
+<p>Shaarli is for shaaring your links.</p>
+<h3 id="my-shaarli-is-broken">My Shaarli is broken!</h3>
+<p>First of all, ensure that both the <a href="../Server-configuration">web server</a> and <a href="../Shaarli-configuration">Shaarli</a> are correctly configured, and that your installation is <a href="../Server-requirements">supported</a>.</p>
+<p>If everything looks right but the issue(s) remain(s), please:
+- take a look at the <a href="../Troubleshooting">troubleshooting</a> section
+- come <a href="https://gitter.im/shaarli/Shaarli">chat with us</a> on Gitter, we'll be happy to help ;-)
+- browse active <a href="https://github.com/shaarli/Shaarli/issues">issues</a> and <a href="https://github.com/shaarli/Shaarli/pulls">Pull Requests</a>
+ - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup)
+ - else, <a href="https://github.com/shaarli/Shaarli/issues/new">open a new issue</a>, and provide information about the problem:
+ - <em>what happens?</em> - display glitches, invalid data, security flaws...
+ - <em>what is your configuration?</em> - OS, server version, activated extensions, web browser...
+ - <em>is it reproducible?</em></p>
+<h3 id="why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</h3>
+<p>Does browsing <a href="http://sebsauvage.net/links/">this page</a> feel slow? Try browsing older pages, too.</p>
+<p>It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why?</p>
+<p>The data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time.</p>
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../Community-&-Related-software/" class="btn btn-neutral float-right" title="Community & Related software">Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../Unit-tests/" class="btn btn-neutral" title="Unit tests"><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="../Unit-tests/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../Community-&-Related-software/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+ <script src="../js/theme.js"></script>
+
+</body>
+</html>
--
cgit v1.2.3
From 0433c688b9be6097b85a8fec31b3dacd0ab81677 Mon Sep 17 00:00:00 2001
From: nodiscc <nodiscc@gmail.com>
Date: Sun, 18 Jun 2017 06:32:30 +0200
Subject: make htmlpages
---
doc/html/FAQ/index.html | 14 +-------------
1 file changed, 1 insertion(+), 13 deletions(-)
(limited to 'doc/html/FAQ/index.html')
diff --git a/doc/html/FAQ/index.html b/doc/html/FAQ/index.html
index c48e11f8..f8ced260 100644
--- a/doc/html/FAQ/index.html
+++ b/doc/html/FAQ/index.html
@@ -152,19 +152,7 @@
</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>
+ <a class="" href="../Various-hacks/">Various hacks</a>
</li>
</ul>
</li>
--
cgit v1.2.3