feat: add multilingual mode support (#241)

BREAKING CHANGE:  Layout file renamed ´layouts/partials/page-footer.html → layouts/partials/menu-nextprev.html`. If you use overrides, you might need to change the filenames as well.

exampleSite/content/en/shortcodes/_index.md

@@ -0,0 +1,4 @@
+---
+title: Shortcodes
+weight: -10
+---

exampleSite/content/en/shortcodes/buttons.md

@@ -0,0 +1,17 @@
+---
+title: Buttons
+---
+
+Buttons are styled links that can lead to local page or external link.
+
+<!-- prettier-ignore-start -->
+```tpl
+{{</* button relref="/" [class="...", size="large|regular"] */>}}Get Home{{</* /button */>}}
+{{</* button href="https://github.com/thegeeklab/hugo-geekdoc" */>}}Contribute{{</* /button */>}}
+```
+<!-- prettier-ignore-end -->
+
+## Example
+
+{{< button relref="/" >}}Get Home{{< /button >}}
+{{< button href="https://github.com/thegeeklab/hugo-geekdoc" >}}Contribute{{< /button >}}

exampleSite/content/en/shortcodes/columns.md

@@ -0,0 +1,50 @@
+---
+title: Columns
+---
+
+The Columns shortcode can be used to organize content side-by-side (horizontally) for better readability.
+
+```html
+{{</* columns */>}} <!-- begin columns block -->
+## Left Content
+Dolor sit, sumo unique argument um no ...
+
+<---> <!-- magic separator, between columns -->
+
+## Mid Content
+Dolor sit, sumo unique argument um no ...
+
+<---> <!-- magic separator, between columns -->
+
+## Right Content
+Dolor sit, sumo unique argument um no ...
+{{</* /columns */>}}
+```
+
+## Example
+
+{{< columns >}}
+
+## Left
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts
+feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious
+copious quo ad. Stet probates in duo.
+
+<--->
+
+## Mid Content
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re.
+
+<--->
+
+## Right Content
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts
+feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious
+copious quo ad. Stet probates in duo.
+{{< /columns >}}

exampleSite/content/en/shortcodes/expand.md

@@ -0,0 +1,46 @@
+---
+title: Expand
+---
+
+Expand shortcode can help to decrease clutter on screen by hiding part of text. Expand content by clicking on it.
+
+## Example
+
+### Default
+
+<!-- prettier-ignore-start -->
+```tpl
+{{</* expand */>}}
+## Markdown content
+Dolor sit, sumo unique ...
+{{</* /expand */>}}
+```
+<!-- prettier-ignore-end -->
+
+{{< expand >}}
+
+## Markdown content
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re.
+{{< /expand >}}
+
+### With Custom Label
+
+<!-- prettier-ignore-start -->
+```tpl
+{{</* expand "Custom Label" "..." */>}}
+## Markdown content
+Dolor sit, sumo unique ...
+{{</* /expand */>}}
+```
+<!-- prettier-ignore-end -->
+
+{{< expand "Custom Label" "..." >}}
+
+## More markdown
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts
+feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious
+copious quo ad. Stet probates in duo.
+{{< /expand >}}

exampleSite/content/en/shortcodes/hints.md

@@ -0,0 +1,42 @@
+---
+title: Hints
+---
+
+Hint shortcode can be used as hint/alerts/notification block.
+There are four colors to choose: `info`, `ok`, `warning` and `danger`.
+
+<!-- prettier-ignore-start -->
+```tpl
+{{</* hint [info|ok|warning|danger] */>}}
+**Markdown content**\
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
+ Ornateness bland it ex enc, est yeti am bongo detract re.
+{{</* /hint */>}}
+```
+<!-- prettier-ignore-end -->
+
+## Example
+
+{{< hint info >}}
+**Markdown content**\
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
+Ornateness bland it ex enc, est yeti am bongo detract re.
+{{< /hint >}}
+
+{{< hint ok >}}
+**Markdown content**\
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
+Ornateness bland it ex enc, est yeti am bongo detract re.
+{{< /hint >}}
+
+{{< hint warning >}}
+**Markdown content**\
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
+Ornateness bland it ex enc, est yeti am bongo detract re.
+{{< /hint >}}
+
+{{< hint danger >}}
+**Markdown content**\
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
+Ornateness bland it ex enc, est yeti am bongo detract re.
+{{< /hint >}}

exampleSite/content/en/shortcodes/icons.md

@@ -0,0 +1,21 @@
+---
+title: Icons
+---
+
+Simple shortcode to include icons from SVG sprites outside of menus.
+
+<!-- prettier-ignore-start -->
+```tpl
+{{</* icon "thumbs-up" */>}}
+```
+<!-- prettier-ignore-end -->
+
+**Example:**
+
+| Result                     | Usage                            |
+| -------------------------- | -------------------------------- |
+| {{< icon "thumbs-up" >}}   | `{{</* icon "thumbs-up" */>}}`   |
+| {{< icon "thumbs-down" >}} | `{{</* icon "thumbs-down" */>}}` |
+| {{< icon "laugh" >}}       | `{{</* icon "laugh" */>}}`       |
+| {{< icon "lemon" >}}       | `{{</* icon "lemon" */>}}`       |
+| {{< icon "moon" >}}        | `{{</* icon "moon" */>}}`        |

exampleSite/content/en/shortcodes/images/_index.md

@@ -0,0 +1,146 @@
+---
+title: Images
+resources:
+  - name: forest-1
+    src: "forest-1.jpg"
+    title: Forest (1)
+    params:
+      credits: "[Jay Mantri](https://unsplash.com/@jaymantri) on [Unsplash](https://unsplash.com/s/photos/forest)"
+  - name: forest-2
+    src: "forest-2.jpg"
+    title: Forest (2)
+    params:
+      credits: "[Jay Mantri](https://unsplash.com/@jaymantri) on [Unsplash](https://unsplash.com/s/photos/forest)"
+  - name: forest-3
+    src: "forest-3.jpg"
+    title: Forest (3)
+    params:
+      credits: "[Jay Mantri](https://unsplash.com/@jaymantri) on [Unsplash](https://unsplash.com/s/photos/forest)"
+  - name: forest-4
+    src: "forest-4.jpg"
+    title: Forest (4)
+    params:
+      credits: "[Jay Mantri](https://unsplash.com/@jaymantri) on [Unsplash](https://unsplash.com/s/photos/forest)"
+  - name: forest-5
+    src: "forest-5.jpg"
+    title: Forest (5)
+    params:
+      credits: "[Jay Mantri](https://unsplash.com/@jaymantri) on [Unsplash](https://unsplash.com/s/photos/forest)"
+  - name: forest-6
+    src: "forest-6.jpg"
+    title: Forest (6)
+    params:
+      credits: "[Asher Ward](https://unsplash.com/@the_asher_ward) on [Unsplash](https://unsplash.com/s/photos/forest)"
+  - name: forest-7
+    src: "forest-7.jpg"
+    title: Forest (7)
+    params:
+      credits: "[Asher Ward](https://unsplash.com/@the_asher_ward) on [Unsplash](https://unsplash.com/s/photos/forest)"
+---
+
+If you need more flexibility for your embedded images, you could use the `img` shortcode. It is using Hugo's
+[page resources](https://gohugo.io/content-management/page-resources/) and supports lazy loading of your images.
+
+**Attributes:**
+
+| Name          | Usage                                                                                                         | default           |
+| ------------- | ------------------------------------------------------------------------------------------------------------- | ----------------- |
+| name (string) | Name of the image resource defined in your front matter.                                                      | empty             |
+| alt (string)  | Description for displayed image.                                                                              | resource `.Title` |
+| size (string) | Thumbnail size (tiny\|small\|medium\|large).                                                                  | empty             |
+| lazy (bool)   | Enable or disable image lazy loading. Can be controlled globally by site parameter `geekdocImageLazyLoading`. | true              |
+
+**Example:**
+
+Define your resources in the page front matter, custom parameter `params.credits` is optional.
+
+<!-- spellchecker-disable -->
+
+```md
+---
+resources:
+  - name: forest-1
+    src: "forest-1.jpg"
+    title: Forest (1)
+    params:
+      credits: "[Jay Mantri](https://unsplash.com/@jaymantri) on [Unsplash](https://unsplash.com/s/photos/forest)"
+---
+
+{{</* img name="forest-1" size="large" lazy=false */>}}
+```
+
+<!-- spellchecker-enable -->
+
+**Demo:**
+
+<!-- spellchecker-disable -->
+
+{{< img name="forest-1" lazy=false >}}
+
+<!-- spellchecker-enable -->
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts
+feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious
+copious quo ad. Stet probates in duo.
+
+<!-- spellchecker-disable -->
+
+{{< img name="forest-2" lazy=true >}}
+
+<!-- spellchecker-enable -->
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts
+feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious
+copious quo ad. Stet probates in duo.
+
+<!-- spellchecker-disable -->
+
+{{< img name="forest-3" lazy=true >}}
+
+<!-- spellchecker-enable -->
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts
+feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious
+copious quo ad. Stet probates in duo.
+
+<!-- spellchecker-disable -->
+
+{{< img name="forest-4" lazy=true >}}
+
+<!-- spellchecker-enable -->
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts
+feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious
+copious quo ad. Stet probates in duo.
+
+<!-- spellchecker-disable -->
+
+{{< img name="forest-5" lazy=true >}}
+
+<!-- spellchecker-enable -->
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts
+feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious
+copious quo ad. Stet probates in duo.
+
+<!-- spellchecker-disable -->
+
+{{< img name="forest-6" lazy=true >}}
+
+<!-- spellchecker-enable -->
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts
+feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious
+copious quo ad. Stet probates in duo.
+
+<!-- spellchecker-disable -->
+
+{{< img name="forest-7" lazy=true >}}
+
+<!-- spellchecker-enable -->

exampleSite/content/en/shortcodes/includes.md

@@ -0,0 +1,93 @@
+---
+title: Includes
+---
+
+{{< toc >}}
+
+Include shortcode can include files of different types. By specifying a language, the included file will have syntax highlighting.
+
+<!-- prettier-ignore-start -->
+```tpl
+{{</* include file="relative/path/from/hugo/root" language="go" */>}}
+```
+<!-- prettier-ignore-end -->
+
+Attributes:
+
+| Name     | Usage                                                                                                                               | default                          |
+| -------- | ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
+| file     | path to the included file relative to the Hugo root                                                                                 | undefined                        |
+| language | language for [syntax highlighting](https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages) | undefined                        |
+| type     | special include type (`html,page`)                                                                                                  | undefined (rendered as markdown) |
+| options  | highlighting [options](https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode)                               | `linenos=table`                  |
+
+## Examples
+
+### Markdown file (default)
+
+If no other options are specified, files will be rendered as Markdown using the `RenderString` [function](https://gohugo.io/functions/renderstring/).
+
+{{< hint warning >}}
+**Location of markdown files**\
+If you include markdown files that should not get a menu entry, place them outside the content folder or exclude them otherwise.
+{{< /hint >}}
+
+<!-- prettier-ignore -->
+```tpl
+{{</* include file="/static/_includes/example.md.part" */>}}
+```
+
+<!-- prettier-ignore-start -->
+<!-- spellchecker-disable -->
+{{< include file="/static/_includes/example.md.part" >}}
+<!-- spellchecker-enable -->
+<!-- prettier-ignore-end -->
+
+### Language files
+
+This method can be used to include source code files and keep them automatically up to date.
+
+<!-- prettier-ignore -->
+```tpl
+{{</* include file="config/_default/config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100" */>}}
+```
+
+Result:
+
+<!-- prettier-ignore-start -->
+<!-- spellchecker-disable -->
+{{< include file="config/_default/config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100" >}}
+<!-- spellchecker-enable -->
+<!-- prettier-ignore-end -->
+
+### Special include types
+
+#### HTML
+
+HTML content will be filtered by the `safeHTML` filter and added to the rendered page output.
+
+<!-- prettier-ignore -->
+```tpl
+{{</* include file="/static/_includes/example.html.part" type="html" */>}}
+```
+
+{{< include file="/static/_includes/example.html.part" type="html" >}}
+
+#### Pages
+
+In some situations, it can be helpful to include Markdown files that also contain shortcodes. While the [default method](#markdown-file-default) works fine to render plain Markdown, shortcodes are not parsed. The only way to get this to work is to use Hugo pages. There are several ways to structure these include pages, so whatever you do, keep in mind that Hugo needs to be able to render and serve these files as regular pages! How it works:
+
+1. First you need to create a directory **within** your content directory. For this example site `_includes` is used.
+2. To prevent the theme from embedding the page in the navigation, create a file `_includes/_index.md` and add `GeekdocHidden: true` to the front matter.
+3. Place your Markdown files within the `_includes` folder e.g. `/_includes/include-page.md`. Make sure to name it `*.md`.
+4. Include the page using `{{</* include file="/_includes/include-page.md" type="page" */>}}`.
+
+Resulting structure should look like this:
+
+```Shell
+_includes/
+ ├── include-page.md
+ └── _index.md
+```
+
+{{< include file="/_includes/include-page.md" type="page" >}}

exampleSite/content/en/shortcodes/katex.md

@@ -0,0 +1,39 @@
+---
+title: KaTeX
+---
+
+[KaTeX](https://katex.org/) shortcode let you render math typesetting in markdown document.
+
+## Example
+
+{{< columns >}}
+
+```latex
+{{</* katex [display] [class="text-center"] */>}}
+f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
+{{</* /katex */>}}
+```
+
+<--->
+
+<!-- spellchecker-disable -->
+<!-- prettier-ignore -->
+{{< katex display >}}
+f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
+{{< /katex >}}
+
+<!-- spellchecker-enable -->
+
+{{< /columns >}}
+
+KaTeX can also be used inline, for example {{< katex >}}\pi(x){{< /katex >}} or used with a `display` setting. for example `display: block`:
+
+<!-- spellchecker-disable -->
+<!-- prettier-ignore -->
+{{< katex display >}}
+f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
+{{< /katex >}}
+
+<!-- spellchecker-enable -->
+
+Text continues here.

exampleSite/content/en/shortcodes/mermaid.md

@@ -0,0 +1,46 @@
+---
+title: Mermaid
+---
+
+[Mermaid](https://mermaidjs.github.io/) is library for generating SVG charts and diagrams from text.
+
+## Example
+
+{{< columns >}}
+
+<!-- prettier-ignore -->
+```tpl
+{{</* mermaid class="text-center"*/>}}
+sequenceDiagram
+    Alice->>Bob: Hello Bob, how are you?
+    alt is sick
+        Bob->>Alice: Not so good :(
+    else is well
+        Bob->>Alice: Feeling fresh like a daisy
+    end
+    opt Extra response
+        Bob->>Alice: Thanks for asking
+    end
+{{</* /mermaid */>}}
+```
+
+<--->
+
+<!-- spellchecker-disable -->
+<!-- prettier-ignore -->
+{{< mermaid class="text-center" >}}
+sequenceDiagram
+    Alice->>Bob: Hello Bob, how are you?
+    alt is sick
+        Bob->>Alice: Not so good :(
+    else is well
+        Bob->>Alice: Feeling fresh like a daisy
+    end
+    opt Extra response
+        Bob->>Alice: Thanks for asking
+    end
+{{< /mermaid >}}
+
+<!-- spellchecker-enable -->
+
+{{< /columns >}}

exampleSite/content/en/shortcodes/tabs.md

@@ -0,0 +1,54 @@
+---
+title: Tabs
+---
+
+Tabs let you organize content by context, for example installation instructions for each supported platform.
+
+<!-- prettier-ignore-start -->
+```tpl
+{{</* tabs "uniqueid" */>}}
+{{</* tab "macOS" */>}} # macOS Content {{</* /tab */>}}
+{{</* tab "Linux" */>}} # Linux Content {{</* /tab */>}}
+{{</* tab "Windows" */>}} # Windows Content {{</* /tab */>}}
+{{</* /tabs */>}}
+```
+<!-- prettier-ignore-end -->
+
+## Example
+
+{{< tabs "uniqueid" >}}
+{{< tab "macOS" >}}
+
+## macOS
+
+This is tab **macOS** content.
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad
+prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim
+fastidious copious quo ad. Stet probates in duo.
+{{< /tab >}}
+
+{{< tab "Linux" >}}
+
+## Linux
+
+This is tab **Linux** content.
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad
+prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim
+fastidious copious quo ad. Stet probates in duo.
+{{< /tab >}}
+
+{{< tab "Windows" >}}
+
+## Windows
+
+This is tab **Windows** content.
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
+investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad
+prompts feud gait, quid exercise emeritus bis e. In pro quints consequent.
+{{< /tab >}}
+{{< /tabs >}}

exampleSite/content/en/shortcodes/toc-tree.md

@@ -0,0 +1,15 @@
+---
+title: ToC-Tree
+---
+
+The `toc-tree` shortcode will generate a Table of Content from a section file tree of your content directory. The root of the resulting ToC will be the page on which you define the shortcode.
+
+<!-- prettier-ignore-start -->
+```tpl
+{{</* toc-tree */>}}
+```
+<!-- prettier-ignore-end -->
+
+## Example
+
+As said, the root will be the site on which the shortcode was used, you can see a demo including nesting in the [ToC Tree](/toc-tree/) section.

exampleSite/content/en/shortcodes/toc.md

@@ -0,0 +1,43 @@
+---
+title: ToC
+---
+
+Simple wrapper to generate a page Table of Content from a shortcode.
+
+<!-- prettier-ignore-start -->
+```tpl
+{{</* toc */>}}
+```
+<!-- prettier-ignore-end -->
+
+{{< toc >}}
+
+## Level 1
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious copious quo ad. Stet probates in duo.
+
+## Level 2
+
+Amalia id per in minimum facility, quid facet modifier ea ma. Ill um select ma ad, en ferric patine sentient vim. Per expendable foreordained interpretations cu, maxim sole pertinacity in ram.
+
+### Level 2.1
+
+Amalia id per in minimum facility, quid facet modifier ea ma. Ill um select ma ad, en ferric patine sentient vim. Per expendable foreordained interpretations cu, maxim sole pertinacity in ram.
+
+#### Level 2.1.1
+
+Amalia id per in minimum facility, quid facet modifier ea ma. Ill um select ma ad, en ferric patine sentient vim.
+
+##### Level 2.1.1.1
+
+In pro quints consequent, denim fastidious copious quo ad.
+
+###### Level 2.1.1.1.1
+
+In pro quints consequent, denim fastidious copious quo ad.
+
+### Level 2.2
+
+Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e.
+
+Amalia id per in minimum facility, quid facet modifier ea ma. Ill um select ma ad, en ferric patine sentient vim. Per expendable foreordained interpretations cu, maxim sole pertinacity in ram.