A theme for Hugo designed for documentation
Find a file
Sören Weber 2a5deb0534
docs: move CHANGELOG into exampleSite
that makes it possible to include it into the official documentation
2021-08-23 22:13:16 +02:00
archetypes TranslationBaseName replaced for Name on archetypes template 2018-05-27 13:29:39 -04:00
exampleSite docs: move CHANGELOG into exampleSite 2021-08-23 22:13:16 +02:00
i18n attachments: support i18n for attachment size 2021-07-17 12:37:24 +02:00
images Prepare for hugo showcase 2021-07-01 21:02:54 +02:00
layouts code highligher: switch to standard hugo highlighter 2021-07-26 11:50:34 +02:00
static Merge branch 'McShelby/issue413' into 2.0.0 2021-07-26 12:05:42 +02:00
.editorconfig Add .editorconfig 2019-03-15 16:10:45 +00:00
.gitignore Ignore hugo executable for improved test workflow 2021-06-30 14:56:28 +02:00
.grenrc.js docs: move CHANGELOG into exampleSite 2021-08-23 22:13:16 +02:00
LICENSE theme: reorder license 2021-08-22 13:30:05 +02:00
netlify.toml Rebranding to new theme name 2021-06-30 14:56:06 +02:00
README.md docs: rework README.md 2021-08-23 18:54:02 +02:00
RELEASE.md docs: move CHANGELOG into exampleSite 2021-08-23 22:13:16 +02:00
theme.toml theme: prepare for new hugo theme registration 2021-07-04 20:59:17 +02:00
wercker.yml Fix/wercker () 2018-10-10 19:14:04 +02:00

Hugo Relearn Theme

A documentation theme for Hugo.

Overview

Motivation

The theme initially was a fork of hugo-theme-learn with the aim of fixing long outstanding bugs and adepting to latest Hugo features.

As far as possible the theme tries to be a drop-in replacement for hugo-theme-learn. The documentation provides instructions on how to achieve the best compatiblity while still benefitting from bug fixes and new features.

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

Installation

Visit the installation instructions to learn how to setup the theme in your Hugo installation.

Usage

Visit the documentation to learn about all available features and how to use them.

Changelog

See the changelog for a complete list of releases.

License

This project is licensed under the MIT License.

Credits

Special thanks to everyone who has contributed to this project.

Many thanks to @matcornic for his work on hugo-theme-learn.