README.md

Hugo Relearn Theme

A theme for Hugo designed for documentation.

★ What's new in the latest release ★

Motivation

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

Features

• Wide set of usage scenarios
  • Responsive design for mobile usage
  • Looks nice on paper (if it has to)
  • Usable offline, no external dependencies
  • Usable from your local file system via file:// protocol
  • Support for the VSCode Front Matter extension for on-premise CMS capabilities
  • Support for Internet Explorer 11
  • Support for Open Graph and Twitter Cards
• Configurable theming and visuals
  • Configurable brand images
  • Automatic switch for light/dark variant dependend on your OS settings
  • Predefined light, dark and color variants
  • User selectable variants
  • Stylesheet generator
  • Configurable syntax highlighting
• Unique theme features
  • Print whole chapters or even the complete site
  • In page search
  • Site search
  • Dedicated search page
  • Taxonomy support
  • Configurable topbar buttons
  • Unlimited nested menu items
  • Configurable shortcut links
  • Hidden pages
• Multi language support
  • Full support for languages written right to left
  • Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese
  • Search support for mixed language content
• Additional Markdown features
  • Support for GFM (GitHub Flavored Markdown)
  • Image effects like sizing, shadow, border and alignment
  • Image lightbox
• Shortcodes galore
  • Display resources contained in a page bundle
  • Marker badges
  • Configurable buttons
  • List child pages
  • Expand areas to reveal content
  • Font Awesome icons
  • Inclusion of other files
  • Math and chemical formulae using MathJax
  • Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.
  • Colorful boxes
  • OpenAPI specifications using Swagger UI
  • Reveal you site's configuration parameter
  • Single tabbed panels and multiple tabbed panels

Installation & Usage

For a detailed description of the theme's capabilities visit the official documentation.

Changelog

See the What's New page for release highlights or the detailed change history for a complete list of changes.

Contributions

You are most welcome to contribute bugfixes or new features. Check the contribution guidelines first before starting.

License

The Relearn theme is licensed under the MIT License.

Credits

This theme would not be possible without the work of many others.