doc/html/index.html

   1 <!DOCTYPE html>
   2 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   3 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   4 <head>
   5   <meta charset="utf-8">
   6   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   7   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   8   <meta name="description" content="The personal, minimalist, super-fast, database free, bookmarking service">
   9
  10   <link rel="shortcut icon" href="./img/favicon.ico">
  11   <title>Home - Shaarli Documentation</title>
  12   <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  13
  14   <link rel="stylesheet" href="./css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
  16   <link rel="stylesheet" href="./css/highlight.css">
  17   <link href="./github-markdown.css" rel="stylesheet">
  18
  19   <script>
  20     // Current page data
  21     var mkdocs_page_name = "Home";
  22     var mkdocs_page_input_path = "index.md";
  23     var mkdocs_page_url = "/";
  24   </script>
  25
  26   <script src="./js/jquery-2.1.1.min.js"></script>
  27   <script src="./js/modernizr-2.8.3.min.js"></script>
  28   <script type="text/javascript" src="./js/highlight.pack.js"></script>
  29
  30 </head>
  31
  32 <body class="wy-body-for-nav" role="document">
  33
  34   <div class="wy-grid-for-nav">
  35
  36
  37     <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  38       <div class="wy-side-nav-search">
  39         <a href="." class="icon icon-home"> Shaarli Documentation</a>
  40         <div role="search">
  41   <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
  42     <input type="text" name="q" placeholder="Search docs" />
  43   </form>
  44 </div>
  45       </div>
  46
  47       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  48         <ul class="current">
  49
  50
  51             <li class="toctree-l1 current">
  52
  53     <a class="current" href=".">Home</a>
  54     <ul class="subnav">
  55
  56     </ul>
  57             </li>
  58
  59             <li class="toctree-l1">
  60
  61     <span class="caption-text">Setup</span>
  62     <ul class="subnav">
  63                 <li class="">
  64
  65     <a class="" href="Download-and-Installation/">Download and Installation</a>
  66                 </li>
  67                 <li class="">
  68
  69     <a class="" href="Upgrade-and-migration/">Upgrade and migration</a>
  70                 </li>
  71                 <li class="">
  72
  73     <a class="" href="Server-requirements/">Server requirements</a>
  74                 </li>
  75                 <li class="">
  76
  77     <a class="" href="Server-configuration/">Server configuration</a>
  78                 </li>
  79                 <li class="">
  80
  81     <a class="" href="Server-security/">Server security</a>
  82                 </li>
  83                 <li class="">
  84
  85     <a class="" href="Shaarli-configuration/">Shaarli configuration</a>
  86                 </li>
  87                 <li class="">
  88
  89     <a class="" href="Plugins/">Plugins</a>
  90                 </li>
  91     </ul>
  92             </li>
  93
  94             <li class="toctree-l1">
  95
  96     <span class="caption-text">Docker</span>
  97     <ul class="subnav">
  98                 <li class="">
  99
 100     <a class="" href="Docker-101/">Docker 101</a>
 101                 </li>
 102                 <li class="">
 103
 104     <a class="" href="Shaarli-images/">Shaarli images</a>
 105                 </li>
 106                 <li class="">
 107
 108     <a class="" href="Reverse-proxy-configuration/">Reverse proxy configuration</a>
 109                 </li>
 110                 <li class="">
 111
 112     <a class="" href="Docker-resources/">Docker resources</a>
 113                 </li>
 114     </ul>
 115             </li>
 116
 117             <li class="toctree-l1">
 118
 119     <span class="caption-text">Usage</span>
 120     <ul class="subnav">
 121                 <li class="">
 122
 123     <a class="" href="Features/">Features</a>
 124                 </li>
 125                 <li class="">
 126
 127     <a class="" href="Bookmarklet/">Bookmarklet</a>
 128                 </li>
 129                 <li class="">
 130
 131     <a class="" href="Browsing-and-searching/">Browsing and searching</a>
 132                 </li>
 133                 <li class="">
 134
 135     <a class="" href="Firefox-share/">Firefox share</a>
 136                 </li>
 137                 <li class="">
 138
 139     <a class="" href="RSS-feeds/">RSS feeds</a>
 140                 </li>
 141                 <li class="">
 142
 143     <a class="" href="REST-API/">REST API</a>
 144                 </li>
 145     </ul>
 146             </li>
 147
 148             <li class="toctree-l1">
 149
 150     <span class="caption-text">How To</span>
 151     <ul class="subnav">
 152                 <li class="">
 153
 154     <a class="" href="Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
 155                 </li>
 156                 <li class="">
 157
 158     <a class="" href="Various-hacks/">Various hacks</a>
 159                 </li>
 160     </ul>
 161             </li>
 162
 163             <li class="toctree-l1">
 164
 165     <a class="" href="Troubleshooting/">Troubleshooting</a>
 166             </li>
 167
 168             <li class="toctree-l1">
 169
 170     <span class="caption-text">Development</span>
 171     <ul class="subnav">
 172                 <li class="">
 173
 174     <a class="" href="Development-guidelines/">Development guidelines</a>
 175                 </li>
 176                 <li class="">
 177
 178     <a class="" href="Continuous-integration-tools/">Continuous integration tools</a>
 179                 </li>
 180                 <li class="">
 181
 182     <a class="" href="GnuPG-signature/">GnuPG signature</a>
 183                 </li>
 184                 <li class="">
 185
 186     <a class="" href="Coding-guidelines/">Coding guidelines</a>
 187                 </li>
 188                 <li class="">
 189
 190     <a class="" href="Directory-structure/">Directory structure</a>
 191                 </li>
 192                 <li class="">
 193
 194     <a class="" href="3rd-party-libraries/">3rd party libraries</a>
 195                 </li>
 196                 <li class="">
 197
 198     <a class="" href="Plugin-System/">Plugin System</a>
 199                 </li>
 200                 <li class="">
 201
 202     <a class="" href="Release-Shaarli/">Release Shaarli</a>
 203                 </li>
 204                 <li class="">
 205
 206     <a class="" href="Versioning-and-Branches/">Versioning and Branches</a>
 207                 </li>
 208                 <li class="">
 209
 210     <a class="" href="Security/">Security</a>
 211                 </li>
 212                 <li class="">
 213
 214     <a class="" href="Static-analysis/">Static analysis</a>
 215                 </li>
 216                 <li class="">
 217
 218     <a class="" href="Theming/">Theming</a>
 219                 </li>
 220                 <li class="">
 221
 222     <a class="" href="Unit-tests/">Unit tests</a>
 223                 </li>
 224     </ul>
 225             </li>
 226
 227             <li class="toctree-l1">
 228
 229     <span class="caption-text">About</span>
 230     <ul class="subnav">
 231                 <li class="">
 232
 233     <a class="" href="FAQ/">FAQ</a>
 234                 </li>
 235                 <li class="">
 236
 237     <a class="" href="Community-&-Related-software/">Community & Related software</a>
 238                 </li>
 239     </ul>
 240             </li>
 241
 242         </ul>
 243       </div>
 244       &nbsp;
 245     </nav>
 246
 247     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 248
 249
 250       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 251         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 252         <a href=".">Shaarli Documentation</a>
 253       </nav>
 254
 255
 256       <div class="wy-nav-content">
 257         <div class="rst-content">
 258           <div role="navigation" aria-label="breadcrumbs navigation">
 259   <ul class="wy-breadcrumbs">
 260     <li><a href=".">Docs</a> &raquo;</li>
 261
 262
 263
 264     <li>Home</li>
 265     <li class="wy-breadcrumbs-aside">
 266
 267         <a href="https://github.com/shaarli/Shaarli/edit/master/docs/index.md"
 268           class="icon icon-github"> Edit on GitHub</a>
 269
 270     </li>
 271   </ul>
 272   <hr/>
 273 </div>
 274           <div role="main">
 275             <div class="section">
 276
 277                 <p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki!</p>
 278 <p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p>
 279 <p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p>
 280 <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>
 281 <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>
 282 <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>
 283
 284             </div>
 285           </div>
 286           <footer>
 287
 288     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 289
 290         <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>
 291
 292
 293     </div>
 294
 295
 296   <hr/>
 297
 298   <div role="contentinfo">
 299     <!-- Copyright etc -->
 300
 301   </div>
 302
 303   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>.
 304 </footer>
 305
 306         </div>
 307       </div>
 308
 309     </section>
 310
 311   </div>
 312
 313   <div class="rst-versions" role="note" style="cursor: pointer">
 314     <span class="rst-current-version" data-toggle="rst-current-version">
 315
 316           <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
 317
 318
 319
 320         <span style="margin-left: 15px"><a href="Download-and-Installation/" style="color: #fcfcfc">Next &raquo;</a></span>
 321
 322     </span>
 323 </div>
 324     <script src="./js/theme.js"></script>
 325
 326 </body>
 327 </html>
 328
 329 <!--
 330 MkDocs version : 0.16.3
 331 Build Date UTC : 2017-06-18 04:31:25
 332 -->