doc/html/Features/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
   9
  10   <link rel="shortcut icon" href="../img/favicon.ico">
  11   <title>Features - 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 = "Features";
  22     var mkdocs_page_input_path = "Features.md";
  23     var mkdocs_page_url = "/Features/";
  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">
  52
  53     <a class="" href="..">Home</a>
  54             </li>
  55
  56             <li class="toctree-l1">
  57
  58     <span class="caption-text">Setup</span>
  59     <ul class="subnav">
  60                 <li class="">
  61
  62     <a class="" href="../Download-and-Installation/">Download and Installation</a>
  63                 </li>
  64                 <li class="">
  65
  66     <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
  67                 </li>
  68                 <li class="">
  69
  70     <a class="" href="../Server-requirements/">Server requirements</a>
  71                 </li>
  72                 <li class="">
  73
  74     <a class="" href="../Server-configuration/">Server configuration</a>
  75                 </li>
  76                 <li class="">
  77
  78     <a class="" href="../Server-security/">Server security</a>
  79                 </li>
  80                 <li class="">
  81
  82     <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
  83                 </li>
  84                 <li class="">
  85
  86     <a class="" href="../Plugins/">Plugins</a>
  87                 </li>
  88     </ul>
  89             </li>
  90
  91             <li class="toctree-l1">
  92
  93     <span class="caption-text">Docker</span>
  94     <ul class="subnav">
  95                 <li class="">
  96
  97     <a class="" href="../Docker-101/">Docker 101</a>
  98                 </li>
  99                 <li class="">
 100
 101     <a class="" href="../Shaarli-images/">Shaarli images</a>
 102                 </li>
 103                 <li class="">
 104
 105     <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
 106                 </li>
 107                 <li class="">
 108
 109     <a class="" href="../Docker-resources/">Docker resources</a>
 110                 </li>
 111     </ul>
 112             </li>
 113
 114             <li class="toctree-l1">
 115
 116     <span class="caption-text">Usage</span>
 117     <ul class="subnav">
 118                 <li class=" current">
 119
 120     <a class="current" href="./">Features</a>
 121     <ul class="subnav">
 122
 123     <li class="toctree-l3"><a href="#main-features">Main features</a></li>
 124
 125
 126     <li class="toctree-l3"><a href="#using-shaarli-as-a-blog-notepad-pastebin">Using Shaarli as a blog, notepad, pastebin...</a></li>
 127
 128
 129     </ul>
 130                 </li>
 131                 <li class="">
 132
 133     <a class="" href="../Bookmarklet/">Bookmarklet</a>
 134                 </li>
 135                 <li class="">
 136
 137     <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
 138                 </li>
 139                 <li class="">
 140
 141     <a class="" href="../Firefox-share/">Firefox share</a>
 142                 </li>
 143                 <li class="">
 144
 145     <a class="" href="../RSS-feeds/">RSS feeds</a>
 146                 </li>
 147                 <li class="">
 148
 149     <a class="" href="../REST-API/">REST API</a>
 150                 </li>
 151     </ul>
 152             </li>
 153
 154             <li class="toctree-l1">
 155
 156     <span class="caption-text">How To</span>
 157     <ul class="subnav">
 158                 <li class="">
 159
 160     <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
 161                 </li>
 162                 <li class="">
 163
 164     <a class="" href="../Various-hacks/">Various hacks</a>
 165                 </li>
 166     </ul>
 167             </li>
 168
 169             <li class="toctree-l1">
 170
 171     <a class="" href="../Troubleshooting/">Troubleshooting</a>
 172             </li>
 173
 174             <li class="toctree-l1">
 175
 176     <span class="caption-text">Development</span>
 177     <ul class="subnav">
 178                 <li class="">
 179
 180     <a class="" href="../Development-guidelines/">Development guidelines</a>
 181                 </li>
 182                 <li class="">
 183
 184     <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
 185                 </li>
 186                 <li class="">
 187
 188     <a class="" href="../GnuPG-signature/">GnuPG signature</a>
 189                 </li>
 190                 <li class="">
 191
 192     <a class="" href="../Coding-guidelines/">Coding guidelines</a>
 193                 </li>
 194                 <li class="">
 195
 196     <a class="" href="../Directory-structure/">Directory structure</a>
 197                 </li>
 198                 <li class="">
 199
 200     <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
 201                 </li>
 202                 <li class="">
 203
 204     <a class="" href="../Plugin-System/">Plugin System</a>
 205                 </li>
 206                 <li class="">
 207
 208     <a class="" href="../Release-Shaarli/">Release Shaarli</a>
 209                 </li>
 210                 <li class="">
 211
 212     <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
 213                 </li>
 214                 <li class="">
 215
 216     <a class="" href="../Security/">Security</a>
 217                 </li>
 218                 <li class="">
 219
 220     <a class="" href="../Static-analysis/">Static analysis</a>
 221                 </li>
 222                 <li class="">
 223
 224     <a class="" href="../Theming/">Theming</a>
 225                 </li>
 226                 <li class="">
 227
 228     <a class="" href="../Unit-tests/">Unit tests</a>
 229                 </li>
 230     </ul>
 231             </li>
 232
 233             <li class="toctree-l1">
 234
 235     <span class="caption-text">About</span>
 236     <ul class="subnav">
 237                 <li class="">
 238
 239     <a class="" href="../FAQ/">FAQ</a>
 240                 </li>
 241                 <li class="">
 242
 243     <a class="" href="../Community-&-Related-software/">Community & Related software</a>
 244                 </li>
 245     </ul>
 246             </li>
 247
 248         </ul>
 249       </div>
 250       &nbsp;
 251     </nav>
 252
 253     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 254
 255
 256       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 257         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 258         <a href="..">Shaarli Documentation</a>
 259       </nav>
 260
 261
 262       <div class="wy-nav-content">
 263         <div class="rst-content">
 264           <div role="navigation" aria-label="breadcrumbs navigation">
 265   <ul class="wy-breadcrumbs">
 266     <li><a href="..">Docs</a> &raquo;</li>
 267
 268
 269
 270           <li>Usage &raquo;</li>
 271
 272
 273
 274     <li>Features</li>
 275     <li class="wy-breadcrumbs-aside">
 276
 277         <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Features.md"
 278           class="icon icon-github"> Edit on GitHub</a>
 279
 280     </li>
 281   </ul>
 282   <hr/>
 283 </div>
 284           <div role="main">
 285             <div class="section">
 286
 287                 <h3 id="main-features">Main features</h3>
 288 <p>Shaarli is intended:
 289  * to share, comment and save interesting links and news
 290  * to bookmark useful/frequent personal links (as private links) and share them between computers
 291  * as a minimal blog/microblog/writing platform (no character limit)
 292  * as a read-it-later list (for example items tagged <code>readlater</code>)
 293  * to draft and save articles/ideas
 294  * to keep code snippets
 295  * to keep notes and documentation
 296  * as a shared clipboard between machines
 297  * as a todo list
 298  * to store playlists (e.g. with the <code>music</code> or <code>video</code> tags)
 299  * to keep extracts/comments from webpages that may disappear
 300  * to keep track of ongoing discussions (for example items tagged <code>discussion</code>)
 301  * <a href="http://shaarli.chassegnouf.net/?9Efeiw">to feed RSS aggregators</a> (planets) with specific tags
 302  * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)</p>
 303 <h3 id="using-shaarli-as-a-blog-notepad-pastebin">Using Shaarli as a blog, notepad, pastebin...</h3>
 304 <ul>
 305 <li>Go to your Shaarli setup and log in</li>
 306 <li>Click the <code>Add Link</code> button</li>
 307 <li>To share text only, do not enter any URL in the corresponding input field and click <code>Add Link</code></li>
 308 <li>Pick a title and enter your article, or note, in the description field; add a few tags; optionally check <code>Private</code> then click <code>Save</code></li>
 309 <li>Voilà!  Your article is now published (privately if you selected that option) and accessible using its permalink.</li>
 310 </ul>
 311
 312             </div>
 313           </div>
 314           <footer>
 315
 316     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 317
 318         <a href="../Bookmarklet/" class="btn btn-neutral float-right" title="Bookmarklet">Next <span class="icon icon-circle-arrow-right"></span></a>
 319
 320
 321         <a href="../Docker-resources/" class="btn btn-neutral" title="Docker resources"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 322
 323     </div>
 324
 325
 326   <hr/>
 327
 328   <div role="contentinfo">
 329     <!-- Copyright etc -->
 330
 331   </div>
 332
 333   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>.
 334 </footer>
 335
 336         </div>
 337       </div>
 338
 339     </section>
 340
 341   </div>
 342
 343   <div class="rst-versions" role="note" style="cursor: pointer">
 344     <span class="rst-current-version" data-toggle="rst-current-version">
 345
 346           <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
 347
 348
 349         <span><a href="../Docker-resources/" style="color: #fcfcfc;">&laquo; Previous</a></span>
 350
 351
 352         <span style="margin-left: 15px"><a href="../Bookmarklet/" style="color: #fcfcfc">Next &raquo;</a></span>
 353
 354     </span>
 355 </div>
 356     <script src="../js/theme.js"></script>
 357
 358 </body>
 359 </html>