hugo-theme-relearn/README.md

# Hugo Relearn Theme

A theme for [Hugo](https://gohugo.io/) designed for documentation.

![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/hero.png)

## Motivation

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.

## Features

- Usable offline, no external dependencies
- Usable without a HTTP server from the file system
- Support for Internet Explorer 11
- Responsive design
- Configurable hidden pages
- Automatic next/prev buttons to navigate through menu entries
- Automatic Search
- Dedicated search page
- Support for GFM (GitHub Flavored Markdown)
- Print whole chapters or even the complete site
- Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, Finnish, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
- Full support for languages written right to left
- Unrestricted menu configuration relating to amount of items and level of nesting
- Font Awesome icons
- Tagging support
- Image styling like sizing, shadow, border and alignment
- Syntax highlighting
- Customizable look and feel
- Predefined (light, dark) and customizable color variants
- Automatic switch for light/dark mode dependend on your OS settings
- Attachments files
- List child pages
- Math and chemical formulae using the MathJax library
- Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.
- Swagger UI for OpenAPI Specifications
- Badges
- Buttons
- Tip/Note/Info/Warning boxes
- Expand
- Tabs
- File inclusion

## Installation

Visit the [installation instructions](https://mcshelby.github.io/hugo-theme-relearn/basics/installation) to learn how to setup the theme in your Hugo installation.

## Usage

Visit the [documentation](https://mcshelby.github.io/hugo-theme-relearn/) to learn about all available features and how to use them.

## Changelog

See the [What's New](https://mcshelby.github.io/hugo-theme-relearn/basics/migration) page for release highlights or the [history](https://mcshelby.github.io/hugo-theme-relearn/basics/history) for a complete list of changes per release.

## Contribution

You are most welcome to contribute bugfixes or even new features to the source code. Please visit the [contribution guidelines](https://mcshelby.github.io/hugo-theme-relearn/dev/contributing) first.

## License

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

## Credits

Special thanks to [everyone who has contributed](https://github.com/McShelby/hugo-theme-relearn/graphs/contributors) to this project.

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.

See the [credits](https://mcshelby.github.io/hugo-theme-relearn/more/credits) for a detailed list.
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`
feat: added minimal Readme 2016-03-17 11:05:36 +00:00
docs: elaborate on fork decision #26 2021-08-28 08:39:54 +00:00			`A theme for [Hugo](https://gohugo.io/) designed for documentation.`
Use status badge from Wercker 2018-08-10 09:29:11 +00:00
docs: make nicer screenshots 2023-01-24 22:58:16 +00:00			`![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/hero.png)`
Docs adjustments #1 2021-07-01 12:35:27 +00:00
docs: rework README.md #34 to avoid duplication of information 2021-08-23 16:54:02 +00:00			`## Motivation`

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.`
docs: rework README.md #34 to avoid duplication of information 2021-08-23 16:54:02 +00:00
docs: some love for the intro and credits 2022-12-14 21:46:59 +00:00			`## Features`
Update README for v2 2017-08-20 16:20:13 +00:00
docs: announcing more features 2022-03-27 20:22:10 +00:00			`- Usable offline, no external dependencies`
docs: announce new features #386 2022-11-17 22:52:54 +00:00			`- Usable without a HTTP server from the file system`
docs: announce all features 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`
Update README for v2 2017-08-20 16:20:13 +00:00			`- Automatic Search`
docs: announce new features #386 2022-11-17 22:52:54 +00:00			`- Dedicated search page`
docs: annouce GFM support #411 2022-12-02 15:20:45 +00:00			`- Support for GFM (GitHub Flavored Markdown)`
print: add option to print whole chapter #230 2022-04-02 13:29:34 +00:00			`- Print whole chapters or even the complete site`
i18n: add Czech translation #455 2023-01-30 16:05:32 +00:00			`- Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, Finnish, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese`
i18n: full support for RTL #470 2023-02-09 23:34:47 +00:00			`- Full support for languages written right to left`
docs: announce all features 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`
docs: some love for the intro and credits 2022-12-14 21:46:59 +00:00			`- Image styling like sizing, shadow, border and alignment`
docs: announce all features 2022-04-11 09:04:14 +00:00			`- Syntax highlighting`
docs: some love for the intro and credits 2022-12-14 21:46:59 +00:00			`- Customizable look and feel`
			`- Predefined (light, dark) and customizable color variants`
docs: announce auto variant #445 2023-02-04 23:21:38 +00:00			`- Automatic switch for light/dark mode dependend on your OS settings`
Update README for v2 2017-08-20 16:20:13 +00:00			`- Attachments files`
			`- List child pages`
math: add mathjax rendering #235 2022-07-02 12:00:23 +00:00			`- Math and chemical formulae using the MathJax library`
docs: announce all features 2022-04-11 09:04:14 +00:00			`- Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.`
swagger: add support for oas/swagger documentation #226 basic swagger integration 2022-03-27 16:42:11 +00:00			`- Swagger UI for OpenAPI Specifications`
badge: announce feature #410 2022-12-01 00:44:20 +00:00			`- Badges`
docs: elaborate on fork decision #26 2021-08-28 08:39:54 +00:00			`- Buttons`
			`- Tip/Note/Info/Warning boxes`
			`- Expand`
			`- Tabs`
			`- File inclusion`
docs: some love for the intro and credits 2022-12-14 21:46:59 +00:00
Update README.md 2016-12-30 21:40:05 +00:00			`## Installation`
Update README for v2 2017-08-20 16:20:13 +00:00
task: swtich from netlify to gh-pages 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.`
add minium version 2017-04-08 08:30:09 +00:00
Update README.md 2016-12-30 21:40:05 +00:00			`## Usage`

task: swtich from netlify to gh-pages 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.`
credits to @vjeantet 2017-08-20 23:29:54 +00:00
theme: tweak README link changelog outsource release instructions 2021-08-22 11:31:52 +00:00			`## Changelog`

docs: some love for the intro and credits 2022-12-14 21:46:59 +00:00			`See the [What's New](https://mcshelby.github.io/hugo-theme-relearn/basics/migration) page for release highlights or the [history](https://mcshelby.github.io/hugo-theme-relearn/basics/history) for a complete list of changes per release.`
theme: tweak README link changelog outsource release instructions 2021-08-22 11:31:52 +00:00
docs: first draft of contribution guidelines 2021-08-30 20:30:00 +00:00			`## Contribution`

docs: add contribution and release guidelines 2023-01-28 13:48:08 +00:00			`You are most welcome to contribute bugfixes or even new features to the source code. Please visit the [contribution guidelines](https://mcshelby.github.io/hugo-theme-relearn/dev/contributing) first.`
docs: first draft of contribution guidelines 2021-08-30 20:30:00 +00:00
Docs adjustments #1 2021-07-01 12:35:27 +00:00			`## License`
credits to @vjeantet 2017-08-20 23:29:54 +00:00
docs: more links for starters 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).`
Add license scan report and status Signed-off-by: fossabot <badges@fossa.io> 2018-07-24 14:45:37 +00:00
Docs adjustments #1 2021-07-01 12:35:27 +00:00			`## Credits`
Initial instructions on releasing with gren 2019-09-04 21:47:55 +00:00
docs: rework README.md #34 to avoid duplication of information 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.`
Contributers cleanup #1 2021-07-01 12:57:26 +00:00
docs: mention Andy Miller for his work on Learn for Grav 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.`
docs: some love for the intro and credits 2022-12-14 21:46:59 +00:00
docs: fix credits link 2022-12-14 21:55:48 +00:00			`See the [credits](https://mcshelby.github.io/hugo-theme-relearn/more/credits) for a detailed list.`