hugo-theme-relearn/README.md

58 lines
2.2 KiB
Markdown
Raw Normal View History

2016-04-10 22:25:22 +00:00
# Hugo Learn Theme
2016-03-17 11:05:36 +00:00
This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Grav Learn Theme](http://learn.getgrav.org/).
2017-08-20 16:20:13 +00:00
Visit the [theme documentation](https://learn.netlify.com/en/) to see what is going on. It is actually built with this theme.
## 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
2016-12-30 21:40:05 +00:00
## Installation
2017-08-20 16:20:13 +00:00
Navigate to your themes folder in your Hugo site and use the following commands:
2017-08-20 16:20:13 +00:00
```
$ cd themes
$ git clone https://github.com/matcornic/hugo-theme-learn.git
```
2017-08-20 16:20:13 +00:00
Check that your Hugo version is minimum `0.25` with `hugo version`.
2017-04-08 08:30:09 +00:00
2016-10-23 17:01:52 +00:00
![Overview](https://github.com/matcornic/hugo-theme-learn/raw/master/images/tn.png)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_shield)
2016-04-12 00:48:31 +00:00
2016-12-30 21:40:05 +00:00
## Usage
2017-08-20 16:20:13 +00:00
- [Visit the documentation](https://learn.netlify.com/en/)
2016-12-30 21:40:05 +00:00
2017-08-20 16:20:13 +00:00
## Download old versions (prior to 2.0.0)
2017-08-20 16:20:13 +00:00
If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0`
2017-08-20 16:20:13 +00:00
- Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip
- Git way:
2017-04-08 08:27:00 +00:00
```shell
cd themes/hugo-theme-learn
2017-08-20 16:20:13 +00:00
git checkout tags/1.1.0
2017-04-08 08:27:00 +00:00
```
2017-08-20 16:20:13 +00:00
For both solutions, the documentation is available at https://github.com/matcornic/hugo-theme-learn/releases/download/1.1.0/hugo-learn-doc-1.1.0.zip
2017-08-20 23:29:54 +00:00
## Credits
2017-08-20 23:30:22 +00:00
Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work !
## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_large)