A theme for Hugo designed for documentation
Find a file
Sören Weber 8e4b7cddc5
scrollbar: update in next frame
the high timeout caused glitches so we assume the width has been settled in the next animation frame + plus some surplus #470
2023-02-10 17:02:33 +01:00
.github build: add 'x tag for latest release and add docs #453 2023-02-05 13:01:49 +01:00
archetypes fix frontmatter on home.md 2022-10-09 12:19:12 +02:00
assets/css variant: include missing theme-auto.css in distribution #467 2023-02-06 06:40:39 +01:00
exampleSite i18n: full support for RTL #470 2023-02-10 00:34:47 +01:00
i18n documentation: use Pirates language to showcase RTL reading direction #469 2023-02-08 22:00:29 +01:00
images docs: optimize new screenshots 2023-01-25 00:26:55 +01:00
layouts i18n: full support for RTL #470 2023-02-10 00:34:47 +01:00
static scrollbar: update in next frame 2023-02-10 17:02:33 +01:00
.editorconfig theme: wildspace config 2022-03-13 14:15:26 +01:00
.gitignore docs: scrrreenshots 2023-01-28 11:55:55 +01:00
.grenrc.js build: remove moveable tags from changelog #453 2023-02-05 13:26:29 +01:00
.issuetracker repo: add issuetracker configuration 2022-03-03 23:49:28 +01:00
config.toml search: add dedicated search page #386 2022-11-17 22:12:18 +01:00
go.mod theme: make it a Hugo module #417 2022-12-14 22:17:43 +01:00
LICENSE theme: reorder license #40 2021-08-22 13:30:05 +02:00
README.md i18n: full support for RTL #470 2023-02-10 00:34:47 +01:00
theme.toml docs: announce auto variant #445 2023-02-05 00:21:38 +01:00

Hugo Relearn Theme

A theme for Hugo designed for documentation.

Overview

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.

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, Czech, Dutch, Finnish, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
  • Full 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 styling like sizing, shadow, border and alignment
  • Syntax highlighting
  • Customizable look and feel
  • Predefined (light, dark) and customizable color variants
  • Automatic switch for light/dark mode dependend on your OS settings
  • 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
  • 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 What's New page for release highlights or the history for a complete list of changes per release.

Contribution

You are most welcome to contribute bugfixes or even new features to the source code. 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.

See the credits for a detailed list.