nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-10-27 02:33:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
A theme for Hugo designed for documentation
699 commits 3 branches 214 tags 473 MiB
JavaScript 97.7%
CSS 1.4%
HTML 0.9%
Find a file
GitHub Actions Bot 8a90e237f3 Ship tag 2.8.0
2021-11-03 21:03:39 +00:00
.github task: split jobs into reusable actions 2021-10-23 11:56:11 +02:00
archetypes theme: convert front matter to TOML #52 2021-08-25 13:33:29 +02:00
exampleSite Ship tag 2.8.0 2021-11-03 21:03:39 +00:00
i18n theme: arrr pirrrate, more translat'n 2021-11-03 19:55:54 +01:00
images docs: updated screenshots 2021-10-24 13:01:01 +02:00
layouts mermaid: assert that window.mermaid is actually mermaid #136 2021-11-03 21:42:38 +01:00
static mermaid: assert that window.mermaid is actually mermaid #136 2021-11-03 21:42:38 +01:00
.editorconfig Add .editorconfig 2019-03-15 16:10:45 +00:00
.gitignore avoid older hugo versions to show up in git log 2021-09-05 23:41:44 +02:00
.grenrc.js docs: edit changelog after release 2021-09-13 21:20:06 +02:00
LICENSE theme: reorder license #40 2021-08-22 13:30:05 +02:00
README.md docs: updated screenshots 2021-10-24 13:01:01 +02:00
theme.toml task: swtich from netlify to gh-pages 2021-10-17 23:37:32 +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

  • 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 theme 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 @matcornic for his work on the Learn theme.