hugo-theme-relearn/README.md

49 lines
1.6 KiB
Markdown
Raw Normal View History

# 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
![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/screenshot.png)
2021-07-01 12:35:27 +00:00
## Motivation
2021-08-28 08:39:54 +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.
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)
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
2021-07-01 12:35:27 +00:00
2016-12-30 21:40:05 +00:00
## Installation
2017-08-20 16:20:13 +00:00
Visit the [installation instructions](https://relearn.netlify.app/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
Visit the [documentation](https://relearn.netlify.app/) to learn about all available features and how to use them.
2017-08-20 23:29:54 +00:00
## Changelog
See the [changelog](https://relearn.netlify.app/basics/history) for a complete list of releases.
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).
2021-07-01 12:35:27 +00:00
## Credits
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
Many thanks to [@matcornic](https://github.com/matcornic) for his work on [hugo-theme-learn](https://github.com/matcornic/hugo-theme-learn).