nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 01:33:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A theme for Hugo designed for documentation
1008 commits 3 branches 214 tags 493 MiB
JavaScript 97.7%
CSS 1.4%
HTML 0.9%
Find a file
GitHub Actions Bot 26ab080d81 Mark non-release version
2022-04-03 19:40:15 +00:00
.github build: rename version in semver 2022-02-13 02:37:44 +01:00
archetypes theme: convert front matter to TOML #52 2021-08-25 13:33:29 +02:00
exampleSite Ship tag 3.4.1 2022-04-03 19:40:11 +00:00
i18n i18n: add missing translations 2022-04-03 13:02:49 +02:00
images docs: new screenshots 2022-02-22 01:05:18 +01:00
layouts Mark non-release version 2022-04-03 19:40:15 +00:00
static theme: remove some unused styles 2022-04-03 18:34:25 +02:00
.editorconfig theme: wildspace config 2022-03-13 14:15:26 +01:00
.gitignore ignore new hugo 0.89 lock files 2021-11-08 20:14:56 +01:00
.grenrc.js changelog: fix handling of issues containing multiple labels 2021-11-17 16:51:15 +01:00
.issuetracker repo: add issuetracker configuration 2022-03-03 23:49:28 +01:00
config.toml print: add option to print whole chapter #230 2022-04-02 15:29:34 +02:00
LICENSE theme: reorder license #40 2021-08-22 13:30:05 +02:00
README.md docs: order languages lexically 2022-04-03 13:21:19 +02:00
theme.toml swagger: add support for oas/swagger documentation #226 2022-03-27 18:42:11 +02:00

README.md

Hugo Relearn Theme

A theme for Hugo designed for documentation.

Overview

Motivation

The 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.

Main features

  • Usable offline, no external dependencies
  • Automatic Search
  • Print whole chapters or even the complete site
  • Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Portuguese, Russian, Spanish, Turkish, Vietnamese
  • 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)
  • Swagger UI for OpenAPI Specifications
  • Customizable look and feel
  • Predefined (light, dark) and customizable color variants
  • Buttons
  • Tip/Note/Info/Warning boxes
  • Expand
  • Tabs
  • File inclusion

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.

Contribution

You are most welcome to contribute to the source code but please visit the contribution guidelines first.

License

This theme is licensed under the MIT License.

Credits

Special thanks to everyone who has contributed to this project.

Many thanks to Mathieu Cornic for his work on porting the Learn theme to Hugo.

Many thanks to Andy Miller for initially creating the Learn theme for Grav.