mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 10:43:19 +00:00
51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
# Hugo Relearn Theme
|
|
|
|
A theme for [Hugo](https://gohugo.io/).
|
|
|
|
[](https://app.wercker.com/project/byKey/062e9604da64b79944d87434cb63fa53)
|
|
|
|
|
|
|
|
## 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.
|