2021-08-25 11:33:29 +00:00
+++
2022-07-04 22:19:27 +00:00
archetype = "home"
2022-02-24 22:10:10 +00:00
title = "Hugo Relearn Theme"
2021-08-25 11:33:29 +00:00
+++
2017-08-16 22:57:44 +00:00
2022-12-21 23:49:08 +00:00
The [Relearn theme ](https://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.
2017-08-16 22:57:44 +00:00
2021-08-28 08:39:54 +00:00
{{% notice info %}}
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.
2017-08-16 22:57:44 +00:00
{{% /notice %}}
2022-12-14 21:46:59 +00:00
## Features
2017-08-16 22:57:44 +00:00
2021-10-07 19:19:55 +00:00
{{% notice tip %}}
2022-12-14 21:46:59 +00:00
See [What's New ]({{% relref "basics/migration" %}} ) within the latest update.
2021-10-07 19:19:55 +00:00
{{% /notice %}}
2022-04-11 09:04:14 +00:00
- Usable offline, no external dependencies
2022-11-17 22:52:54 +00:00
- Usable without a HTTP server from the file system
2022-04-11 09:04:14 +00:00
- Support for Internet Explorer 11
- Responsive design
- Configurable hidden pages
- Automatic next/prev buttons to navigate through menu entries
- [Automatic Search ]({{%relref "basics/configuration#activate-search" %}} )
2022-11-17 22:52:54 +00:00
- [Dedicated search page ]({{%relref "basics/configuration#activate-dedicated-search-page" %}} )
2022-12-02 15:20:45 +00:00
- [Support for GFM ]({{% relref "cont/markdown" %}} ) (GitHub Flavored Markdown)
2022-04-11 09:04:14 +00:00
- [Print ]({{%relref "basics/configuration#activate-print-support" %}} ) whole chapters or even the complete site
2023-01-30 16:05:32 +00:00
- [Multilingual mode ]({{%relref "cont/i18n" %}} ) for English, Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, Finnish, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
2022-11-01 01:10:05 +00:00
- Support for languages written right to left
2022-04-11 09:04:14 +00:00
- [Unrestricted menu configuration ]({{%relref "cont/menushortcuts" %}} ) relating to amount of items and level of nesting
2022-12-02 17:31:54 +00:00
- [Font Awesome icons ]({{%relref "shortcodes/icon" %}} )
2022-04-11 09:04:14 +00:00
- [Tagging support ]({{%relref "cont/tags" %}} )
2022-12-14 21:46:59 +00:00
- [Image styling ]({{%relref "cont/markdown#images" %}} ) like sizing, shadow, border and alignment
2022-04-11 09:04:14 +00:00
- [Syntax highlighting ]({{%relref "cont/syntaxhighlight" %}} )
2022-12-14 21:46:59 +00:00
- [Customizable look and feel ]({{%relref "basics/customization"%}} )
- [Predefined (light, dark) and customizable color variants ]({{%relref "basics/generator" %}} )
2023-02-04 23:21:38 +00:00
- [Automatic switch for light/dark mode ]({{%relref "basics/customization/#adjust-to-os-settings" %}} ) dependend on your OS settings
2022-04-11 09:04:14 +00:00
- [Attachments files ]({{%relref "shortcodes/attachments" %}} )
- [List child pages ]({{%relref "shortcodes/children" %}} )
2022-11-17 22:52:54 +00:00
- [Math and chemical formulae ]({{%relref "shortcodes/math" %}} ) using the MathJax library
2022-04-11 09:04:14 +00:00
- [Mermaid diagrams ]({{%relref "shortcodes/mermaid" %}} ) for flowcharts, sequences, gantts, pie, etc.
- [Swagger UI ]({{%relref "shortcodes/swagger" %}} ) for OpenAPI Specifications
2022-12-01 00:44:20 +00:00
- [Badges ]({{%relref "shortcodes/badge" %}} )
2022-04-11 09:04: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" %}} )
2017-08-16 22:57:44 +00:00
2022-12-14 21:46:59 +00:00
## Getting Support
2021-07-01 14:25:08 +00:00
2022-12-14 21:46:59 +00:00
To get support, feel free to open a new [discussion topic ](https://github.com/McShelby/hugo-theme-relearn/discussions ) or [issue report ](https://github.com/McShelby/hugo-theme-relearn/issues ) in the official repository on GitHub.
2017-08-16 22:57:44 +00:00
2022-12-14 21:46:59 +00:00
## Become a Contributor
2017-08-16 22:57:44 +00:00
2022-12-14 21:46:59 +00:00
Feel free to update this documentation by just clicking the {{% button style="transparent" icon="pen" %}}{{% /button %}} button displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.
2021-07-01 14:25:08 +00:00
2023-01-28 13:48:08 +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 ]({{%relref "dev/contributing" %}} ) first.
2017-08-16 22:57:44 +00:00
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
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.
