2016-04-11 00:25:22 +02:00
# Hugo Learn Theme
2016-03-17 12:05:36 +01:00
2016-04-11 00:09:03 +02:00
This repository contains a theme for [Hugo ](https://gohugo.io/ ), based on great [Grav Learn Theme ](http://learn.getgrav.org/ ).
2016-03-17 12:07:26 +01:00
2016-04-11 01:07:42 +02: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-11 00:09:03 +02:00
2016-04-12 06:34:40 -04:00
### Installation
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 19:01:52 +02:00
2016-04-12 02:48:31 +02:00
2016-04-11 00:09:03 +02: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)
# TODO
2016-10-02 18:36:15 +02:00
- [Handling more than 2 levels in documentation ](https://github.com/matcornic/hugo-theme-learn/issues/11 )
- [Search in site ](https://github.com/matcornic/hugo-theme-learn/issues/12 )
- [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 )
