nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-03-20 16:15:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A theme for Hugo designed for documentation
524 commits 2 branches 226 tags 761 MiB
JavaScript 97.7%
CSS 1.4%
HTML 0.9%
Find a file
Sören Weber 8a7dce6ce5
docs: elaborate on fork decision
2021-08-28 10:39:54 +02:00
archetypes theme: convert front matter to TOML 2021-08-25 13:33:29 +02:00
exampleSite docs: elaborate on fork decision 2021-08-28 10:39:54 +02:00
i18n attachments: support i18n for attachment size 2021-07-17 12:37:24 +02:00
images docs: elaborate on fork decision 2021-08-28 10:39:54 +02:00
layouts include: add paramter to hide first heading 2021-08-28 10:08:10 +02:00
static include: add paramter to hide first heading 2021-08-28 10:08:10 +02:00
.editorconfig Add .editorconfig 2019-03-15 16:10:45 +00:00
.gitignore Ignore hugo executable for improved test workflow 2021-06-30 14:56:28 +02:00
.grenrc.js include: add paramter to hide first heading 2021-08-28 10:08:10 +02:00
LICENSE theme: reorder license 2021-08-22 13:30:05 +02:00
netlify.toml Upgrade Hugo to 0.87.0 2021-08-24 00:48:48 +01:00
README.md docs: elaborate on fork decision 2021-08-28 10:39:54 +02:00
RELEASE.md docs: move CHANGELOG into exampleSite 2021-08-23 22:13:16 +02:00
theme.toml theme: prepare for new hugo theme registration 2021-07-04 20:59:17 +02:00
wercker.yml Fix/wercker () 2018-10-10 19:14:04 +02:00

README.md

Hugo Relearn Theme

A theme for Hugo designed for documentation.

Overview

Motivation

The theme initially was a fork of the greathugo-theme-learn 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 hugo-theme-learn.

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.

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.