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 initially was a fork of the great [hugo-theme-learn](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 hugo-theme-learn.

## Main features

- Automatic Search
- Multilingual mode
- Unlimited menu levels
- Automatic next/prev buttons to navigate through menu entries
- Image resizing, shadow…
- Attachments files
- List child pages
- Mermaid diagram (flowchart, sequence, gantt)
- Customizable look and feel and theme variants
- Buttons
- Tip/Note/Info/Warning boxes
- Expand
- Tabs
- File inclusion

## Installation

Visit the [installation instructions](https://relearn.netlify.app/basics/installation) to learn how to setup the theme in your Hugo installation.

## Usage

Visit the [documentation](https://relearn.netlify.app/) to learn about all available features and how to use them.

## Changelog

See the [changelog](https://relearn.netlify.app/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 [@matcornic](https://github.com/matcornic) for his work on [hugo-theme-learn](https://github.com/matcornic/hugo-theme-learn).
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
Reworking screenshots after rebranding 2021-07-01 14:25:08 +00:00			`![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/screenshot.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: wildspace 2021-09-07 19:56:45 +00:00			`The theme initially was a fork of the great [hugo-theme-learn](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 hugo-theme-learn.`
docs: rework README.md #34 to avoid duplication of information 2021-08-23 16:54:02 +00:00
Update README for v2 2017-08-20 16:20:13 +00:00			`## Main features`

			`- Automatic Search`
			`- Multilingual mode`
			`- Unlimited menu levels`
			`- Automatic next/prev buttons to navigate through menu entries`
			`- Image resizing, shadow…`
			`- Attachments files`
			`- List child pages`
			`- Mermaid diagram (flowchart, sequence, gantt)`
docs: elaborate on fork decision #26 2021-08-28 08:39:54 +00:00			`- Customizable look and feel and theme variants`
			`- Buttons`
			`- Tip/Note/Info/Warning boxes`
			`- Expand`
			`- Tabs`
			`- File inclusion`
Docs adjustments #1 2021-07-01 12:35:27 +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
docs: rework README.md #34 to avoid duplication of information 2021-08-23 16:54:02 +00:00			`Visit the [installation instructions](https://relearn.netlify.app/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`

docs: rework README.md #34 to avoid duplication of information 2021-08-23 16:54:02 +00:00			`Visit the [documentation](https://relearn.netlify.app/) 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: show CHANGELOG in exampleSite #33 2021-08-23 20:20:29 +00:00			`See the [changelog](https://relearn.netlify.app/basics/history) for a complete list of releases.`
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`

			`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 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: rework README.md #34 to avoid duplication of information 2021-08-23 16:54:02 +00:00			`Many thanks to [@matcornic](https://github.com/matcornic) for his work on [hugo-theme-learn](https://github.com/matcornic/hugo-theme-learn).`