rbcli 0.2.8 → 0.3.0

data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md

@@ -0,0 +1,56 @@
+---
+date: 2016-04-09T16:50:16+02:00
+title: Configuration
+weight: 20
+---
+
+## Paramètres globaux du site
+
+En plus de la [configuration globale d'Hugo](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** vous permet de définir les paramètres suivant dans votre fichier `config.toml` (ci-dessous sont affichées les valeurs par défaut).
+
+Notez que certains de ces paramètres sont expliqués en détails dans d'autres sections de cette documentation.
+
+```toml
+[params]
+  # L'URL préfixe pour éditer la page courante. Ce paramètre affichera un bouton "Modifier cette page" on haut de de chacune des pages.
+  # Pratique pour donner les possibilité à vos utilisateurs de créer une merge request pour votre doc.
+  # Allez voir le fichier config.toml de cette documentation pour avoir un exemple.
+  editURL = ""
+  # Autheur du site, est utilisé dans les informations meta
+  author = ""
+  # Description du site, est utilisé dans les informations meta
+  description = ""
+  # Affiche une icône lorsque la page a été visitée
+  showVisitedLinks = false
+  # Désactive la fonction de recherche. Une valeur à true cache la barre de recherche.
+  disableSearch = false
+  # Par défaut, le cache Javascript et CSS est automatiquement vidé lorsqu'une nouvelle version du site est générée.
+  # Utilisez ce paramètre lorsque vous voulez désactiver ce comportement (c'est parfois incompatible avec certains proxys)
+  disableAssetsBusting = false
+  # Utilisez ce paramètre pour désactiver le bouton copy-to-clipboard pour le code formatté sur une ligne.
+  disableInlineCopyToClipBoard = false
+  # Un titre est défini par défaut lorsque vous utilisez un raccourci dans le menu. Utilisez ce paramètre pour le cacher.
+  disableShortcutsTitle = false
+  # Quand vous utilisez un site multi-langue, utilisez ce paramètre pour désactiver le bouton de changement de langue.
+  disableLanguageSwitchingButton = false
+  # Ordonne les sections dans menu par poids ("weight") ou titre ("title"). Défaut à "weight"
+  ordersectionsby = "weight"
+  # Utilisez ce paramètre pour modifier le schéma de couleur du site. Les valeurs par défaut sont "red", "blue", "green".
+  themeVariant = ""
+  # Fournissez une liste de fichiers css personnalisés à charger par rapport depuis le dossier `static/` à la racine du site.
+  custom_css = ["css/foo.css", "css/bar.css"]
+```
+
+## Activer la recherche {#activer-recherche}
+
+Si ce n'est pas déjà présent, ajoutez les lignes suivantes dans le fichier `config.toml`.
+
+```toml
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+```
+
+Le thème *Learn* utilise les dernières améliorations d'Hugo pour générer un fichier d'index JSON, prêt à être consommé par le moteur de recherche lunr.js.
+
+> Hugo génère lunrjs index.json à la racine du dossier `public`.
+> Quand vous générez le site avec `hugo server`, Hugo génère le fichier en mémoire, il n'est donc pas disponible sur le disque.

data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md

@@ -0,0 +1,102 @@
+---
+title: Installation
+weight: 15
+---
+
+The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you learn more about it by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
+
+## Create your project
+
+Hugo provides a `new` command to create a new website.
+
+```
+hugo new site <new_project>
+```
+
+## Install the theme
+
+Install the **Hugo-theme-learn** theme by following [this documentation](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme)
+
+This theme's repository is: https://github.com/matcornic/hugo-theme-learn.git
+
+Alternatively, you can [download the theme as .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) file and extract it in the `themes` directory
+
+## Basic configuration
+
+When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`config.toml`) and set the theme as the default. You can also add the `[outputs]` section to enable the search functionality.
+
+```toml
+# Change the default theme to be use when building the site with Hugo
+theme = "hugo-theme-learn"
+
+# For search functionality
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+```
+
+## Create your first chapter page
+
+Chapters are pages that contain other child pages. It has a special layout style and usually just contains a _chapter name_, the _title_ and a _brief abstract_ of the section.
+
+```
+### Chapter 1
+
+# Basics
+
+Discover what this Hugo theme is all about and the core concepts behind it.
+```
+
+renders as 
+
+![A Chapter](/en/basics/installation/images/chapter.png?classes=shadow&width=60pc)
+
+**Hugo-theme-learn** provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command
+
+```
+hugo new --kind chapter basics/_index.md
+```
+
+By opening the given file, you should see the property `chapter=true` on top, meaning this page is a _chapter_.
+
+By default all chapters and pages are created as a draft. If you want to render these pages, remove the property `draft: true` from the metadata.
+
+## Create your first content pages
+
+Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:
+
+```
+hugo new basics/first-content.md
+hugo new basics/second-content/_index.md
+```
+
+Feel free to edit thoses files by adding some sample content and replacing the `title` value in the beginning of the files. 
+
+## Launching the website locally
+
+Launch by using the following command:
+
+```
+hugo serve
+```
+
+Go to `http://localhost:1313`
+
+You should notice three things:
+
+1. You have a left-side **Basics** menu, containing two submenus with names equal to the `title` properties in the previously created files.
+2. The home page explains how to customize it by following the instructions.
+3. When you run `hugo serve`, when the contents of the files change, the page automatically refreshes with the changes. Neat!
+
+## Build the website
+
+When your site is ready to deploy, run the following command:
+
+```
+hugo
+```
+
+A `public` folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.
+
+{{% notice note %}}
+This website can be automatically published and hosted with [Netlify](https://www.netlify.com/) (Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Alternatively, you can use [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/)
+{{% /notice %}}

data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.fr.md

@@ -0,0 +1,100 @@
+---
+title: Installation
+weight: 15
+---
+
+Les étapes suivantes sont là pour vous aider à initialiser votre site. Si vous ne connaissez pas du tout Hugo, il est fortement conseillé de vous entrainer en suivant ce [super tuto pour débutants](https://gohugo.io/overview/quickstart/).
+
+## Créer votre projet
+
+Hugo fournit une commande `new` pour créer un nouveau site.
+
+```
+hugo new site <new_project>
+```
+
+## Installer le thème
+
+Installer le thème **Hugo-theme-learn** en suivant [cette documentation](https://gohugo.io/themes/installing/)
+
+Le repo du thème est : https://github.com/matcornic/hugo-theme-learn.git
+
+Sinon, vous pouvez [télécharger le thème sous forme d'un fichier .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) et extrayez le dans votre dossier de thèmes.
+
+## Configuration simple
+
+Lorsque vous générez votre site, vous pouvez définir un thème en utilisant l'option `--theme`. Il est conseillé de modifier votre fichier de configuration `config.toml` and définir votre thème par défaut. En passant, ajoutez les prérequis à l'utilisation de la fonctionnalité de recherche.
+
+```toml
+# Modifiez le thème pour qu'il soit utilisé par défaut à chaque génération de site.
+theme = "hugo-theme-learn"
+
+# Pour la fonctionnalité de recherche
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+```
+
+## Créer votre première page chapitre
+
+Les *chapitres* sont des pages contenant d'autre pages filles. Elles ont un affichage spécial et contiennent habituellement juste un _nom_ de chapitre, le _titre_ et un _résumé_ de la section.
+
+```
+### Chapitre 1
+
+# Démarrage
+
+Découvrez comment utiliser ce thème Hugo et apprenez en les concepts
+```
+
+s'affiche comme
+
+![Un chapitre](/en/basics/installation/images/chapter.png?classes=shadow&width=60pc)
+
+**Hugo-theme-learn** fournit des archétypes pour créer des squelettes pour votre site. Commencez par créer votre premier chapitre avec la commande suivante:
+
+```
+hugo new --kind chapter basics/_index.md
+```
+
+En ouvrant le fichier généré, vous devriez voir la propriété `chapter=true` en haut, paramètre quit définit que le page est un _chapitre_.
+
+## Créer votre première page
+
+Puis, créez votre premier page dans le chapitre précédent. Pour ce faire, il existe deux possibilités :
+
+```
+hugo new basics/first-content.md
+hugo new basics/second-content/_index.md
+```
+
+N'hésitez pas à éditer ces fichiers en ajoutant des exemple de contenu et en remplaçant le paramètre `title` au début du fichier. 
+
+## Lancer le site localement
+
+Lancez la commande suivante :
+
+```
+hugo serve
+```
+
+Se rendre sur `http://localhost:1313`
+
+Vous devriez voir trois choses:
+
+1. Vous avez un menu **Basics** à gauche, qui contient deux sous-menu avec des noms égal au paramètre `title` des fichiers précédemment générés.
+2. La page d'accueil vous explique comment la modifier. Suivez les instructions.
+3. Avec la commande `hugo serve`, la page se rafraichit automatiquement à chaque fois que vous sauvegardez. Super !
+
+## Générez le site
+
+Quand votre site est prêt à être déployé, lancez la commande suivante:
+
+```
+hugo
+```
+
+Un dossier `public` a été généré. Il contient tout le contenu statique et les ressources nécessaires pour votre site. Votre site peut maintenant être déployé en utilisant n'importe quel serveur !
+
+{{% notice note %}}
+Ce site peut être automatiquement publié et hébergé avec [Netlify](https://www.netlify.com/) ([Plus d'infos](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Sinon, vous pouvez utiliser les [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/)
+{{% /notice %}}

data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.en.md

@@ -0,0 +1,11 @@
+---
+title: Requirements
+weight: 10
+disableToc: true
+---
+
+Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.
+
+Just download latest version of [Hugo binary (> 0.25)](https://gohugo.io/getting-started/installing/) for your OS (Windows, Linux, Mac) : it's that simple.
+
+![Magic](/en/basics/requirements/images/magic.gif?classes=shadow)

data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.fr.md

@@ -0,0 +1,11 @@
+---
+title: Prérequis
+weight: 10
+disableToc: true
+---
+
+Grâce à la simplicité d'Hugo, cette page est vide car il n'y a quasi pas de prérequis pour utiliser le thème.
+
+Téléchargez la dernière version du [binaire Hugo (> 0.25)](https://gohugo.io/getting-started/installing/) pour votre Système d'exploitation (Windows, Linux, Mac) : et c'est tout !
+
+![Magic](/en/basics/requirements/images/magic.gif?classes=shadow)

data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.en.md

@@ -0,0 +1,194 @@
+---
+date: 2016-04-09T16:50:16+02:00
+title: Style customization
+weight: 25
+---
+
+**Hugo-theme-learn** has been built to be as configurable as possible by defining multiple [partials](https://gohugo.io/templates/partials/)
+
+In `themes/hugo-theme-learn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don't change the code directly. Instead [follow this page](https://gohugo.io/themes/customizing/). You'd create a new partial in the `layouts/partials` folder of your local project. This partial will have the priority.
+
+This theme defines the following partials :
+
+- *header*: the header of the content page (contains the breadcrumbs). _Not meant to be overwritten_
+- *custom-header*: custom headers in page. Meant to be overwritten when adding CSS imports. Don't forget to include `style` HTML tag directive in your file
+- *footer*: the footer of the content page (contains the arrows). _Not meant to be overwritten_
+- *custom-footer*:  custom footer in page. Meant to be overwritten when adding Javacript. Don't forget to include `javascript` HTML tag directive in your file
+- *favicon*: the favicon
+- *logo*: the logo, on top left hand corner.
+- *meta*: HTML meta tags, if you want to change default behavior
+- *menu*: left menu. _Not meant to be overwritten_
+- *menu-footer*: footer of the the left menu
+- *search*: search box
+- *toc*: table of contents
+
+## Change the logo
+
+Create a new file in `layouts/partials/` named `logo.html`. Then write any HTML you want.
+You could use an `img` HTML tag and reference an image created under the *static* folder, or you could paste a SVG definition !
+
+{{% notice note %}}
+The size of the logo will adapt automatically
+{{% /notice %}}
+
+## Change the favicon
+
+If your favicon is a png, just drop off your image in your local `static/images/` folder and name it `favicon.png`
+
+If you need to change this default behavior, create a new file in `layouts/partials/` named `favicon.html`. Then write something like this:
+
+```html
+<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />
+```
+
+## Change default colors {#theme-variant}
+
+**Hugo Learn theme** let you choose between 3 native color scheme variants, but feel free to add one yourself ! Default color scheme is based on [Grav Learn Theme](https://learn.getgrav.org/).
+
+### Red variant
+
+```toml
+[params]
+  # Change default color scheme with a variant one. Can be "red", "blue", "green".
+  themeVariant = "red"
+```
+
+![Red variant](/en/basics/style-customization/images/red-variant.png?width=60pc)
+
+### Blue variant
+
+```toml
+[params]
+  # Change default color scheme with a variant one. Can be "red", "blue", "green".
+  themeVariant = "blue"
+```
+
+![Blue variant](/en/basics/style-customization/images/blue-variant.png?width=60pc)
+
+### Green variant
+
+```toml
+[params]
+  # Change default color scheme with a variant one. Can be "red", "blue", "green".
+  themeVariant = "green"
+```
+
+![Green variant](/en/basics/style-customization/images/green-variant.png?width=60pc)
+
+### 'Yours‘ variant
+
+First, create a new CSS file in your local `static/css` folder prefixed by `theme` (e.g. with _mine_ theme `static/css/theme-mine.css`). Copy the following content and modify colors in CSS variables.
+
+```css
+
+:root{
+    
+    --MAIN-TEXT-color:#323232; /* Color of text by default */
+    --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */
+    --MAIN-LINK-color:#1C90F3; /* Color of links */
+    --MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */
+    --MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */
+
+    --MENU-HEADER-BG-color:#1C90F3; /* Background color of menu header */
+    --MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */ 
+
+    --MENU-SEARCH-BG-color:#167ad0; /* Search field background color (by default borders + icons) */
+    --MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */
+    --MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field icons color */
+
+    --MENU-SECTIONS-ACTIVE-BG-color:#20272b; /* Background color of the active section and its childs */
+    --MENU-SECTIONS-BG-color:#252c31; /* Background color of other sections */
+    --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */
+    --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6;  /* Color of links in menu, when hovered */
+    --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
+    --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
+
+    --MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */
+    --MENU-SECTION-HR-color: #20272b; /* Color of <hr> separator in menu */
+    
+}
+
+body {
+    color: var(--MAIN-TEXT-color) !important;
+}
+
+textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus {
+    border-color: none;
+    box-shadow: none;
+}
+
+h2, h3, h4, h5 {
+    color: var(--MAIN-TITLES-TEXT-color) !important;
+}
+
+a {
+    color: var(--MAIN-LINK-color);
+}
+
+.anchor {
+    color: var(--MAIN-ANCHOR-color);
+}
+
+a:hover {
+    color: var(--MAIN-LINK-HOVER-color);
+}
+
+#sidebar ul li.visited > a .read-icon {
+	color: var(--MENU-VISITED-color);
+}
+
+#body a.highlight:after {
+    display: block;
+    content: "";
+    height: 1px;
+    width: 0%;
+    -webkit-transition: width 0.5s ease;
+    -moz-transition: width 0.5s ease;
+    -ms-transition: width 0.5s ease;
+    transition: width 0.5s ease;
+    background-color: var(--MAIN-LINK-HOVER-color);
+}
+#sidebar {
+	background-color: var(--MENU-SECTIONS-BG-color);
+}
+#sidebar #header-wrapper {
+    background: var(--MENU-HEADER-BG-color);
+    color: var(--MENU-SEARCH-BOX-color);
+    border-color: var(--MENU-HEADER-BORDER-color);
+}
+#sidebar .searchbox {
+	border-color: var(--MENU-SEARCH-BOX-color);
+    background: var(--MENU-SEARCH-BG-color);
+}
+#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active {
+    background: var(--MENU-SECTIONS-ACTIVE-BG-color);
+}
+#sidebar .searchbox * {
+    color: var(--MENU-SEARCH-BOX-ICONS-color);
+}
+
+#sidebar a {
+    color: var(--MENU-SECTIONS-LINK-color);
+}
+
+#sidebar a:hover {
+    color: var(--MENU-SECTIONS-LINK-HOVER-color);
+}
+
+#sidebar ul li.active > a {
+    background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color);
+    color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important;
+}
+
+#sidebar hr {
+    border-color: var(--MENU-SECTION-HR-color);
+}
+```
+
+Then, set the `themeVariant` value with the name of your custom theme file. That's it !
+
+```toml
+[params]
+  # Change default color scheme with a variant one. Can be "red", "blue", "green".
+  themeVariant = "mine"
+```