2021-06-30 12:56:06 +00:00
# Hugo Relearn Theme
2016-03-17 11:05:36 +00:00
2021-08-28 08:39:54 +00:00
A theme for [Hugo ](https://gohugo.io/ ) designed for documentation.
2018-08-10 09:29:11 +00:00
2021-07-01 14:25:08 +00:00
2021-07-01 12:35:27 +00:00
2021-08-23 16:54:02 +00:00
## Motivation
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.
2021-08-23 16:54:02 +00:00
2017-08-20 16:20:13 +00:00
## Main features
2022-03-27 20:22:10 +00:00
- Usable offline, no external dependencies
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
2017-08-20 16:20:13 +00:00
- Automatic Search
2022-04-02 13:29:34 +00:00
- Print whole chapters or even the complete site
2022-10-31 14:05:33 +00:00
- Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinese, Dutch, Finnish (Suomi), 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 relating to amount of items and level of nesting
- Font Awesome icons
- Tagging support
2017-08-20 16:20:13 +00:00
- Image resizing, shadow…
2022-04-11 09:04:14 +00:00
- Syntax highlighting
2017-08-20 16:20:13 +00:00
- Attachments files
- List child pages
2022-07-02 12:00:23 +00:00
- Math and chemical formulae using the MathJax library
2022-04-11 09:04:14 +00:00
- Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.
2022-03-27 16:42:11 +00:00
- Swagger UI for OpenAPI Specifications
2022-03-15 19:59:24 +00:00
- Customizable look and feel
2022-03-16 06:59:25 +00:00
- Predefined (light, dark) and customizable color variants
2021-08-28 08:39:54 +00:00
- Buttons
- Tip/Note/Info/Warning boxes
- Expand
- Tabs
- File inclusion
2016-12-30 21:40:05 +00:00
## Installation
2017-08-20 16:20:13 +00:00
2021-10-17 21:37:32 +00:00
Visit the [installation instructions ](https://mcshelby.github.io/hugo-theme-relearn/basics/installation ) to learn how to setup the theme in your Hugo installation.
2017-04-08 08:30:09 +00:00
2016-12-30 21:40:05 +00:00
## Usage
2021-10-17 21:37:32 +00:00
Visit the [documentation ](https://mcshelby.github.io/hugo-theme-relearn/ ) to learn about all available features and how to use them.
2017-08-20 23:29:54 +00:00
2021-08-22 11:31:52 +00:00
## Changelog
2021-10-17 21:37:32 +00:00
See the [changelog ](https://mcshelby.github.io/hugo-theme-relearn/basics/history ) for a complete list of releases.
2021-08-22 11:31:52 +00:00
2021-08-30 20:30:00 +00:00
## Contribution
2021-10-19 15:24:10 +00:00
You are most welcome to contribute to the source code but please visit the [contribution guidelines ](https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/contributing.md ) first.
2021-08-30 20:30:00 +00:00
2021-07-01 12:35:27 +00:00
## License
2017-08-20 23:29:54 +00:00
2021-08-28 09:18:43 +00:00
This theme is licensed under the [MIT License ](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE ).
2018-07-24 14:45:37 +00:00
2021-07-01 12:35:27 +00:00
## Credits
2019-09-04 21:47:55 +00:00
2021-08-23 16:54:02 +00:00
Special thanks to [everyone who has contributed ](https://github.com/McShelby/hugo-theme-relearn/graphs/contributors ) to this project.
2021-07-01 12:57:26 +00:00
2022-03-06 18:09:58 +00:00
Many thanks to [Mathieu Cornic ](https://github.com/matcornic ) for his work on porting the [Learn theme ](https://github.com/matcornic/hugo-theme-learn ) to Hugo.
Many thanks to [Andy Miller ](https://github.com/rhukster ) for initially creating the [Learn theme ](https://github.com/getgrav/grav-theme-learn2 ) for Grav.
