rbcli 0.2.8 → 0.3.0

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

@@ -0,0 +1,89 @@
+---
+date: 2020-06-01T13:31:12+01:00
+title: Code highlighting
+weight: 16
+---
+
+Learn theme uses [highlight.js](https://highlightjs.org/) to provide code syntax highlighting.
+
+## Markdown syntax
+
+Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided.
+
+<!-- markdownlint-disable MD046 -->
+```plaintext
+    ```json
+    [
+      {
+        "title": "apples",
+        "count": [12000, 20000],
+        "description": {"text": "...", "sensitive": false}
+      },
+      {
+        "title": "oranges",
+        "count": [17500, null],
+        "description": {"text": "...", "sensitive": false}
+      }
+    ]
+    ```
+```
+<!-- markdownlint-disable MD046 -->
+
+Renders to:
+
+```json
+[
+  {
+    "title": "apples",
+    "count": [12000, 20000],
+    "description": {"text": "...", "sensitive": false}
+  },
+  {
+    "title": "oranges",
+    "count": [17500, null],
+    "description": {"text": "...", "sensitive": false}
+  }
+]
+```
+
+## Supported languages
+
+Learn theme ships with its own version of highlight.js to support offline browsing. The included package supports 38 common languages, as described on the [highlight.js download page](https://highlightjs.org/download/).
+
+## Identifying failed language detection
+
+Highlight will write a warning to the browser console if a requested language was not found. For example, the following code block references an imaginary language `foo`. An error will be output to the console on this page.
+
+```plaintext
+    ```foo
+    bar
+    ```
+```
+
+```nohighlight
+Could not find the language 'foo', did you forget to load/include a language module?(anonymous) @ highlight.pack.js
+```
+
+## Supporting additional languages
+
+To support languages other than the 38 common languages included in the default highlight.js you will need to download your own version of highlight.js and add it to your site content.
+
+### Download custom highlight.js
+
+Visit [https://highlightjs.org/download/](https://highlightjs.org/download/) and select your desired language support. Note that more languages means greater package size.
+
+### Add custom highlight.js to static resources
+
+Inside the zip archive downloaded from highlight.js extract the file named `highlight.pack.js`. Move this file to the **new** location
+
+```nohighlight
+static/js/highlight.pack.js
+```
+
+**Do not** replace the existing file at `themes/hugo-theme-learn/static/js/highlight.pack.js`.
+
+Including the file in the correct path will override the theme default highlight.pack.js and prevent issues caused in the future if the theme default file is updated.
+
+## Further usage information
+
+See [https://highlightjs.org/usage/](https://highlightjs.org/usage/)

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

@@ -0,0 +1,39 @@
+---
+date: 2018-11-29T08:41:44+01:00
+title: Tags
+weight: 40
+tags: ["documentation", "tutorial"]
+---
+
+*Learn theme* support one default taxonomy of gohugo: the *tag* feature.
+
+## Configuration 
+
+Just add tags to any page: 
+
+```markdown
+---
+date: 2018-11-29T08:41:44+01:00
+title: Theme tutorial
+weight: 15
+tags: ["tutorial", "theme"] 
+---
+```
+
+## Behavior
+
+
+The tags are displayed at the top of the page, in their insertion order.
+
+Each tag is a link to a *Taxonomy* page displaying all the articles with the given tag. 
+
+## List all the tags
+
+In the `config.toml`  file you can add a shortcut to display all the tags
+
+```toml
+[[menu.shortcuts]]
+name = "<i class='fas fa-tags'></i> Tags"
+url = "/tags"
+weight = 30
+```

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

@@ -0,0 +1,40 @@
+---
+date: 2018-11-29T08:41:44+01:00
+title: Tags
+weight: 40
+tags: ["documentation", "tutorial"]
+---
+
+
+Le *thème Learn* supporte une des taxonomy par défaut de GoHugo : les tags.
+
+## Configuration 
+
+Il suffit d'ajouter un tableau de tags sur la page  : 
+
+```markdown
+---
+date: 2018-11-29T08:41:44+01:00
+title: Tutoriel pour le thème
+weight: 15
+tags: ["tutoriel", "theme"] 
+---
+```
+
+## Comportement
+
+Les tags sont affichés en haut de la page, dans l'ordre dans lequel ils ont été saisis. 
+
+Chaque tag est un lien vers une page *Taxonomy*, qui affiche tous les article avec ce tag.
+
+
+## Liste des tags
+
+Il est possible de rajouter un raccourci dans le fichier `config.toml` afin d'afficher une page listant tous les tags
+
+```toml
+[[menu.shortcuts]]
+name = "<i class='fas fa-tags'></i> Tags"
+url = "/tags"
+weight = 30
+```

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

@@ -0,0 +1,28 @@
+---
+title: Credits
+disableToc: true
+---
+
+## Contributors
+
+Thanks to them <i class="fas fa-heart"></i> for making Open Source Software a better place !
+
+{{% ghcontributors "https://api.github.com/repos/matcornic/hugo-theme-learn/contributors?per_page=100" %}}
+
+And a special thanks to [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), a fork of hugo-theme-learn. v2.0.0 of this theme is inspired by his work.
+
+## Packages and libraries
+* [mermaid](https://knsv.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown
+* [font awesome](http://fontawesome.io/) - the iconic font and CSS framework
+* [jQuery](https://jquery.com) - The Write Less, Do More, JavaScript Library
+* [lunr](https://lunrjs.com) - Lunr enables you to provide a great search experience without the need for external, server-side, search services...
+* [horsey](https://bevacqua.github.io/horsey/) - Progressive and customizable autocomplete component
+* [clipboard.js](https://zenorocha.github.io/clipboard.js) - copy text to clipboard
+* [highlight.js](https://highlightjs.org) - Javascript syntax highlighter
+* [modernizr](https://modernizr.com) - A JavaScript toolkit that allows web developers to use new CSS3 and HTML5 features while maintaining a fine level of control over browsers that don't support
+
+## Tooling
+
+* [Netlify](https://www.netlify.com) - Continuous deployement and hosting of this documentation
+* [Hugo](https://gohugo.io/)
+

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

@@ -0,0 +1,28 @@
+---
+title: Crédits
+disableToc: true
+---
+
+## Contributeurs
+
+Merci à eux <i class="fas fa-heart"></i> de rendre le monde Open Source meilleur  !
+
+{{% ghcontributors "https://api.github.com/repos/matcornic/hugo-theme-learn/contributors?per_page=100" %}}
+
+Et un grand merci à [@vjeantet](https://github.com/vjeantet) pour son travail sur [docdock](https://github.com/vjeantet/hugo-theme-docdock), un fork de _hugo-theme-learn_. La v2.0.0 du thème est en grande partie inspirée de son travail.
+
+## Packages et librairies
+* [mermaid](https://knsv.github.io/mermaid) - géneration de diagrames et graphiques à partir de texte similaire à Markdown
+* [font awesome](http://fontawesome.io/) - Le framework de polices iconiques
+* [jQuery](https://jquery.com) - La plus connue des librairies Javascript
+* [lunr](https://lunrjs.com) - Lunr fournit des fonctions de recherche sans service externe
+* [horsey](https://bevacqua.github.io/horsey/) - Autocomplétion de composants (utiliser pour les suggestions de recherche)
+* [clipboard.js](https://zenorocha.github.io/clipboard.js) - Copier le texte dans le presse-papier
+* [highlight.js](https://highlightjs.org) - Mise en valeur de syntaxes
+* [modernizr](https://modernizr.com) - Une boite à outil Javascript qui permet aux développeurs d'utiliser les dernières fonctionnalités de CSS et HTML5, même sur de vieux navigateurs.
+
+## Outils
+
+* [Netlify](https://www.netlify.com) - Déploiement continue et hébergement de cette documentation
+* [Hugo](https://gohugo.io/)
+

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

@@ -0,0 +1,16 @@
+---
+date: 2016-04-09T16:50:16+02:00
+title: Shortcodes
+pre: "<b>3. </b>"
+weight: 15
+---
+
+Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.
+
+But this happens to be a bad idea. Everyone uses Markdown because it's pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.
+
+To avoid this limitations, Hugo created [shortcodes](https://gohugo.io/extras/shortcodes/). A shortcode is a simple snippet inside a page.
+
+**Hugo-theme-learn** provides multiple shortcodes on top of existing ones.
+
+{{%children style="h2" description="true" %}}

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

@@ -0,0 +1,16 @@
+---
+date: 2016-04-09T16:50:16+02:00
+title: Shortcodes
+pre: "<b>3. </b>"
+weight: 15
+---
+
+Hugo utilise Markdown pour son format simple. Cependant, il y a beaucoup de chose que Markdown ne supporte pas bien. On pourrait utiliser du HTML pur pour améliorer les capacité du Markdown.
+
+Mais c'est probablement une mauvaise idée. Tout le monde utilise le Markdown parce que c'est pur et simple à lire même lorsqu'il est affiché en texte brut. Vous devez éviter le HTML autant que possible pour garder le contenu simple.
+
+Cependant, pour éviter les limitations, Hugo a créé les [shortcodes](https://gohugo.io/extras/shortcodes/). Un shortcode est un bout de code (*snippet*) dans une page.
+
+**Hugo-theme-learn** fournit de multiple shortcodes en plus de ceux existant.
+
+{{%children style="h2" description="true" %}}

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

@@ -0,0 +1,85 @@
+---
+title: Attachments
+description : "The Attachments shortcode displays a list of files attached to a page."
+---
+
+The Attachments shortcode displays a list of files attached to a page.
+
+{{% attachments /%}}
+
+## Usage
+
+The shortcurt lists files found in a **specific folder**.
+Currently, it support two implementations for pages
+
+1. If your page is a markdown file, attachements must be place in a **folder** named like your page and ending with **.files**.
+
+    > * content
+    >   * _index.md
+    >   * page.files
+    >      * attachment.pdf
+    >   * page.md
+
+2. If your page is a **folder**, attachements must be place in a nested **'files'** folder.
+
+    > * content
+    >   * _index.md
+    >   * page
+    >      * index.md
+    >      * files
+    >          * attachment.pdf
+
+Be aware that if you use a multilingual website, you will need to have as many folders as languages.
+
+That's all !
+
+### Parameters
+
+| Parameter | Default | Description |
+|:--|:--|:--|
+| title | "Attachments" | List's title  |
+| style | "" | Choose between "orange", "grey", "blue" and "green" for nice style |
+| pattern | ".*" | A regular expressions, used to filter the attachments by file name. <br/><br/>The **pattern** parameter value must be [regular expressions](https://en.wikipedia.org/wiki/Regular_expression).
+
+For example:
+
+* To match a file suffix of 'jpg', use **.*jpg** (not *.jpg).
+* To match file names ending in 'jpg' or 'png', use **.*(jpg|png)**
+
+### Examples
+
+#### List of attachments ending in pdf or mp4
+
+
+    {{%/*attachments title="Related files" pattern=".*(pdf|mp4)"/*/%}}
+
+renders as
+
+{{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}}
+
+#### Colored styled box
+
+    {{%/*attachments style="orange" /*/%}}
+
+renders as
+
+{{% attachments style="orange" /%}}
+
+
+    {{%/*attachments style="grey" /*/%}}
+
+renders as 
+
+{{% attachments style="grey" /%}}
+
+    {{%/*attachments style="blue" /*/%}}
+
+renders as
+
+{{% attachments style="blue" /%}}
+    
+    {{%/*attachments style="green" /*/%}}
+
+renders as
+
+{{% attachments style="green" /%}}

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

@@ -0,0 +1,85 @@
+---
+title: Attachments (Pièces jointes)
+description : "The Attachments shortcode displays a list of files attached to a page."
+---
+
+Le shortcode *Attachments* affiche une liste de pièces jointes d'une page.
+
+{{% attachments /%}}
+
+## Utilisation
+
+Le shortcode affiche la liste de fichiers trouvés dans un **dossier spécifique**
+A l'heure actuelle, il supporte deux implémentations
+
+1. Si votre page est un fichier Markdown, les pièces jointes doivent être placée dans un **dossier** nommé comme le nom de la page et suffixé par **.files**.
+
+    > * content
+    >   * _index.md
+    >   * page.files
+    >      * attachment.pdf
+    >   * page.md
+
+2. Si votre page est un **dossier**, les pièces jointes doivent être placées dans un dossier fils **'files'**.
+
+    > * content
+    >   * _index.md
+    >   * page
+    >      * index.md
+    >      * files
+    >          * attachment.pdf
+
+Attention, si votre site est multi-langue, vous devrez avec autant de dossier qu'il y a de langues.
+
+C'est tout !
+
+### Paramètres
+
+| Paramètre | Défaut | Description |
+|:--|:--|:--|
+| title | "Pièces jointes" | Titre de la liste  |
+| style | "" | Choisir entre "orange", "grey", "blue" et "green" pour un style plus sympa |
+| pattern | ".*" | Une expression régulière, utilisée pour filtrer les pièces jointes par leur nom de fichier. <br/><br/>Le paramètre **pattern** doit être une [expression régulière](https://en.wikipedia.org/wiki/Regular_expression).
+
+Par exemple:
+
+* Pour trouver les fichiers avec le suffixe 'jpg', utilisez **.*jpg** (pas *.jpg).
+* Pour trouver les fichiers avec les suffixe 'jpg' ou 'png', utilisez **.*(jpg|png)**
+
+### Exemples
+
+#### Lister les pièces jointes de type pdf ou mp4
+
+
+    {{%/*attachments title="Fichiers associés" pattern=".*(pdf|mp4)"/*/%}}
+
+s'affiche comme
+
+{{%attachments title="Fichiers associés" pattern=".*(pdf|mp4)"/%}}
+
+#### Modifier le style
+
+    {{%/*attachments style="orange" /*/%}}
+
+s'affiche comme
+
+{{% attachments style="orange" /%}}
+
+
+    {{%/*attachments style="grey" /*/%}}
+
+s'affiche comme
+
+{{% attachments style="grey" /%}}
+
+    {{%/*attachments style="blue" /*/%}}
+
+s'affiche comme
+
+{{% attachments style="blue" /%}}
+    
+    {{%/*attachments style="green" /*/%}}
+
+s'affiche comme
+
+{{% attachments style="green" /%}}