hugo-theme-relearn/exampleSite/content/_index.en.md

+++
title = "Hugo Relearn Theme"
+++

# Hugo Relearn Theme

The [Relearn theme](http://github.com/McShelby/hugo-theme-relearn) is a theme for [Hugo](https://gohugo.io/), a static website generator written in Go. Where Hugo is often used for blogs, this theme is designed with documentation in mind.

{{% notice info %}}
The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo-theme-learn) with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.
{{% /notice %}}

## Main features

{{% notice tip %}}
See [what's new]({{% relref "basics/migration" %}}) within the latest update.
{{% /notice %}}

* [Automatic Search]({{%relref "basics/configuration#activate-search" %}})
* [Multilingual mode]({{%relref "cont/i18n" %}})
* Unlimited menu levels
* Automatic next/prev buttons to navigate through menu entries
* [Image resizing, shadow...]({{%relref "cont/markdown#images" %}})
* [Attachments files]({{%relref "shortcodes/attachments" %}})
* [List child pages]({{%relref "shortcodes/children" %}})
* [Mermaid diagram]({{%relref "shortcodes/mermaid" %}}) (flowchart, sequence, gantt)
* [Customizable look and feel and light or dark theme variants]({{%relref "basics/customization"%}})
* [Buttons]({{%relref "shortcodes/button" %}})
* [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice" %}})
* [Expand]({{%relref "shortcodes/expand" %}})
* [Tabs]({{%relref "shortcodes/tabs" %}})
* [File inclusion]({{%relref "shortcodes/include" %}})

## Getting support

To get support, feel free to open a new [discussion topic](https://github.com/McShelby/hugo-theme-relearn/discussions) or [issue](https://github.com/McShelby/hugo-theme-relearn/issues) in the official repository on GitHub.

## Become a contributor

Feel free to update this documentation by just clicking the **Edit** link displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.

You are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the [official repository](https://github.com/McShelby/hugo-theme-relearn) via GitHub. Please visit the [contribution guidelines](https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/contributing.md) first.

## License

This theme is licensed under the [MIT License](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE).

## Credits

This theme would not be possible without the work of many others. See the [credits]({{%relref "more/credits" %}}) for a detailed list.
theme: convert front matter to TOML #52 remove date field 2021-08-25 11:33:29 +00:00			`+++`
docs: adjust breadcrumb and title for empty home page titles #202 2022-02-24 22:10:10 +00:00			`title = "Hugo Relearn Theme"`
theme: convert front matter to TOML #52 remove date field 2021-08-25 11:33:29 +00:00			`+++`
add first content for new documentation 2017-08-16 22:57:44 +00:00
Rebranding to new theme name - Rename theme from "Learn" to "Relearn" - also change URLs - remove old references - more removal of french and chinese 2021-06-30 12:56:06 +00:00			`# Hugo Relearn Theme`
add first content for new documentation 2017-08-16 22:57:44 +00:00
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`The [Relearn theme](http://github.com/McShelby/hugo-theme-relearn) is a theme for [Hugo](https://gohugo.io/), a static website generator written in Go. Where Hugo is often used for blogs, this theme is designed with documentation in mind.`
add first content for new documentation 2017-08-16 22:57:44 +00:00
docs: elaborate on fork decision #26 2021-08-28 08:39:54 +00:00			`{{% notice info %}}`
docs: updated screenshots because of earlier changes to color 2021-10-24 11:01:01 +00:00			`The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo-theme-learn) with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.`
add first content for new documentation 2017-08-16 22:57:44 +00:00			`{{% /notice %}}`

			`## Main features`

docs: what's new page #103 2021-10-07 19:19:55 +00:00			`{{% notice tip %}}`
			`See [what's new]({{% relref "basics/migration" %}}) within the latest update.`
			`{{% /notice %}}`

relref: fix inconsistent behaviour #156 by removing our own implementation fo ref/relref 2021-11-19 22:37:19 +00:00			`* [Automatic Search]({{%relref "basics/configuration#activate-search" %}})`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`* [Multilingual mode]({{%relref "cont/i18n" %}})`
docs: elaborate on fork decision #26 2021-08-28 08:39:54 +00:00			`* Unlimited menu levels`
			`* Automatic next/prev buttons to navigate through menu entries`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`* [Image resizing, shadow...]({{%relref "cont/markdown#images" %}})`
			`* [Attachments files]({{%relref "shortcodes/attachments" %}})`
			`* [List child pages]({{%relref "shortcodes/children" %}})`
			`* [Mermaid diagram]({{%relref "shortcodes/mermaid" %}}) (flowchart, sequence, gantt)`
docs: announce dark mode #188 2022-02-21 23:18:56 +00:00			`* [Customizable look and feel and light or dark theme variants]({{%relref "basics/customization"%}})`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`* [Buttons]({{%relref "shortcodes/button" %}})`
			`* [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice" %}})`
			`* [Expand]({{%relref "shortcodes/expand" %}})`
			`* [Tabs]({{%relref "shortcodes/tabs" %}})`
			`* [File inclusion]({{%relref "shortcodes/include" %}})`
add first content for new documentation 2017-08-16 22:57:44 +00:00
docs: more links for starters 2021-08-28 09:18:43 +00:00			`## Getting support`
Reworking screenshots after rebranding 2021-07-01 14:25:08 +00:00
docs: more links for starters 2021-08-28 09:18:43 +00:00			`To get support, feel free to open a new [discussion topic](https://github.com/McShelby/hugo-theme-relearn/discussions) or [issue](https://github.com/McShelby/hugo-theme-relearn/issues) in the official repository on GitHub.`
add first content for new documentation 2017-08-16 22:57:44 +00:00
docs: more links for starters 2021-08-28 09:18:43 +00:00			`## Become a contributor`
add first content for new documentation 2017-08-16 22:57:44 +00:00
nav: rework edit button #151 2022-02-14 23:22:34 +00:00			`Feel free to update this documentation by just clicking the Edit link displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.`
Reworking screenshots after rebranding 2021-07-01 14:25:08 +00:00
task: lowercase contributing.md 2021-10-19 15:24:10 +00:00			`You are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the [official repository](https://github.com/McShelby/hugo-theme-relearn) via GitHub. Please visit the [contribution guidelines](https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/contributing.md) first.`
add first content for new documentation 2017-08-16 22:57:44 +00:00
docs: more links for starters 2021-08-28 09:18:43 +00:00			`## License`

			`This theme is licensed under the [MIT License](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE).`

			`## Credits`

docs: cleanup #188 2022-02-21 23:04:16 +00:00			`This theme would not be possible without the work of many others. See the [credits]({{%relref "more/credits" %}}) for a detailed list.`