hugo-theme-relearn/README.md

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
  • Pre-defined color schemes and variants
  • User-selectable theme 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 top bar buttons
  • Unlimited nested menu structure
  • Configurable menu shortcuts
  • Support for hidden pages
  • Comprehensive taxonomy support
  • Social media integration

• Multilingual Support

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

• Enhanced Markdown Features

  • GitHub Flavored Markdown (GFM) support
  • Support for Obsidian callouts
  • Advanced image manipulation like lightbox, sizing, shadows, borders, and alignment

• Rich Shortcode Library

  • Customizable marker badges
  • Flexible button creation
  • Child page listing
  • Expandable content areas
  • Font Awesome icon integration
  • File inclusion capabilities
  • MathJax support for mathematical and chemical formulae
  • Mermaid diagram integration
  • Styled notice boxes
  • OpenAPI specification rendering with Swagger UI
  • Page bundle resource display
  • Site configuration parameter display
  • Tab-based content organization and multi-tab panels

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.

Licensing

The Relearn theme is distributed under the MIT License.

Credits

This theme builds upon the work of many contributors.