Hugo Relearn Theme

A theme for Hugo designed for documentation.

Motivation

The theme is a fork of the great Learn theme with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.

Main features

Usable offline, no external dependencies
Usable without a HTTP server from the file system
Support for Internet Explorer 11
Responsive design
Configurable hidden pages
Automatic next/prev buttons to navigate through menu entries
Automatic Search
Dedicated search page
Support for GFM (GitHub Flavored Markdown)
Print whole chapters or even the complete site
Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinese, Dutch, Finnish (Suomi), French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
Support for languages written right to left
Unrestricted menu configuration relating to amount of items and level of nesting
Font Awesome icons
Tagging support
Image resizing, shadow…
Syntax highlighting
Attachments files
List child pages
Math and chemical formulae using the MathJax library
Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.
Swagger UI for OpenAPI Specifications
Customizable look and feel
Predefined (light, dark) and customizable color variants
Badges
Buttons
Tip/Note/Info/Warning boxes
Expand
Tabs
File inclusion

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.

Contribution

You are most welcome to contribute to the source code but please visit the contribution guidelines first.

License

This theme is licensed under the MIT License.

Credits

Special thanks to everyone who has contributed to this project.

Many thanks to Mathieu Cornic for his work on porting the Learn theme to Hugo.

Many thanks to Andy Miller for initially creating the Learn theme for Grav.

2.9 KiB Raw Blame History