Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
MyShaarli/doc/html/index.html

345 lines
12 KiB
HTML
Raw Normal View History

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
2017-01-26 18:52:54 +01:00
<!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">
<meta name="description" content="The personal, minimalist, super-fast, database free, bookmarking service">
<link rel="shortcut icon" href="./img/favicon.ico">
<title>Home - 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 = "Home";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = "/";
</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 current">
<a class="current" href=".">Home</a>
<ul class="subnav">
</ul>
</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="">
<a class="" href="FAQ/">FAQ</a>
</li>
<li class="">
<a class="" href="Community-&-Related-software/">Community & Related software</a>
</li>
</ul>
</li>
</ul>
</div>
&nbsp;
</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> &raquo;</li>
<li>Home</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/shaarli/Shaarli/edit/master/docs/index.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki!</p>
<p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p>
<p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p>
<p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> (<a href="https://github.com/shaarli/Shaarli/issues/44">archive</a>) or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>. If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p>
<p>If you would like a feature added to Shaarli, check the issues labeled <a href="https://github.com/shaarli/Shaarli/labels/feature"><code>feature</code></a>, <a href="https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement</code></a>, and <a href="https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin</code></a>.</p>
<p><em>Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the <code>doc/</code> directory of your Shaarli installation.</em></p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Download-and-Installation/" class="btn btn-neutral float-right" title="Download and Installation">Next <span class="icon icon-circle-arrow-right"></span></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 style="margin-left: 15px"><a href="Download-and-Installation/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="./js/theme.js"></script>
</body>
</html>
<!--
MkDocs version : 0.16.3
Build Date UTC : 2017-06-17 22:04:25
-->
Reference in a new issue Copy permalink