hugo-theme-relearn/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 adepting 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 you have to)
  • Usable offline, no external dependencies
  • Usable from your local file system via file:// protocol
  • Support for Internet Explorer 11
• 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
  • Tagging support
  • Hidden pages
  • Unlimited nested menu dependend on your site structure
  • Navigation buttons dependend on your site structure
  • Configurable shortcut links
• Multi language support
  • Full support for languages written right to left
  • Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
  • Search support for mixed language content
• Additional Markdown features
  • Support for GFM (GitHub Flavored Markdown
  • Image styling like sizing, shadow, border and alignment
  • Image lightbox
• Shortcodes galore
  • Display files attached to page bundles
  • 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
  • Reveal you site's configuration parameter
  • Swagger UI for your OpenAPI Specifications
  • 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 even new features to the source code. Check the contribution guidelines first before making any changes.

License

The Relearn theme is licensed under the MIT License.

Credits

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