yife/hugo-theme-learn

Porting Grav Learn theme to Hugo

Hugo Learn Theme

This repository contains a theme for Hugo, based on great Grav Learn Theme.

Visit the theme documentation 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.

Usage

• Visit the documentation

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
• Automatic next/prev buttons to navigate through pages

TODO

• Handling more than 2 levels in documentation
• Handling videos
• Add optional button to create doc issue (like github)

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 to update your documentation with latest guidelines.

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

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