nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 07:47:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
A theme for Hugo designed for documentation
1384 commits 3 branches 214 tags 490 MiB
JavaScript 97.7%
CSS 1.4%
HTML 0.9%
Find a file
GitHub Actions Bot 03f638e33a Mark non-release version
2022-11-18 23:29:48 +00:00
.github build: getting action version numbers right IV #348 2022-11-05 13:42:50 +01:00
archetypes fix frontmatter on home.md 2022-10-09 12:19:12 +02:00
exampleSite Ship tag 5.6.0 2022-11-18 23:29:43 +00:00
i18n search: add dedicated search page #386 2022-11-17 22:12:18 +01:00
images docs: new screenshots 2022-02-22 01:05:18 +01:00
layouts Mark non-release version 2022-11-18 23:29:48 +00:00
static mermaid: avoid leading whitespace #394 2022-11-19 00:00:31 +01:00
.editorconfig theme: wildspace config 2022-03-13 14:15:26 +01:00
.gitignore test: ignore test reference folders #380 2022-11-12 21:04:59 +01:00
.grenrc.js task: remove irrelevant labels from changelog 2022-09-13 23:20:13 +02:00
.issuetracker repo: add issuetracker configuration 2022-03-03 23:49:28 +01:00
config.toml search: add dedicated search page #386 2022-11-17 22:12:18 +01:00
LICENSE theme: reorder license #40 2021-08-22 13:30:05 +02:00
README.md docs: announce new features #386 2022-11-17 23:52:54 +01:00
theme.toml docs: announce new features #386 2022-11-17 23:52:54 +01: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
  • Usable without a HTTP server from the file system
  • Support for Internet Explorer 11
  • Responsive design
  • Configurable hidden pages
  • Automatic next/prev buttons to navigate through menu entries
  • Automatic Search
  • Dedicated search page
  • Print whole chapters or even the complete site
  • Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinese, Dutch, Finnish (Suomi), French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
  • Support for languages written right to left
  • Unrestricted menu configuration relating to amount of items and level of nesting
  • Font Awesome icons
  • Tagging support
  • Image resizing, shadow…
  • Syntax highlighting
  • Attachments files
  • List child pages
  • Math and chemical formulae using the MathJax library
  • Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.
  • 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.