hugo-theme-relearn/README.md
Sören Weber 2ae4a58a2f
docs: rework README.md #34
to avoid duplication of information
2021-08-23 18:54:02 +02:00

1.8 KiB

Hugo Relearn Theme

A documentation theme for Hugo.

Overview

Motivation

The theme initially was a fork of hugo-theme-learn with the aim of fixing long outstanding bugs and adepting to latest Hugo features.

As far as possible the theme tries to be a drop-in replacement for hugo-theme-learn. The documentation provides instructions on how to achieve the best compatiblity while still benefitting from bug fixes and new features.

Main features

  • Automatic Search
  • Multilingual mode
  • Unlimited menu levels
  • Automatic next/prev buttons to navigate through menu entries
  • Image resizing, shadow…
  • Attachments files
  • List child pages
  • Mermaid diagram (flowchart, sequence, gantt)
  • Customizable look and feel and themes variants
  • Buttons, Tip/Note/Info/Warning boxes, Expand, Tabs

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 changelog for a complete list of releases.

License

This project is licensed under the MIT License.

Credits

Special thanks to everyone who has contributed to this project.

Many thanks to @matcornic for his work on hugo-theme-learn.