Hugo Relearn Theme

A theme for Hugo.

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, Tabs
• and many more...

Visit the documentation for a demo.

Installation

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

cd themes/
git clone https://github.com/McShelby/hugo-theme-relearn.git

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

Usage

• Visit the documentation

License

MIT licensed.

Credits

Many thanks to @matcornic for his work on learn and @vjeantet for his work on docdock, which hugo-theme-relearn is based on.

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

  git tag <tag>
  git push origin <tag>
  

• Generate CHANGELOG.md with gren

  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

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

• Generate release with gren

  gren release -t <tag>