mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 02:33:18 +00:00
35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# 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
|
|
```
|
|
|
|
|
|
|
|
## 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)
|