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
2023-02-10 23:03:31 +00:00
A theme for [Hugo ](https://gohugo.io/ ) designed for documentation.
2023-02-10 21:16:59 +00:00
2023-10-24 20:49:34 +00:00
[★ What's new in the latest release ★ ](basics/migration )
2023-02-10 21:16:59 +00:00
2024-03-10 13:40:23 +00:00
2023-02-10 21:16:59 +00:00
## Motivation
2017-08-16 22:57:44 +00:00
2023-10-30 20:58:38 +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 adapting 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
2022-12-14 21:46:59 +00:00
## Features
2017-08-16 22:57:44 +00:00
2023-02-10 21:16:59 +00:00
- **Wide set of usage scenarios**
- Responsive design for mobile usage
2023-09-23 23:29:41 +00:00
- Looks nice on paper (if it has to)
2023-02-10 21:16:59 +00:00
- Usable offline, no external dependencies
2024-02-24 15:52:53 +00:00
- [Usable from your local file system via `file://` protocol ](basics/customization#file-system )
2023-02-19 23:20:37 +00:00
- Support for the [VSCode Front Matter extension ](https://github.com/estruyf/vscode-front-matter ) for on-premise CMS capabilities
2023-11-20 23:53:33 +00:00
- [Support for Open Graph and Twitter Cards ](basics/customization#social-media-meta-tags )
2023-02-10 21:16:59 +00:00
- **Configurable theming and visuals**
2023-11-29 19:46:56 +00:00
- [Configurable brand images ](basics/branding#change-the-logo )
2024-04-12 15:30:16 +00:00
- [Automatic switch for light/dark variant depending on your OS settings ](basics/branding#adjust-to-os-settings )
2023-02-10 21:16:59 +00:00
- Predefined light, dark and color variants
2023-11-29 20:37:06 +00:00
- [User selectable variants ](basics/branding#multiple-variants )
2023-10-24 20:49:34 +00:00
- [Stylesheet generator ](basics/generator/ )
- [Configurable syntax highlighting ](shortcodes/highlight )
2023-02-10 21:16:59 +00:00
- **Unique theme features**
2023-11-20 23:53:33 +00:00
- [Print whole chapters or even the complete site ](basics/customization#activate-print-support )
2023-02-10 21:16:59 +00:00
- In page search
2023-11-20 23:53:33 +00:00
- [Site search ](basics/customization#activate-search )
- [Dedicated search page ](basics/customization#activate-dedicated-search-page )
2023-10-24 20:49:34 +00:00
- [Taxonomy support ](cont/taxonomy )
- [Configurable topbar buttons ](basics/topbar )
- [Unlimited nested menu items ](cont/pages )
- [Configurable shortcut links ](cont/menushortcuts )
2023-09-23 23:23:45 +00:00
- Hidden pages
2023-02-10 21:16:59 +00:00
- **Multi language support**
2023-10-24 20:49:34 +00:00
- [Full support for languages written right to left ](cont/i18n )
2024-04-12 14:47:21 +00:00
- [Available languages ](cont/i18n#basic-configuration ): Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese
2023-10-24 20:49:34 +00:00
- [Search support for mixed language content ](cont/i18n#search )
2023-02-10 21:16:59 +00:00
- **Additional Markdown features**
2023-10-30 22:10:34 +00:00
- [Support for GFM (GitHub Flavored Markdown) ](cont/markdown )
2023-10-24 20:49:34 +00:00
- [Image effects like sizing, shadow, border and alignment ](cont/markdown#image-effects )
- [Image lightbox ](cont/markdown#lightbox )
2023-02-10 21:16:59 +00:00
- **Shortcodes galore**
2024-02-29 19:45:01 +00:00
- [Display resources contained in a page bundle ](shortcodes/resources )
2023-10-24 20:49:34 +00:00
- [Marker badges ](shortcodes/badge )
- [Configurable buttons ](shortcodes/button )
- [List child pages ](shortcodes/children )
- [Expand areas to reveal content ](shortcodes/expand )
- [Font Awesome icons ](shortcodes/icon )
- [Inclusion of other files ](shortcodes/include )
- [Math and chemical formulae using MathJax ](shortcodes/math )
- [Mermaid diagrams for flowcharts, sequences, gantts, pie, etc. ](shortcodes/mermaid )
- [Colorful boxes ](shortcodes/notice )
- [OpenAPI specifications using Swagger UI ](shortcodes/openapi )
- [Reveal you site's configuration parameter ](shortcodes/siteparam )
- [Single tabbed panels ](shortcodes/tab ) and [multiple tabbed panels ](shortcodes/tabs )
2023-02-10 21:16:59 +00:00
## 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
2023-02-10 21:16:59 +00:00
## Contributions
2017-08-16 22:57:44 +00:00
2023-09-18 18:24:49 +00:00
Feel free to contribute to this documentation by just clicking the {{% button style="transparent" icon="pen" %}}{{% /button %}} _edit_ button displayed on top right of each page.
2021-07-01 14:25:08 +00:00
2023-10-24 20:49:34 +00:00
You are most welcome to contribute bugfixes or new features by making pull requests to the [official repository ](https://github.com/McShelby/hugo-theme-relearn ). Check the [contribution guidelines ](dev/contributing ) first before starting.
2017-08-16 22:57:44 +00:00
2021-08-28 09:18:43 +00:00
## License
2023-02-10 21:16:59 +00:00
The Relearn theme is licensed under the [MIT License ](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE ).
2021-08-28 09:18:43 +00:00
## Credits
2023-10-24 20:49:34 +00:00
This theme would not be possible without the work of [many others ](more/credits ).
