rbcli 0.2.8 → 0.3.0

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

@@ -0,0 +1,194 @@
+---
+date: 2016-04-09T16:50:16+02:00
+title: Personnalisation du style
+weight: 25
+---
+
+**Hugo-theme-learn** a été conçu pour être aussi configurable que possible en définissant plusieurs [partials](https://gohugo.io/templates/partials/)
+
+Dans `themes/hugo-theme-learn/layouts/partials/`, vous pourrez trouver tous les *partials* définis pour ce thème. Si vous avez besoin d'écraser quelque chose, ne modifiez pas le code directement. A la place, [suivez cette page](https://gohugo.io/themes/customizing/). Vous créerez alors un nouveau *partial* dans le dossier `layouts/partials` de votre site local. Ce *partial* aura la priorité.
+
+Ce thème définit les *partials* suivant :
+
+- *header*: l'en-tête de la page page (contient le fil d'Ariane). _Pas voué à être écrasé_
+- *custom-header*: En-tête personnalisé. Voué à être écrasé quand vous ajoutez des imports CSS. N'oubliez pas d'inclure la balise HTML `style` dans votre fichier
+- *footer*: le pied-de-page de la page (contains les flèches). _Pas voué à être écrasé_
+- *custom-footer*:  Pied-de-page personnalisé. Voué à être écrasé quand vous ajoutez du Javascript. N'oubliez pas d'inclure la balise HTML `javascript` dans votre fichier
+- *favicon*: le favicon
+- *logo*: le logo, affiché un haut à gauche.
+- *meta*: les balises HTML meta, que vous pouvez écraser sans problème.
+- *menu*: Le menu à gauche. _Pas voué à être écrasé_
+- *menu-footer*: Le pied-de-page du menu
+- *search*: le champ de recherche
+- *toc*: le sommaire
+
+## Changer le logo
+
+Créez un nouveau fichier dans `layouts/partials/`, nommé `logo.html`. Puis, écrivez le code HTML voulu.
+Vous pourriez utiliser une balise HTML `img` et référencer une image créée dans le dossier *static*, voire même y coller un code SVG !
+
+{{% notice note %}}
+La taille du logo va s'adapter automatiquement
+{{% /notice %}}
+
+## Changer le favicon
+
+Si votre favicon est un png, déposez votre image dans votre dossier local `static/images/` et nommez le `favicon.png`
+
+Si vous avez besoin de changer ce comportement par défaut, créer un nouveau fichier dans `layouts/partials/` et nommez le `favicon.html`. Puis ajoutez quelque chose comme:
+
+```html
+<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />
+```
+
+## Changer les couleurs par défaut {#theme-variant}
+
+**Hugo Learn theme** vous permet de choisir nativement entre 3 schéma de couleurs, mais n'hésitez pas à en ajouter d'autres ! Les couleurs par défaut sont celles de [Grav Learn Theme](https://learn.getgrav.org/).
+
+### Variante rouge
+
+```toml
+[params]
+  # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green".
+  themeVariant = "red"
+```
+
+![Variante rouge](/en/basics/style-customization/images/red-variant.png?width=60pc)
+
+### Variante bleue
+
+```toml
+[params]
+  # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green".
+  themeVariant = "blue"
+```
+
+![Variante bleue](/en/basics/style-customization/images/blue-variant.png?width=60pc)
+
+### Variante verte
+
+```toml
+[params]
+  # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green".
+  themeVariant = "green"
+```
+
+![Variante verte](/en/basics/style-customization/images/green-variant.png?width=60pc)
+
+### Votre variante
+
+Premièrement, créez un nouveau fichier CSS dans votre dossier `static/css`, préfixé par `theme` (ex: avec le theme_lemien_ `static/css/theme-lemien.css`). Copiez le contenu suivant et modifiez les couleurs dans les variables CSS.
+
+```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);
+}
+```
+
+Puis, configurez le paramètre `themeVariant` avec le nom de votre variante. C'est tout !
+
+```toml
+[params]
+  # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green".
+  themeVariant = "lemien"
+```

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

@@ -0,0 +1,12 @@
+---
+title: Content
+weight: 10
+chapter: true
+pre: "<b>2. </b>"
+---
+
+### Chapter 2
+
+# Content
+
+Find out how to create and organize your content quickly and intuitively.

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

@@ -0,0 +1,12 @@
+---
+title: Contenu
+weight: 10
+chapter: true
+pre: "<b>2. </b>"
+---
+
+### Chapitre 2
+
+# Contenu
+
+Découvrez comment créer et organiser votre contenu facilement et intuitivement.

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

@@ -0,0 +1,57 @@
+---
+title: Archetypes
+weight: 10
+---
+
+Using the command: `hugo new [relative new content path]`, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more : [archetypes](https://gohugo.io/content/archetypes/).
+
+It is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences.
+
+## Chapter {#archetypes-chapter}
+
+To create a Chapter page, run the following commands
+
+```
+hugo new --kind chapter <name>/_index.md
+```
+
+It will create a page with predefined Front-Matter:
+
+```markdown
++++
+title = "{{ replace .Name "-" " " | title }}"
+date = {{ .Date }}
+weight = 5
+chapter = true
+pre = "<b>X. </b>"
++++
+
+### Chapter X
+
+# Some Chapter title
+
+Lorem Ipsum.
+```
+
+## Default
+
+To create a default page, run either one of the following commands
+
+```
+# Either
+hugo new <chapter>/<name>/_index.md
+# Or
+hugo new <chapter>/<name>.md
+```
+
+It will create a page with predefined Front-Matter:
+
+```markdown
++++
+title = "{{ replace .Name "-" " " | title }}"
+date =  {{ .Date }}
+weight = 5
++++
+
+Lorem Ipsum.
+```

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

@@ -0,0 +1,57 @@
+---
+title: Archétypes
+weight: 10
+---
+
+En utilisant la commande: `hugo new [chemin vers nouveau contenu]`, vous pouvez créer un nouveau fichier avec la date et le title automatiquement initialisé. Même si c'est une fonctionnalité intéressante, elle reste limitée pour les auteurs actifs qui ont besoin de mieux : les [archetypes](https://gohugo.io/content/archetypes/).
+
+Les archétypes sont des squelettes de pages préconfigurées avec un Front Matter par défaut. Merci de vous référer à la documentation pour connaitre les différents types de page.
+
+## Chapitre {#archetypes-chapter}
+
+Pour créer un chapitre, lancez les commandes suivantes
+
+```
+hugo new --kind chapter <name>/_index.md
+```
+
+Cela crééra une page avec le Front Matter suivant:
+
+```markdown
++++
+title = "{{ replace .Name "-" " " | title }}"
+date = {{ .Date }}
+weight = 5
+chapter = true
+pre = "<b>X. </b>"
++++
+
+### Chapter X
+
+# Some Chapter title
+
+Lorem Ipsum.
+```
+
+## Défaut
+
+Pour créer une page classique, lancer l'une des deux commandes suivantes
+
+```
+# Soit
+hugo new <chapter>/<name>/_index.md
+# Ou
+hugo new <chapter>/<name>.md
+```
+
+Cela crééra une page avec le Front Matter suivant:
+
+```markdown
++++
+title = "{{ replace .Name "-" " " | title }}"
+date =  {{ .Date }}
+weight = 5
++++
+
+Lorem Ipsum.
+```

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

@@ -0,0 +1,78 @@
+---
+date: 2016-04-09T16:50:16+02:00
+title: Multilingual and i18n
+weight: 30
+---
+
+**Learn theme** is fully compatible with Hugo multilingual mode.
+
+It provides:
+
+- Translation strings for default values (English and French). Feel free to contribute !
+- Automatic menu generation from multilingual content
+- In-browser language switching
+
+![I18n menu](/en/cont/i18n/images/i18n-menu.gif)
+
+## Basic configuration
+
+After learning [how Hugo handle multilingual websites](https://gohugo.io/content-management/multilingual), define your languages in your `config.toml` file.
+
+For example with current French and English website.
+
+```toml
+# English is the default language
+defaultContentLanguage = "en"
+# Force to have /en/my-page and /fr/my-page routes, even for default language.
+defaultContentLanguageInSubdir= true
+
+[Languages]
+[Languages.en]
+title = "Documentation for Hugo Learn Theme"
+weight = 1
+languageName = "English"
+
+[Languages.fr]
+title = "Documentation du thème Hugo Learn"
+weight = 2
+languageName = "Français"
+```
+
+Then, for each new page, append the *id* of the language to the file.
+
+- Single file `my-page.md` is split in two files:
+    - in English: `my-page.en.md`
+    - in French: `my-page.fr.md`
+- Single file `_index.md` is split in two files:
+    - in English: `_index.en.md`
+    - in French: `_index.fr.md`
+
+{{% notice info %}}
+Be aware that only translated pages are displayed in menu. It's not replaced with default language content.
+{{% /notice %}}
+
+{{% notice tip %}}
+Use [slug](https://gohugo.io/content-management/multilingual/#translate-your-content) Front Matter parameter to translate urls too.
+{{% /notice %}}
+
+## Overwrite translation strings
+
+Translations strings are used for common default values used in the theme (*Edit this page* button, *Search placeholder* and so on). Translations are available in french and english but you may use another language or want to override default values.
+
+To override these values, create a new file in your local i18n folder `i18n/<idlanguage>.toml` and inspire yourself from the theme `themes/hugo-theme-learn/i18n/en.toml` 
+
+By the way, as these translations could be used by other people, please take the time to propose a translation by [making a PR](https://github.com/matcornic/hugo-theme-learn/pulls) to the theme ! 
+
+## Disable language switching
+
+Switching the language in the browser is a great feature, but for some reasons you may want to disable it. 
+
+Just set `disableLanguageSwitchingButton=true` in your `config.toml`
+
+```toml
+[params]
+  # When using mulitlingual website, disable the switch language button.
+  disableLanguageSwitchingButton = true
+```
+
+![I18n menu](/en/cont/i18n/images/i18n-menu.gif)

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

@@ -0,0 +1,78 @@
+---
+date: 2016-04-09T16:50:16+02:00
+title: Multi-langue et i18n
+weight: 30
+---
+
+**Learn** est complètement compatible avec le mode multi-langue d'Hugo.
+
+Il fournit :
+
+- Des *translation strings* pour les valeurs par défaut utilisées par le thème (Anglais et Français). N'hésitez pas à contribuer !
+- Génération automatique du menu avec le contenu multi-langue
+- Modification de la langue dans le navigateur
+
+![I18n menu](/en/cont/i18n/images/i18n-menu.gif)
+
+## Configuration simple
+
+Après avoir appris [comment Hugo gère les sites multi-langue](https://gohugo.io/content-management/multilingual), définissez vos langues dans votre fichier `config.toml`.
+
+Par exemple, pour ce site, avec du contenu en français et en anglais.
+
+```toml
+# Anglais est la langue par défaut
+defaultContentLanguage = "en"
+# Force d'avoir /en/ma-page et /fr/ma-page routes, même avec la langue par défaut.
+defaultContentLanguageInSubdir= true
+
+[Languages]
+[Languages.en]
+title = "Documentation for Hugo Learn Theme"
+weight = 1
+languageName = "English"
+
+[Languages.fr]
+title = "Documentation du thème Hugo Learn"
+weight = 2
+languageName = "Français"
+```
+
+Puis, pour chaque nouvelle page, ajoutez *l'id* de la langue du fichier.
+
+- Le fichier `my-page.md` est découpé en deux fichiers :
+    - en anglais : `my-page.en.md`
+    - en français : `my-page.fr.md`
+- Le fichier `_index.md` est découpé en deux fichiers :
+    - en anglais: `_index.en.md`
+    - en français: `_index.fr.md`
+
+{{% notice info %}}
+Attention, seulement les pages traduites sont affichées dans le menu. Le contenu n'est pas remplacé par les pages de la langue par défaut.
+{{% /notice %}}
+
+{{% notice tip %}}
+Utilisez le paramètre du Front Matter [slug](https://gohugo.io/content-management/multilingual/#translate-your-content) pour traduire également les URLs.
+{{% /notice %}}
+
+## Surcharger les *translation strings*
+
+Les *Translations strings* sont utilisées comme valeurs par défaut dans le thème (Bouton *Modifier la page*, Element de subsitution *Recherche*, etc.). Les traductions sont disponibles en français et en anglais mais vous pouvez utiliser n'importe quelle autre langue et surcharger avec vos propres valeurs.
+
+Pour surcharger ces valeurs, créer un nouveau fichier dans votre dossier i18n local `i18n/<idlanguage>.toml` et inspirez vous du thème `themes/hugo-theme-learn/i18n/en.toml` 
+
+D'ailleurs, ces traductions pour servir à tout le monde, donc svp prenez le temps de [proposer une Pull Request](https://github.com/matcornic/hugo-theme-learn/pulls) ! 
+
+## Désactiver le changement de langue
+
+Vous pouvez changer de langue directement dans le navigateur. C'est une super fonctionnalité, mais vous avez peut-être besoin de la désactiver. 
+
+Pour ce faire, ajouter le paramètre `disableLanguageSwitchingButton=true` dans votre `config.toml`
+
+```toml
+[params]
+  # Quand vous utilisez un site en multi-langue, désactive le bouton de changment de langue.
+  disableLanguageSwitchingButton = true
+```
+
+![I18n menu](/en/cont/i18n/images/i18n-menu.gif)