hugo-theme-relearn/README.md

# Hugo Relearn Theme

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

[![wercker status](https://app.wercker.com/status/062e9604da64b79944d87434cb63fa53/s/main "wercker status")](https://app.wercker.com/project/byKey/062e9604da64b79944d87434cb63fa53)

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

## 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 themes variants
- Buttons, Tip/Note/Info/Warning boxes, Expand, Tabs

Visit the [documentation](https://relearn.netlify.app/) for a demo.

## Installation

Navigate to your themes folder in your Hugo site and use the following commands:

```shell
cd themes/
git clone https://github.com/McShelby/hugo-theme-relearn.git
```

Check that your Hugo version is minimum `0.25` with `hugo version`.

## Usage

- [Visit the documentation](https://relearn.netlify.app/)

## Changelog

[The changelog can be seen here.](https://github.com/McShelby/hugo-theme-relearn/blob/main/CHANGELOG.md)

## License

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

## Credits

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

Special thanks to [@matcornic](https://github.com/matcornic) for his work on [learn](https://github.com/matcornic/hugo-theme-learn) and [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), which hugo-theme-relearn is based on.
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 adjustments #1 2021-07-01 14:35:27 +02:00			`A theme for [Hugo](https://gohugo.io/).`
Update README for v2 2017-08-20 18:20:13 +02:00
Compliance: Rename branch master to main 2021-07-01 11:01:51 +02:00			`[![wercker status](https://app.wercker.com/status/062e9604da64b79944d87434cb63fa53/s/main "wercker status")](https://app.wercker.com/project/byKey/062e9604da64b79944d87434cb63fa53)`
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
Update README for v2 2017-08-20 18:20:13 +02: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)`
			`- Customizable look and feel and themes variants`
Docs adjustments #1 2021-07-01 14:35:27 +02:00			`- Buttons, Tip/Note/Info/Warning boxes, Expand, Tabs`

			`Visit the [documentation](https://relearn.netlify.app/) for a demo.`
feat: partials for style and scripts are now empty 2016-04-11 00:09:03 +02:00
Update README.md 2016-12-30 22:40:05 +01:00			`## Installation`
Update README for v2 2017-08-20 18:20:13 +02:00
doc: Add theme installation instructions 2016-04-12 06:34:40 -04:00			`Navigate to your themes folder in your Hugo site and use the following commands:`
Update README for v2 2017-08-20 18:20:13 +02:00
Initial instructions on releasing with gren 2019-09-04 22:47:55 +01:00			```shell
			`cd themes/`
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			`git clone https://github.com/McShelby/hugo-theme-relearn.git`
doc: Add theme installation instructions 2016-04-12 06:34:40 -04:00			```

Update README for v2 2017-08-20 18:20:13 +02:00			Check that your Hugo version is minimum `0.25` with `hugo version`.
add minium version 2017-04-08 10:30:09 +02:00
Update README.md 2016-12-30 22:40:05 +01:00			`## Usage`

Netlify moved content 2021-07-01 08:17:24 +02:00			`- [Visit the documentation](https://relearn.netlify.app/)`
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`

			`[The changelog can be seen here.](https://github.com/McShelby/hugo-theme-relearn/blob/main/CHANGELOG.md)`

Docs adjustments #1 2021-07-01 14:35:27 +02:00			`## License`
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			`[MIT licensed.](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
Contributers cleanup #1 2021-07-01 14:57:26 +02:00			`Many thanks to [everyone who has contributed](https://github.com/McShelby/hugo-theme-relearn/graphs/contributors) to this project.`

			`Special thanks to [@matcornic](https://github.com/matcornic) for his work on [learn](https://github.com/matcornic/hugo-theme-learn) and [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), which hugo-theme-relearn is based on.`