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/screenshot.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.

## Main 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, Dutch, Finnish (Suomi), French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
- 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 resizing, shadow…
- Syntax highlighting
- 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
- Customizable look and feel
- Predefined (light, dark) and customizable color variants
- 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 [changelog](https://mcshelby.github.io/hugo-theme-relearn/basics/history) for a complete list of releases.

## Contribution

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.

## 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.
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 14:56:06 +02:00			`# Hugo Relearn Theme`
feat: added minimal Readme 2016-03-17 12:05:36 +01:00
docs: elaborate on fork decision #26 2021-08-28 10:39:54 +02:00			`A theme for [Hugo](https://gohugo.io/) designed for documentation.`
Use status badge from Wercker 2018-08-10 11:29:11 +02:00
Reworking screenshots after rebranding 2021-07-01 16:25:08 +02:00			`![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/screenshot.png)`
Docs adjustments #1 2021-07-01 14:35:27 +02:00
docs: rework README.md #34 to avoid duplication of information 2021-08-23 18:54:02 +02:00			`## Motivation`

docs: updated screenshots because of earlier changes to color 2021-10-24 13:01:01 +02: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 18:54:02 +02:00
Update README for v2 2017-08-20 18:20:13 +02:00			`## Main features`

docs: announcing more features 2022-03-27 22:22:10 +02:00			`- Usable offline, no external dependencies`
docs: announce new features #386 2022-11-17 23:52:54 +01:00			`- Usable without a HTTP server from the file system`
docs: announce all features 2022-04-11 11:04:14 +02: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 18:20:13 +02:00			`- Automatic Search`
docs: announce new features #386 2022-11-17 23:52:54 +01:00			`- Dedicated search page`
docs: annouce GFM support #411 2022-12-02 16:20:45 +01:00			`- Support for GFM (GitHub Flavored Markdown)`
print: add option to print whole chapter #230 2022-04-02 15:29:34 +02:00			`- Print whole chapters or even the complete site`
docs: fix typo 2022-10-31 15:05:33 +01: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`
docs: announce RTL support #357 2022-11-01 02:10:05 +01:00			`- Support for languages written right to left`
docs: announce all features 2022-04-11 11:04:14 +02:00			`- Unrestricted menu configuration relating to amount of items and level of nesting`
			`- Font Awesome icons`
			`- Tagging support`
Update README for v2 2017-08-20 18:20:13 +02:00			`- Image resizing, shadow…`
docs: announce all features 2022-04-11 11:04:14 +02:00			`- Syntax highlighting`
Update README for v2 2017-08-20 18:20:13 +02:00			`- Attachments files`
			`- List child pages`
math: add mathjax rendering #235 2022-07-02 14:00:23 +02:00			`- Math and chemical formulae using the MathJax library`
docs: announce all features 2022-04-11 11:04:14 +02:00			`- Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.`
swagger: add support for oas/swagger documentation #226 basic swagger integration 2022-03-27 18:42:11 +02:00			`- Swagger UI for OpenAPI Specifications`
docs: finalizing README for next release 2022-03-15 20:59:24 +01:00			`- Customizable look and feel`
language: announcing korean translation #216 #217 2022-03-16 07:59:25 +01:00			`- Predefined (light, dark) and customizable color variants`
badge: announce feature #410 2022-12-01 01:44:20 +01:00			`- Badges`
docs: elaborate on fork decision #26 2021-08-28 10:39:54 +02:00			`- Buttons`
			`- Tip/Note/Info/Warning boxes`
			`- Expand`
			`- Tabs`
			`- File inclusion`
Update README.md 2016-12-30 22:40:05 +01:00			`## Installation`
Update README for v2 2017-08-20 18:20:13 +02:00
task: swtich from netlify to gh-pages 2021-10-17 23:37:32 +02: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 10:30:09 +02:00
Update README.md 2016-12-30 22:40:05 +01:00			`## Usage`

task: swtich from netlify to gh-pages 2021-10-17 23:37:32 +02: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-21 01:29:54 +02:00
theme: tweak README link changelog outsource release instructions 2021-08-22 13:31:52 +02:00			`## Changelog`

task: swtich from netlify to gh-pages 2021-10-17 23:37:32 +02:00			`See the [changelog](https://mcshelby.github.io/hugo-theme-relearn/basics/history) for a complete list of releases.`
theme: tweak README link changelog outsource release instructions 2021-08-22 13:31:52 +02:00
docs: first draft of contribution guidelines 2021-08-30 22:30:00 +02:00			`## Contribution`

task: lowercase contributing.md 2021-10-19 17:24:10 +02: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.`
docs: first draft of contribution guidelines 2021-08-30 22:30:00 +02:00
Docs adjustments #1 2021-07-01 14:35:27 +02:00			`## License`
credits to @vjeantet 2017-08-21 01:29:54 +02:00
docs: more links for starters 2021-08-28 11:18:43 +02: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 07:45:37 -07:00
Docs adjustments #1 2021-07-01 14:35:27 +02:00			`## Credits`
Initial instructions on releasing with gren 2019-09-04 22:47:55 +01:00
docs: rework README.md #34 to avoid duplication of information 2021-08-23 18:54:02 +02: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 14:57:26 +02:00
docs: mention Andy Miller for his work on Learn for Grav 2022-03-06 19:09:58 +01: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.`