2016-04-10 22:25:22 +00:00
# Hugo Learn Theme
2016-03-17 11:05:36 +00:00
2016-04-10 22:09:03 +00:00
This repository contains a theme for [Hugo ](https://gohugo.io/ ), based on great [Grav Learn Theme ](http://learn.getgrav.org/ ).
2016-03-17 11:07:26 +00:00
2016-04-10 23:07:42 +00:00
Visit the [theme documentation ](https://matcornic.github.io/hugo-learn-doc/basics/what-is-this-hugo-theme/ ) to see what is going on. It is actually built with this theme.
2016-04-10 22:09:03 +00:00
2016-12-30 21:40:05 +00:00
## Installation
2016-04-12 10:34:40 +00:00
Navigate to your themes folder in your Hugo site and use the following commands:
```
$ cd themes
$ git clone https://github.com/matcornic/hugo-theme-learn.git
```
2016-10-23 17:01:52 +00:00
![Overview ](https://github.com/matcornic/hugo-theme-learn/raw/master/images/tn.png )
2016-04-12 00:48:31 +00:00
2016-12-30 21:40:05 +00:00
## Usage
- [Visit the documentation ](https://matcornic.github.io/hugo-learn-doc/basics/what-is-this-hugo-theme/ )
2016-04-10 22:09:03 +00:00
# Main functionalities
- Handle two levels of documentation
- Tip/Note/Info and Warning boxes
- Resize images
- Preview of original image size
- Add shadow or border on images
- Automatic table of contents
- Create buttons (typically used to provide a link to a demo)
2016-10-25 18:20:21 +00:00
- Search using `lunr` index
2016-10-24 22:45:15 +00:00
2016-04-10 22:09:03 +00:00
# TODO
2016-10-02 16:36:15 +00:00
- [Handling more than 2 levels in documentation ](https://github.com/matcornic/hugo-theme-learn/issues/11 )
- [Handling videos ](https://github.com/matcornic/hugo-theme-learn/issues/13 )
- [Add optional button to create doc issue (like github) ](https://github.com/matcornic/hugo-theme-learn/issues/14 )