rbcli 0.2.12 → 0.3.0

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

@@ -15,7 +15,7 @@ hugo new site <new_project>
 
 ## Install the theme
 
-Install the **Hugo-theme-learn** theme by following [this documentation](https://gohugo.io/themes/installing/)
+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
 

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

@@ -25,8 +25,7 @@ Some of the key benefits are:
 John Gruber, the author of Markdown, puts it like this:
 
 > The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
-> -- <cite>John Gruber</cite>
-
+> -- John Gruber
 
 Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file
 
@@ -50,12 +49,18 @@ Headings from `h1` through `h6` are constructed with a `#` for each level:
 ```
 
 Renders to:
-
+<!-- markdownlint-disable MD025 -->
 # h1 Heading
+<!-- markdownlint-enable MD025 -->
+
 ## h2 Heading
+
 ### h3 Heading
+
 #### h4 Heading
+
 ##### h5 Heading
+
 ###### h6 Heading
 
 HTML:
@@ -78,13 +83,13 @@ Comments should be HTML compatible
 This is a comment
 -->
 ```
+
 Comment below should **NOT** be seen:
 
 <!--
 This is a comment
 -->
 
-
 ## Horizontal Rules
 
 The HTML `<hr>` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `<hr>` with any of the following:
@@ -97,11 +102,6 @@ renders to:
 
 ___
 
----
-
-***
-
-
 ## Body Copy
 
 Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML.
@@ -111,6 +111,7 @@ So this body copy:
 ```markdown
 Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
 ```
+
 renders to this HTML:
 
 ```html
@@ -120,6 +121,7 @@ renders to this HTML:
 ## Emphasis
 
 ### Bold
+
 For emphasizing a snippet of text with a heavier font-weight.
 
 The following snippet of text is **rendered as bold text**.
@@ -127,9 +129,12 @@ The following snippet of text is **rendered as bold text**.
 ```markdown
 **rendered as bold text**
 ```
+
 renders to:
 
+<!-- markdownlint-disable MD036 -->
 **rendered as bold text**
+<!-- markdownlint-enable MD036 -->
 
 and this HTML
 
@@ -138,6 +143,7 @@ and this HTML
 ```
 
 ### Italics
+
 For emphasizing a snippet of text with italics.
 
 The following snippet of text is _rendered as italicized text_.
@@ -148,7 +154,9 @@ _rendered as italicized text_
 
 renders to:
 
+<!-- markdownlint-disable MD036 -->
 _rendered as italicized text_
+<!-- markdownlint-enable MD036 -->
 
 and this HTML:
 
@@ -156,13 +164,14 @@ and this HTML:
 <em>rendered as italicized text</em>
 ```
 
+### Strikethrough
 
-### strikethrough
 In GFM (GitHub flavored Markdown) you can do strikethroughs.
 
 ```markdown
 ~~Strike through this text.~~
 ```
+
 Which renders to:
 
 ~~Strike through this text.~~
@@ -219,10 +228,10 @@ Renders to:
 The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated.  Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices)
 {{% /notice %}}
 
-
 ## Lists
 
 ### Unordered
+
 A list of items in which the order of the items does not explicitly matter.
 
 You may use any of the following symbols to denote bullets for each list item:
@@ -249,8 +258,10 @@ For example
 + Aenean sit amet erat nunc
 + Eget porttitor lorem
 ```
+
 Renders to:
 
+<!-- markdownlint-disable MD004 -->
 + Lorem ipsum dolor sit amet
 + Consectetur adipiscing elit
 + Integer molestie lorem at massa
@@ -263,6 +274,7 @@ Renders to:
 + Faucibus porta lacus fringilla vel
 + Aenean sit amet erat nunc
 + Eget porttitor lorem
+<!-- markdownlint-enable MD004 -->
 
 And this HTML
 
@@ -292,14 +304,15 @@ A list of items in which the order of items does explicitly matter.
 
 ```markdown
 1. Lorem ipsum dolor sit amet
-2. Consectetur adipiscing elit
-3. Integer molestie lorem at massa
-4. Facilisis in pretium nisl aliquet
-5. Nulla volutpat aliquam velit
-6. Faucibus porta lacus fringilla vel
-7. Aenean sit amet erat nunc
-8. Eget porttitor lorem
+4. Consectetur adipiscing elit
+2. Integer molestie lorem at massa
+8. Facilisis in pretium nisl aliquet
+4. Nulla volutpat aliquam velit
+99. Faucibus porta lacus fringilla vel
+21. Aenean sit amet erat nunc
+6. Eget porttitor lorem
 ```
+
 Renders to:
 
 1. Lorem ipsum dolor sit amet
@@ -353,6 +366,7 @@ Renders to:
 ## Code
 
 ### Inline code
+
 Wrap inline snippets of code with `` ` ``.
 
 ```markdown
@@ -361,31 +375,33 @@ In this example, `<section></section>` should be wrapped as **code**.
 
 Renders to:
 
-In this example, `<section></section>` should be wrapped with **code**.
+In this example, `<section></section>` should be wrapped as **code**.
 
 HTML:
 
 ```html
-<p>In this example, <code>&lt;section&gt;&lt;/section&gt;</code> should be wrapped with <strong>code</strong>.</p>
+<p>In this example, <code>&lt;section&gt;&lt;/section&gt;</code> should be wrapped as <strong>code</strong>.</p>
 ```
 
 ### Indented code
 
-Or indent several lines of code by at least four spaces, as in:
+Or indent several lines of code by at least two spaces, as in:
 
-<pre>
-  // Some comments
-  line 1 of code
-  line 2 of code
-  line 3 of code
-</pre>
+```markdown
+    // Some comments
+    line 1 of code
+    line 2 of code
+    line 3 of code
+```
 
 Renders to:
 
+<!-- markdownlint-disable MD046 -->
     // Some comments
     line 1 of code
     line 2 of code
     line 3 of code
+<!-- markdownlint-enable MD046 -->
 
 HTML:
 
@@ -400,19 +416,11 @@ HTML:
 </pre>
 ```
 
-
 ### Block code "fences"
 
 Use "fences"  ```` ``` ```` to block in multiple lines of code.
 
-<pre>
-``` markup
-Sample text here...
-```
-</pre>
-
-
-```
+```markdown
 Sample text here...
 ```
 
@@ -426,30 +434,34 @@ HTML:
 
 ### Syntax highlighting
 
-GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
-
-<pre>
-```js
-grunt.initConfig({
-  assemble: {
-    options: {
-      assets: 'docs/assets',
-      data: 'src/data/*.{json,yml}',
-      helpers: 'src/custom-helpers.js',
-      partials: ['src/partials/**/*.{hbs,md}']
-    },
-    pages: {
-      options: {
-        layout: 'default.hbs'
-      },
-      files: {
-        './': ['src/templates/pages/index.hbs']
+GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML.
+
+See [Code Highlighting]({{< ref "syntaxhighlight.md" >}}) for additional documentation.
+
+For example, to apply syntax highlighting to JavaScript code:
+
+```plaintext
+    ```js
+    grunt.initConfig({
+      assemble: {
+        options: {
+          assets: 'docs/assets',
+          data: 'src/data/*.{json,yml}',
+          helpers: 'src/custom-helpers.js',
+          partials: ['src/partials/**/*.{hbs,md}']
+        },
+        pages: {
+          options: {
+            layout: 'default.hbs'
+          },
+          files: {
+            './': ['src/templates/pages/index.hbs']
+          }
+        }
       }
-    }
-  }
-};
+    };
+    ```
 ```
-</pre>
 
 Renders to:
 
@@ -475,8 +487,8 @@ grunt.initConfig({
 ```
 
 ## Tables
-Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
 
+Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
 
 ```markdown
 | Option | Description |
@@ -553,8 +565,7 @@ HTML:
 <a href="http://assemble.io">Assemble</a>
 ```
 
-
-### Add a title
+### Add a tooltip
 
 ```markdown
 [Upstage](https://github.com/upstage/ "Visit Upstage!")
@@ -580,6 +591,7 @@ Named anchors enable you to jump to the specified anchor point on the same page.
   * [Chapter 2](#chapter-2)
   * [Chapter 3](#chapter-3)
 ```
+
 will jump to these sections:
 
 ```markdown
@@ -600,12 +612,15 @@ Images have a similar syntax to links but include a preceding exclamation point.
 ```markdown
 ![Minion](https://octodex.github.com/images/minion.png)
 ```
+
 ![Minion](https://octodex.github.com/images/minion.png)
 
 or
+
 ```markdown
 ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
 ```
+
 ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
 
 Like links, Images also have a footnote style syntax
@@ -615,6 +630,7 @@ Like links, Images also have a footnote style syntax
 ```markdown
 ![Alt text][id]
 ```
+
 ![Alt text][id]
 
 With a reference later in the document defining the URL location:
@@ -652,14 +668,25 @@ Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and
 ```markdown
 ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow)
 ```
+
 ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=shadow)
 
 ```markdown
 ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border)
 ```
+
 ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border)
 
 ```markdown
 ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow)
 ```
+
 ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border,shadow)
+
+### Lightbox
+
+Add a HTTP `featherlight` parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining `featherlight` to `false`.
+
+```markdown
+![Minion](https://octodex.github.com/images/minion.png?featherlight=false)
+```

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

@@ -4,11 +4,11 @@ title: Organisation des pages
 weight: 5
 ---
 
-Dans **Hugo**, les pages sont le coeur de votre site. Une fois configurées, les pages sont la valeur ajoutée de votre site de documentation.
+Dans **Hugo**, les pages sont le cœur de votre site. Une fois configurées, les pages sont la valeur ajoutée de votre site de documentation.
 
 ## Dossiers
 
-Organisez votre site comment n'importe quel autre [projet Hugo](https://gohugo.io/content/organization/). Typiquement, vous allez avoir un dossier *content* avec vos pages.
+Organisez votre site comme n'importe quel autre [projet Hugo](https://gohugo.io/content/organization/). Typiquement, vous allez avoir un dossier *content* avec vos pages.
 
     content
     ├── niveau-un 
@@ -35,7 +35,7 @@ Organisez votre site comment n'importe quel autre [projet Hugo](https://gohugo.i
     └── premiere-page.md                <-- /premiere-page
 
 {{% notice note %}}
-Le fichier `_index.md` est obligatoire dans chaque dossier, c'est en quelques rotes votre page d'accueil pour le dossier.
+Le fichier `_index.md` est obligatoire dans chaque dossier, c'est en quelque sorte votre page d'accueil pour le dossier.
 {{% /notice %}}
 
 ## Types

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/)