docs/README.html

   1 <!DOCTYPE html>
   2 <!--[if lt IE 7]>       <html class="no-js ie6 oldie" lang="en"> <![endif]-->
   3 <!--[if IE 7]>          <html class="no-js ie7 oldie" lang="en"> <![endif]-->
   4 <!--[if IE 8]>          <html class="no-js ie8 oldie" lang="en"> <![endif]-->
   5 <!--[if gt IE 8]><!-->  <html class="no-js" lang="en"> <!--<![endif]-->
   6 <head>
   7     <title>README</title>
   8     <meta charset="utf-8">
   9     <meta name="description" content="Documentation for wallabag" />
  10     <meta name="author" content="Nicolas Lœuillet">
  11     <link rel="icon" href="templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
  12     <!-- Mobile -->
  13     <meta name="apple-mobile-web-app-capable" content="yes" />
  14     <meta name="viewport" content="width=device-width, initial-scale=1.0">
  15
  16     <!-- Font -->
  17
  18     <!-- CSS -->
  19     <link href='templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
  20 </head>
  21 <body>
  22             <!-- Docs -->
  23                 <div class="container-fluid fluid-height wrapper">
  24             <div class="navbar navbar-fixed-top hidden-print">
  25                 <div class="container-fluid">
  26                     <a class="brand navbar-brand pull-left" href="index.html">wallabag</a>
  27                     <p class="navbar-text pull-right">Generated by <a href="http://daux.io">Daux.io</a></p>
  28                 </div>
  29             </div>
  30             <div class="row columns content">
  31                 <div class="left-column article-tree col-sm-3 hidden-print">
  32                     <!-- For Mobile -->
  33                     <div class="responsive-collapse">
  34                         <button type="button" class="btn btn-sidebar" id="menu-spinner-button">
  35                             <span class="icon-bar"></span>
  36                             <span class="icon-bar"></span>
  37                             <span class="icon-bar"></span>
  38                         </button>
  39                     </div>
  40                     <div id="sub-nav-collapse" class="sub-nav-collapse">
  41                         <!-- Navigation -->
  42                         <ul class="nav nav-list"><li><a href="#" class="aj-nav folder">Deutsch</a><ul class="nav nav-list"><li><a href="de/Einfuehrung.html">Einfuehrung</a></li><li><a href="de/wallabag_unterstuetzen.html">wallabag unterstuetzen</a></li><li><a href="de/Anwenderdokumentation/index.html" class="folder">Anwenderdokumentation</a><ul class="nav nav-list"><li><a href="de/Anwenderdokumentation/Herunterladen_und_installieren.html">Herunterladen und installieren</a></li><li><a href="de/Anwenderdokumentation/Den_ersten_Artikel_speichern.html">Den ersten Artikel speichern</a></li><li><a href="de/Anwenderdokumentation/Artikel_lesen.html">Artikel lesen</a></li><li><a href="de/Anwenderdokumentation/wallabag_konfigurieren.html">wallabag konfigurieren</a></li><li><a href="de/Anwenderdokumentation/Ein_Artikel_wird_nicht_korrekt_angezeigt.html">Ein Artikel wird nicht korrekt angezeigt</a></li><li><a href="de/Anwenderdokumentation/Versteckte_Einstellungen.html">Versteckte Einstellungen</a></li></ul></li></ul></li><li><a href="#" class="aj-nav folder">English</a><ul class="nav nav-list"><li><a href="en/Getting_started.html">Getting started</a></li><li><a href="en/Help_wallabag.html">Help wallabag</a></li><li><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="en/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li><a href="en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul></li><li><a href="#" class="aj-nav folder">Fran&ccedil;ais</a><ul class="nav nav-list"><li><a href="fr/Pour_commencer.html">Pour commencer</a></li><li><a href="fr/Contribuer_à_wallabag.html">Contribuer à wallabag</a></li><li><a href="#" class="aj-nav folder">Documentation utilisateur</a><ul class="nav nav-list"><li><a href="fr/Documentation_utilisateur/Téléchargement_et_installation.html">Téléchargement et installation</a></li><li><a href="fr/Documentation_utilisateur/Sauvegarder_son_premier_article.html">Sauvegarder son premier article</a></li><li><a href="fr/Documentation_utilisateur/Lire_un_article.html">Lire un article</a></li><li><a href="fr/Documentation_utilisateur/Classer_ses_articles.html">Classer ses articles</a></li><li><a href="fr/Documentation_utilisateur/Configurer_wallabag.html">Configurer wallabag</a></li><li><a href="fr/Documentation_utilisateur/Rechercher.html">Rechercher</a></li><li><a href="fr/Documentation_utilisateur/Convertir_en_ePub.html">Convertir en ePub</a></li><li><a href="fr/Documentation_utilisateur/Un_article_est_mal_affiché.html">Un article est mal affiché</a></li><li><a href="fr/Documentation_utilisateur/Flux_RSS.html">Flux RSS</a></li><li><a href="fr/Documentation_utilisateur/Importer_:_Exporter.html">Importer : Exporter</a></li><li><a href="fr/Documentation_utilisateur/Multi-utilisateurs.html">Multi-utilisateurs</a></li><li><a href="fr/Documentation_utilisateur/Se_créer_un_compte_sur_Framabag.html">Se créer un compte sur Framabag</a></li><li><a href="fr/Documentation_utilisateur/Les_options_cachées.html">Les options cachées</a></li></ul></li><li><a href="#" class="aj-nav folder">Documentation technique</a><ul class="nav nav-list"><li><a href="fr/Documentation_technique/Créer_un_nouveau_thème.html">Créer un nouveau thème</a></li><li><a href="fr/Documentation_technique/Docker.html">Docker</a></li><li><a href="fr/Documentation_technique/Dépôt_git_de_wallabag.html">Dépôt git de wallabag</a></li><li><a href="fr/Documentation_technique/Vagrant.html">Vagrant</a></li><li><a href="fr/Documentation_technique/wallabag_v2_(Symfony2).html">wallabag v2 (Symfony2)</a></li></ul></li></ul></li><li class="active"><a href="README.html">README</a></li><li><a href="#" class="aj-nav folder">Russian</a><ul class="nav nav-list"><li><a href="ru/Getting_started.html">Getting started</a></li><li><a href="ru/Help_wallabag.html">Help wallabag</a></li><li><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="ru/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="ru/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="ru/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li><a href="ru/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li><li><a href="#" class="aj-nav folder">Документация пользователя</a><ul class="nav nav-list"><li><a href="ru/Документация_пользователя/Скачать_и_установить.html">Скачать и установить</a></li><li><a href="ru/Документация_пользователя/Сохраните_свою_первую_статью.html">Сохраните свою первую статью</a></li><li><a href="ru/Документация_пользователя/Настройте_wallabag.html">Настройте wallabag</a></li><li><a href="ru/Документация_пользователя/Скрытые_настройки.html">Скрытые настройки</a></li></ul></li></ul></li></ul>                                                    <div class="well well-sidebar">
  43
  44                                 <!-- Links -->
  45                                 <a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>
  46                                 <!-- Twitter -->
  47                                                             </div>
  48                                             </div>
  49                 </div>
  50                 <div class="right-column  content-area col-sm-9">
  51                     <div class="content-page">
  52                         <article>
  53                                                             <div class="page-header sub-header clearfix">
  54                                     <h1>README                                                                                <a href="https://github.com/wallabag/documentation/blob/master/README.md" class="btn">Fix this page</a>                                    </h1>
  55                                     <span style="float: left; font-size: 10px; color: gray;">
  56                                         Monday, November 10, 2014                                    </span>
  57                                     <span style="float: right; font-size: 10px; color: gray;">
  58                                         10:18 AM                                    </span>
  59                                 </div>
  60
  61                             <h1>wallabag documentation</h1>
  62 <p>This project is a part of wallabag. It contains all the user and technical documentation of wallabag. </p>
  63 <h2>Structure</h2>
  64 <p>Each translation is contained in a folder, with sub-folders. For example, for english translation, we have: </p>
  65 <pre><code>- en
  66 | 01_User_documentation
  67 --| a file per feature
  68 --| ...
  69 | 02_Technical_documentation
  70 --| a file per feature
  71 --| ...
  72 | 00_Getting_started.md: a presentation of wallabag
  73 | 01_Help_wallabag.md: how you can contribute to the project</code></pre>
  74 <p>If you want to translate the documentation in your language, please respect this structure. </p>
  75 <h2>License</h2>
  76 <p>This documentation is under the <a href="http://en.wikipedia.org/wiki/MIT_License">MIT license</a>.</p>
  77 <p><em>Copyright © 2013-2014 Nicolas Lœuillet nicolas@loeuillet.org
  78 This work is free. You can redistribute it and/or modify it under the terms of the MIT License.
  79 See the <a href="https://github.com/wallabag/wallabag/blob/master/COPYING.md">COPYING file</a> for more details.</em></p>
  80                         </article>
  81                     </div>
  82                 </div>
  83             </div>
  84         </div>
  85
  86
  87
  88     <!-- jQuery -->
  89             <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
  90         <script>
  91             if (typeof jQuery == 'undefined')
  92                 document.write(unescape("%3Cscript src='js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
  93         </script>
  94
  95     <!-- hightlight.js -->
  96     <script src="js/highlight.min.js"></script>
  97     <script>hljs.initHighlightingOnLoad();</script>
  98
  99     <!-- JS -->
 100
 101     <!-- Front end file editor -->
 102         <script src="js/custom.js"></script>
 103     <!--[if lt IE 9]>
 104         <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
 105     <![endif]-->
 106
 107 </body>
 108 </html>
 109