rbcli 0.2.11 → 0.2.12

data/docs-src/themes/hugo-theme-learn/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Grav
+Copyright (c) 2016 MATHIEU CORNIC
+Copyright (c) 2017 Valere JEANTET
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/docs-src/themes/hugo-theme-learn/README.md

@@ -0,0 +1,60 @@
+# Hugo Learn Theme
+
+This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Grav Learn Theme](https://learn.getgrav.org/).
+
+Visit the [theme documentation](https://learn.netlify.com/en/) to see what is going on. It is actually built with this theme.
+
+[![wercker status](https://app.wercker.com/status/233466a2be73fcea400e7dc02ef6adf9/s/master "wercker status")](https://app.wercker.com/project/byKey/233466a2be73fcea400e7dc02ef6adf9)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_shield)
+
+## Main features
+
+- Automatic Search
+- Multilingual mode
+- Unlimited menu levels
+- Automatic next/prev buttons to navigate through menu entries
+- Image resizing, shadow…
+- Attachments files
+- List child pages
+- Mermaid diagram (flowchart, sequence, gantt)
+- Customizable look and feel and themes variants
+- Buttons, Tip/Note/Info/Warning boxes, Expand
+
+## Installation
+
+Navigate to your themes folder in your Hugo site and use the following commands:
+
+```
+$ cd themes
+$ git clone https://github.com/matcornic/hugo-theme-learn.git
+```
+
+Check that your Hugo version is minimum `0.25` with `hugo version`.
+
+![Overview](https://github.com/matcornic/hugo-theme-learn/raw/master/images/tn.png)
+
+## Usage
+
+- [Visit the documentation](https://learn.netlify.com/en/)
+
+## Download old versions (prior to 2.0.0)
+
+If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0` 
+
+- Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip
+- Git way:
+
+```shell
+cd themes/hugo-theme-learn
+git checkout tags/1.1.0
+```
+
+For both solutions, the documentation is available at https://github.com/matcornic/hugo-theme-learn/releases/download/1.1.0/hugo-learn-doc-1.1.0.zip
+
+## Credits
+
+Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work !
+
+
+## License
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_large)

data/docs-src/themes/hugo-theme-learn/archetypes/chapter.md

@@ -0,0 +1,13 @@
++++
+title = "{{ replace .Name "-" " " | title }}"
+date = {{ .Date }}
+weight = 5
+chapter = true
+pre = "<b>X. </b>"
++++
+
+### Chapter X
+
+# Some Chapter title
+
+Lorem Ipsum.

data/docs-src/themes/hugo-theme-learn/archetypes/default.md

@@ -0,0 +1,7 @@
++++
+title = "{{ replace .Name "-" " " | title }}"
+date =  {{ .Date }}
+weight = 5
++++
+
+Lorem Ipsum.

data/docs-src/themes/hugo-theme-learn/exampleSite/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 MATHIEU CORNIC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml

@@ -0,0 +1,75 @@
+baseURL = "/"
+languageCode = "en-US"
+defaultContentLanguage = "en"
+
+title = "Hugo Learn Documentation"
+theme = "hugo-theme-learn"
+themesdir = "../.."
+metaDataFormat = "yaml"
+defaultContentLanguageInSubdir= true
+
+[params]
+  editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/"
+  description = "Documentation for Hugo Learn Theme"
+  author = "Mathieu Cornic"
+  showVisitedLinks = true
+  disableBreadcrumb = false
+  disableNextPrev = false
+
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+
+[Languages]
+[Languages.en]
+title = "Documentation for Hugo Learn Theme"
+weight = 1
+languageName = "English"
+
+[[Languages.en.menu.shortcuts]]
+name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
+identifier = "ds"
+url = "https://github.com/matcornic/hugo-theme-learn"
+weight = 10
+
+[[Languages.en.menu.shortcuts]]
+name = "<i class='fas fa-fw fa-camera'></i> Showcases"
+url = "showcase"
+weight = 11
+
+[[Languages.en.menu.shortcuts]]
+name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
+identifier = "hugodoc"
+url = "https://gohugo.io/"
+weight = 20
+
+[[Languages.en.menu.shortcuts]]
+name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
+url = "/credits"
+weight = 30
+
+[Languages.fr]
+title = "Documentation du thème Hugo Learn"
+weight = 2
+languageName = "Français"
+
+[[Languages.fr.menu.shortcuts]]
+name = "<i class='fab fa-fw fa-github'></i> Repo GitHub"
+identifier = "ds"
+url = "https://github.com/matcornic/hugo-theme-learn"
+weight = 10
+
+[[Languages.fr.menu.shortcuts]]
+name = "<i class='fas fa-fw fa-camera'></i> Vitrine"
+url = "/showcase"
+weight = 11
+
+[[Languages.fr.menu.shortcuts]]
+name = "<i class='fas fa-fw fa-bookmark'></i> Documentation Hugo"
+identifier = "hugodoc"
+url = "https://gohugo.io/"
+weight = 20
+
+[[Languages.fr.menu.shortcuts]]
+name = "<i class='fas fa-fw fa-bullhorn'></i> Crédits"
+url = "/credits"
+weight = 30

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

@@ -0,0 +1,41 @@
+---
+title: "Learn Theme for Hugo"
+---
+
+# Hugo learn theme
+
+[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) is a theme for [Hugo](https://gohugo.io/), a fast and modern static website engine written in Go. Where Hugo is often used for blogs, this multilingual-ready theme is **fully designed for documentation**.
+
+This theme is a partial porting of the [Learn theme](http://learn.getgrav.org/) of [Grav](https://getgrav.org/), a modern flat-file CMS written in PHP.
+
+{{% notice tip %}}Learn theme works with a _page tree structure_ to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "cont/pages/_index.md"%}}) 
+{{% /notice %}}
+
+## Main features
+
+* [Automatic Search]({{%relref "basics/configuration/_index.md#activate-search" %}})
+* [Multilingual mode]({{%relref "cont/i18n/_index.md" %}})
+* **Unlimited menu levels**
+* **Automatic next/prev buttons to navigate through menu entries**
+* [Image resizing, shadow...]({{%relref "cont/markdown.en.md#images" %}})
+* [Attachments files]({{%relref "shortcodes/attachments.en.md" %}})
+* [List child pages]({{%relref "shortcodes/children/_index.md" %}})
+* [Mermaid diagram]({{%relref "shortcodes/mermaid.en.md" %}}) (flowchart, sequence, gantt)
+* [Customizable look and feel and themes variants]({{%relref "basics/style-customization/_index.md"%}})
+* [Buttons]({{%relref "shortcodes/button.en.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.en.md" %}}), [Expand]({{%relref "shortcodes/expand.en.md" %}})
+
+![Screenshot](https://github.com/matcornic/hugo-theme-learn/raw/master/images/screenshot.png?width=40pc&classes=shadow)
+
+## Contribute to this documentation
+Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it
+
+{{% notice info %}}
+Your modification will be deployed automatically when merged.
+{{% /notice %}}
+
+## Documentation website
+This current documentation has been statically generated with Hugo with a simple command : `hugo -t hugo-theme-learn` -- source code is [available here at GitHub](https://github.com/matcornic/hugo-theme-learn)
+
+{{% notice note %}}
+Automatically published and hosted thanks to [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/)
+{{% /notice %}}

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

@@ -0,0 +1,43 @@
+---
+title: "Learn Theme for Hugo"
+---
+
+# Thème Hugo learn
+
+[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) est un thème pour [Hugo](https://gohugo.io/), un générateur de site statique, rapide et modern, écrit en Go. Tandis que Hugo est souvent utilisé pour des blogs, ce thème multi-langue est **entièrement conçu pour la documentation**.
+
+Ce thème est un portage partiel du [thème Learn](http://learn.getgrav.org/) de [Grav](https://getgrav.org/), un CMS modern écrit en PHP.
+
+{{% notice tip %}}Le thème Learn fonctionne grâce à la structure de page aborescentes pour organiser le contenu: tous les contenus sont des pages qui appartiennent à d'autres pages. [Plus d'infos]({{%relref "cont/pages/_index.md"%}}) 
+{{% /notice %}}
+
+## Fonctionnalités principales
+
+* [Recherche automatique]({{%relref "basics/configuration/_index.md#activer-recherche" %}})
+* [Mode multi-langue]({{%relref "cont/i18n/_index.md" %}})
+* **Nombre de niveau infini dans le menu**
+* **Boutons suivant/précédent automatiquement générés pour naviguer entre les items du menu**
+* [Taille d'image, ombres...]({{%relref "cont/markdown.fr.md#images" %}})
+* [Fichiers joints]({{%relref "shortcodes/attachments.fr.md" %}})
+* [Lister les pages filles]({{%relref "shortcodes/children/_index.md" %}})
+* [Diagrammes Mermaid]({{%relref "shortcodes/mermaid.fr.md" %}}) (flowchart, sequence, gantt)
+* [Style configurable and variantes de couleurs]({{%relref "basics/style-customization/_index.md"%}})
+* [Boutons]({{%relref "shortcodes/button.fr.md" %}}), [Messages Astuce/Note/Info/Attention]({{%relref "shortcodes/notice.fr.md" %}}), [Expand]({{%relref "shortcodes/expand.fr.md" %}})
+
+![Screenshot](https://github.com/matcornic/hugo-theme-learn/raw/master/images/screenshot.png?width=40pc&classes=shadow)
+
+## Contribuer à cette documentation
+
+N'hésitez pas à mettre à jour ce contenu en cliquant sur le lien **Modifier cette page** en haut de chaque page, et créer la Pull Request associée.
+
+{{% notice info %}}
+Votre modification sera déployée automatiquement quand elle sera mergée.
+{{% /notice %}}
+
+## Site de documentation
+
+Cette documentation statique a été générée avec Hugo avec une simple commande : `hugo -t hugo-theme-learn` -- le code source est [disponible sur Github](https://github.com/matcornic/hugo-theme-learn)
+
+{{% notice note %}}
+Le site est auomatiquement publié et hébergé par [Netlify](https://www.netlify.com/). Plus d'infos sur le [déploiement de site Hugo avec Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)(En anglais)
+{{% /notice %}}

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

@@ -0,0 +1,12 @@
+---
+title: Basics
+weight: 5
+pre: "<b>1. </b>"
+chapter: true
+---
+
+### Chapter 1
+
+# Basics
+
+Discover what this Hugo theme is all about and the core-concepts behind it.

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

@@ -0,0 +1,12 @@
+---
+title: Démarrage
+weight: 5
+pre: "<b>1. </b>"
+chapter: true
+---
+
+### Chapitre 1
+
+# Démarrage
+
+Découvrez comment utiliser ce thème Hugo et apprenez-en les concepts

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

@@ -0,0 +1,58 @@
+---
+date: 2016-04-09T16:50:16+02:00
+title: Configuration
+weight: 20
+---
+
+## Global site parameters
+
+On top of [Hugo global configuration](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** lets you define the following parameters in your `config.toml` (here, values are default).
+
+Note that some of these parameters are explained in details in other sections of this documentation.
+
+```toml
+[params]
+  # Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page. 
+  # Useful to give opportunity to people to create merge request for your doc.
+  # See the config.toml file from this documentation site to have an example.
+  editURL = ""
+  # Author of the site, will be used in meta information
+  author = ""
+  # Description of the site, will be used in meta information
+  description = ""
+  # Shows a checkmark for visited pages on the menu
+  showVisitedLinks = false
+  # Disable search function. It will hide search bar
+  disableSearch = false
+  # Javascript and CSS cache are automatically busted when new version of site is generated. 
+  # Set this to true to disable this behavior (some proxies don't handle well this optimization)
+  disableAssetsBusting = false
+  # Set this to true to disable copy-to-clipboard button for inline code.
+  disableInlineCopyToClipBoard = false
+  # A title for shortcuts in menu is set by default. Set this to true to disable it. 
+  disableShortcutsTitle = false
+  # When using mulitlingual website, disable the switch language button.
+  disableLanguageSwitchingButton = false
+  # Hide breadcrumbs in the header and only show the current page title
+  disableBreadcrumb = true
+  # Hide Next and Previous page buttons normally displayed full height beside content
+  disableNextPrev = true
+  # Order sections in menu by "weight" or "title". Default to "weight"
+  ordersectionsby = "weight"
+  # Change default color scheme with a variant one. Can be "red", "blue", "green".
+  themeVariant = ""
+```
+
+## Activate search
+
+If not already present, add the follow lines in the same `config.toml` file.
+
+```toml
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+```
+
+Learn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
+
+> Hugo generate lunrjs index.json at the root of public folder. 
+> When you build the site with `hugo server`, hugo generates it internally and of course it doesn’t show up in the filesystem

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

@@ -0,0 +1,54 @@
+---
+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 = ""
+```
+
+## 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élioraions 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/themes/installing/)
+
+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 %}}