Skip to content

Commit

Permalink
Auto-deploy docs built from commit f277fa3
Browse files Browse the repository at this point in the history
  • Loading branch information
slawr committed Sep 10, 2024
1 parent 285a098 commit 6dd85d3
Show file tree
Hide file tree
Showing 52 changed files with 1,003 additions and 424 deletions.
8 changes: 8 additions & 0 deletions docs-gen/themes/learn/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
THIS PROJECT IS DEPRECATED

The project is not maintained anymore. Thanks everyone for helping me on building this theme at the time where there were no good Hugo theme for documentation.

[Consider migrating to another theme](https://github.com/matcornic/hugo-theme-learn/issues/557) such as [Relearn](https://github.com/McShelby/hugo-theme-relearn) which seems to be a good maintained alternative.

----

# Hugo Learn Theme

This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Grav Learn Theme](https://learn.getgrav.org/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ 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

{{% notice note %}}
Google Analytics are added to `/layout/partials/custom-footer.html` remove the contents of that file to opt-out.
{{% /notice %}}

## 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.
Expand Down
2 changes: 1 addition & 1 deletion docs-gen/themes/learn/exampleSite/content/credits.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Thanks to them <i class="fas fa-heart"></i> for making Open Source Software a be
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
* [mermaid](https://mermaid-js.github.io/) - 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...
Expand Down
2 changes: 1 addition & 1 deletion docs-gen/themes/learn/exampleSite/content/credits.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Merci à eux <i class="fas fa-heart"></i> de rendre le monde Open Source meilleu
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
* [mermaid](https://mermaid-js.github.io/) - 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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This file was downloaded from Hugo Learn Theme.
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,23 @@ That's all!
|:--|:--|:--|
| 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).
| pattern | ".*" | A regular expression, used to filter the attachments by file name. The **pattern** parameter value must be a [regular expression](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)**
* 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)"/*/%}}
{{%/*attachments title="Related files" pattern=".*\.(pdf|mp4)$"/*/%}}

renders as

{{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}}
{{%attachments title="Related files" pattern=".*\.(pdf|mp4)$"/%}}

#### Colored styled box

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Ce fichier a été téléchargé à partir du Hugo Learn Theme.
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,23 @@ C'est tout !
|:--|:--|:--|
| 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).
| pattern | ".*" | Une expression régulière, utilisée pour filtrer les pièces jointes par leur nom de fichier. 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)**
* 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)"/*/%}}
{{%/*attachments title="Fichiers associés" pattern=".*\.(pdf|mp4)$"/*/%}}

s'affiche comme

{{%attachments title="Fichiers associés" pattern=".*(pdf|mp4)"/%}}
{{%attachments title="Fichiers associés" pattern=".*\.(pdf|mp4)$"/%}}

#### Modifier le style

Expand Down
119 changes: 119 additions & 0 deletions docs-gen/themes/learn/exampleSite/content/shortcodes/tabs.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
---
title: Tabbed views
description : "Synchronize selection of content in different tabbed views"
---

Choose which content to see across the page. Very handy for providing code
snippets for multiple languages or providing configuration in different formats.

## Code example

{{</* tabs */>}}
{{%/* tab name="python" */%}}
```python
print("Hello World!")
```
{{%/* /tab */%}}
{{%/* tab name="R" */%}}
```R
> print("Hello World!")
```
{{%/* /tab */%}}
{{%/* tab name="Bash" */%}}
```Bash
echo "Hello World!"
```
{{%/* /tab */%}}
{{</* /tabs */>}}

Renders as:

{{< tabs >}}
{{% tab name="python" %}}
```python
print("Hello World!")
```
{{% /tab %}}
{{% tab name="R" %}}
```R
> print("Hello World!")
```
{{% /tab %}}
{{% tab name="Bash" %}}
```Bash
echo "Hello World!"
```
{{% /tab %}}
{{< /tabs >}}

Tab views with the same tabs that belong to the same group sychronize their selection:

{{< tabs >}}
{{% tab name="python" %}}
```python
print("Hello World!")
```
{{% /tab %}}
{{% tab name="R" %}}
```R
> print("Hello World!")
```
{{% /tab %}}
{{% tab name="Bash" %}}
```Bash
echo "Hello World!"
```
{{% /tab %}}
{{< /tabs >}}

## Config example

{{</* tabs groupId="config" */>}}
{{%/* tab name="json" */%}}
```json
{
"Hello": "World"
}
```
{{%/* /tab */%}}
{{%/* tab name="XML" */%}}
```xml
<Hello>World</Hello>
```
{{%/* /tab */%}}
{{%/* tab name="properties" */%}}
```properties
Hello = World
```
{{%/* /tab */%}}
{{</* /tabs */>}}

Renders as:

{{< tabs groupId="config" >}}
{{% tab name="json" %}}
```json
{
"Hello": "World"
}
```
{{% /tab %}}
{{% tab name="XML" %}}
```xml
<Hello>World</Hello>
```
{{% /tab %}}
{{% tab name="properties" %}}
```properties
Hello = World
```
{{% /tab %}}
{{< /tabs >}}

{{% notice warning %}}
When using tab views with different content sets, make sure to use a common `groupId` for equal sets but distinct
`groupId` for different sets. The `groupId` defaults to `'default'`.
**Take this into account across the whole site!**
The tab selection is restored automatically based on the `groupId` and if it cannot find a tab item because it came
from the `'default'` group on a different page then all tabs will be empty at first.
{{% /notice %}}
11 changes: 10 additions & 1 deletion docs-gen/themes/learn/i18n/ar.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,13 @@ other = "تعديل هذه الصفحة"
other = "المزيد"

[Expand-title]
other = "...قم بتوسيع"
other = "...قم بتوسيع"

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
11 changes: 10 additions & 1 deletion docs-gen/themes/learn/i18n/de.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,13 @@ other = "Bearbeite diese Seite"
other = "Mehr"

[Expand-title]
other = "Erweitere mich..."
other = "Erweitere mich..."

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
11 changes: 10 additions & 1 deletion docs-gen/themes/learn/i18n/en.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,13 @@ other = "Edit this page"
other = "More"

[Expand-title]
other = "Expand me..."
other = "Expand me..."

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
9 changes: 9 additions & 0 deletions docs-gen/themes/learn/i18n/es.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,12 @@ other = "Más"

[Expand-title]
other = "Expandir..."

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
11 changes: 10 additions & 1 deletion docs-gen/themes/learn/i18n/fr.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,13 @@ other = "Modifier la page"
other = "Aller plus loin"

[Expand-title]
other = "Déroulez-moi..."
other = "Déroulez-moi..."

[Byte-symbol]
other = "o"

[Kilobyte-symbol]
other = "ko"

[Megabyte-symbol]
other = "Mo"
9 changes: 9 additions & 0 deletions docs-gen/themes/learn/i18n/hi.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,12 @@ other = "अधिक सामग्री दिखाएं"

[Expand-title]
other = "विस्तार करे..."

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
9 changes: 9 additions & 0 deletions docs-gen/themes/learn/i18n/id.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,12 @@ other = "Lainnya"

[Expand-title]
other = "Bentangkan..."

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
9 changes: 9 additions & 0 deletions docs-gen/themes/learn/i18n/ja.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,12 @@ other = "更に"

[Expand-title]
other = "開く..."

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
9 changes: 9 additions & 0 deletions docs-gen/themes/learn/i18n/nl.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,12 @@ other = "Snelkoppelingen"

[Expand-title]
other = "Lees meer..."

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
9 changes: 9 additions & 0 deletions docs-gen/themes/learn/i18n/pt.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,12 @@ other = "Mais"

[Expand-title]
other = "Expandir..."

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
11 changes: 10 additions & 1 deletion docs-gen/themes/learn/i18n/ru.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,13 @@ other = "Редактировать"
other = "Еще"

[Expand-title]
other = "Развернуть..."
other = "Развернуть..."

[Byte-symbol]
other = "Б"

[Kilobyte-symbol]
other = "КБ"

[Megabyte-symbol]
other = "МБ"
9 changes: 9 additions & 0 deletions docs-gen/themes/learn/i18n/tr.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,12 @@ other = "Dahası Var"

[Expand-title]
other = "Genişlet..."

[Byte-symbol]
other = "B"

[Kilobyte-symbol]
other = "KB"

[Megabyte-symbol]
other = "MB"
Loading

0 comments on commit 6dd85d3

Please sign in to comment.