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.

Main features

Automatic Search
Multilingual mode
Unlimited menu levels
Automatic next/prev buttons to navigate through menu entries
Image resizing, shadow…
Attachments files
List child pages
Mermaid diagram (flowchart, sequence, gantt)
Customizable look and feel and themes variants
Buttons, Tip/Note/Info/Warning boxes, Expand

Installation

Navigate to your themes folder in your Hugo site and use the following commands:

shell

cd themes/
git clone https://github.com/matcornic/hugo-theme-learn.git

Check that your Hugo version is minimum 0.25 with hugo version.

Usage

Visit the documentation

Download old versions (prior to 2.0.0)

If you need old version for compatibility purpose, either download theme source code from releases or use the right git tag. For example, with 1.1.0

Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip
Git way:

shell

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

For both solutions, the documentation is available at https://github.com/matcornic/hugo-theme-learn/releases/download/1.1.0/hugo-learn-doc-1.1.0.zip

Credits

Many thanks to @vjeantet for the fork docdock. The v2 of this theme is mainly based on his work !

License

Releasing

Somewhat work-in-progress steps to release with gren

Check all MRs assigned to the milestone are closed or pushed back to another release
Close the milestone
Check merged MRs on the milestone have a tag (Bug, Enhancement, etc.)
Tag and push the repo
shell
```
git tag <tag>
git push origin <tag>
```

Generate CHANGELOG.md with gren

shell

gren changelog  --override --generate --tags=all

Fix the date for the current release in CHANGELOG.md

Add the changelog to git and update the tag

shell

git add CHANGELOG.md
git commit -m "Ship tag <tag>"
git push origin master
git tag -f <tag>
git push --force origin <tag>

Generate release with gren
shell
```
gren release -t <tag>
```