Hugo Relearn Theme

A theme for Hugo designed for documentation.

★ What's new in the latest version ★

Overview

The Relearn theme is an enhanced fork of the popular Learn theme. It aims to address long-standing issues and incorporate the latest Hugo features while trying to maintain compatibility with its predecessor.

Key Features

• Versatile Usage

  • Responsive design for mobile devices
  • Looks nice on paper - if it has to
  • Usable offline with no external dependencies
  • Usable from your local file system without a web server via file:// protocol
  • Integration with the VSCode Front Matter CMS extension for on-premise CMS capabilities

• Customizable Appearance

  • Flexible brand image configuration
  • Automatic light/dark mode switching based on OS settings
  • Many pre-defined color variants
  • User-selectable variants
  • Built-in stylesheet generator
  • Customizable syntax highlighting

• Advanced Functionality

  • Chapter and site-wide printing capabilities
  • Versatile search options: in-page, popup, and dedicated search page
  • Customizable topbar buttons
  • Configurable sidebar menus
  • Support for hidden pages
  • Comprehensive taxonomy support
  • Versioning support
  • Social media integration

• Multilingual Support

  • Full right-to-left (RTL) language support
  • Extensive list of supported languages: Arabic, Chinese (Simplified and Traditional), Czech, Danish, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Persian, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Ukrainian, Vietnamese
  • Multilingual content search capabilities

• Enhanced Markdown Features

  • CommonMark compliant
  • Support for Markdown extensions like GitHub Flavored Markdown
  • Support for Obsidian callouts
  • Advanced link manipulation like download and target
  • Advanced image manipulation like lightbox, sizing, shadows, borders and alignment

• Rich Shortcode Library

  • Marker badges
  • Flexible buttons
  • Card-based content organization and card sets
  • Child page listing
  • Expandable content areas
  • Font Awesome icon integration
  • File inclusion capabilities
  • Math support for mathematical and chemical formulae
  • Mermaid diagram integration
  • Styled notice boxes
  • OpenAPI specification rendering
  • Page bundle resource display
  • Site configuration parameter display
  • Tab-based content organization and multi-tab panels
  • Nicely formatted tree lists

Getting Started

For a comprehensive guide on the theme's capabilities, please refer to the official documentation.

Updates and Changes

Visit the What's New page for feature highlights or the detailed changelog for a complete list of updates.

Contributing

We welcome contributions for bug fixes and new features. Please see the contribution guidelines before getting started.

If you want to go further - running the test suite or regenerating the documentation screenshots - the Development section explains the setup.

Licensing

The Relearn theme is distributed under the MIT License.

Credits

This theme is built on the shoulders of giants.