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
504 commits 3 branches 214 tags 490 MiB
JavaScript 97.7%
CSS 1.4%
HTML 0.9%
Find a file
Sören Weber c81bf82ced
menu: allow empty ul 
This simplyfies code, as of now it is only necessary to tag the ul with
classes and let the CSS do all the heavy lifting.

Care was taken, to not mess up layout when a ul ends up with all
its li hidden.
2021-08-26 22:19:52 +02:00
archetypes theme: convert front matter to TOML #52 2021-08-25 13:33:29 +02:00
exampleSite add more tests for hidden pages #60 2021-08-26 22:16:43 +02:00
i18n attachments: support i18n for attachment size #21 2021-07-17 12:37:24 +02:00
images Prepare for hugo showcase #3 2021-07-01 21:02:54 +02:00
layouts menu: allow empty ul 2021-08-26 22:19:52 +02:00
static menu: allow empty ul 2021-08-26 22:19:52 +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 docs: move CHANGELOG into exampleSite #33 2021-08-23 22:13:16 +02:00
LICENSE theme: reorder license #40 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: show CHANGELOG in exampleSite #33 2021-08-23 22:20:29 +02:00
RELEASE.md docs: move CHANGELOG into exampleSite #33 2021-08-23 22:13:16 +02:00
theme.toml theme: prepare for new hugo theme registration #13 2021-07-04 20:59:17 +02:00
wercker.yml Fix/wercker (#178) 2018-10-10 19:14:04 +02:00

README.md

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.