hugo-theme-relearn/README.md

# Hugo Learn Theme

This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Grav Learn Theme](http://learn.getgrav.org/).

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.

## 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
```

Check that your Hugo version is minimum `0.19` with `hugo version`.

![Overview](https://github.com/matcornic/hugo-theme-learn/raw/master/images/tn.png)

## Usage

- [Visit the documentation](https://matcornic.github.io/hugo-learn-doc/basics/what-is-this-hugo-theme/)

# 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)
- Search using `lunr` index

# TODO

- [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)

# Troubleshooting

Changes have been made for automatically creating previous and next arrows. These changes restructured the theme and you might have compatibility problems when updating to the latest version of the theme. Please read [PR#36](https://github.com/matcornic/hugo-theme-learn/pull/36) to update your documentation with latest guidelines.

If you don't want to update your documentation, use the git tag `1.0.0` 

```shell
cd themes/hugo-theme-learn
git checkout tags/1.0.0
```
readme 2016-04-10 22:25:22 +00:00			`# Hugo Learn Theme`
feat: added minimal Readme 2016-03-17 11:05:36 +00:00
feat: partials for style and scripts are now empty 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/).`
feat: warning : this is a draft project for the moment 2016-03-17 11:07:26 +00:00
fix links 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.`
feat: partials for style and scripts are now empty 2016-04-10 22:09:03 +00:00
Update README.md 2016-12-30 21:40:05 +00:00			`## Installation`
doc: Add theme installation instructions 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`
			```

add minium version 2017-04-08 08:30:09 +00:00			Check that your Hugo version is minimum `0.19` with `hugo version`.

closes #19 2016-10-23 17:01:52 +00:00			`![Overview](https://github.com/matcornic/hugo-theme-learn/raw/master/images/tn.png)`
add image overview on readme 2016-04-12 00:48:31 +00:00
Update README.md 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/)`

feat: partials for style and scripts are now empty 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)`
chore: migrate search documentation to https://github.com/matcornic/hugo-learn-doc project 2016-10-25 18:20:21 +00:00			- Search using `lunr` index
feat: extract search out of header + use baseurl to search json index + add a step to explain how to use lunr-hugo + update perfect-scrollbar 2016-10-24 22:45:15 +00:00
feat: partials for style and scripts are now empty 2016-04-10 22:09:03 +00:00			`# TODO`

Add links to main issues 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)`
Add troubleshooting instructions 2017-04-08 08:27:00 +00:00
			`# Troubleshooting`

			`Changes have been made for automatically creating previous and next arrows. These changes restructured the theme and you might have compatibility problems when updating to the latest version of the theme. Please read [PR#36](https://github.com/matcornic/hugo-theme-learn/pull/36) to update your documentation with latest guidelines.`

			If you don't want to update your documentation, use the git tag `1.0.0`

			```shell
			`cd themes/hugo-theme-learn`
			`git checkout tags/1.0.0`
			```