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
1507 commits 3 branches 214 tags 493 MiB
JavaScript 97.7%
CSS 1.4%
HTML 0.9%
Find a file
GitHub Actions Bot 26988d262b Mark non-release version
2023-01-25 20:37:55 +00:00
.github build: switch to wildcard version of actions #428 2023-01-04 01:19:49 +01:00
archetypes fix frontmatter on home.md 2022-10-09 12:19:12 +02:00
exampleSite Ship tag 5.10.1 2023-01-25 20:37:49 +00:00
i18n i18n: rename Korean translation from country to lang code #404 2022-11-27 13:10:49 +01:00
images docs: optimize new screenshots 2023-01-25 00:26:55 +01:00
layouts Mark non-release version 2023-01-25 20:37:55 +00:00
static theme: improve whitespacing in tables #441 2023-01-25 10:01:36 +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
go.mod theme: make it a Hugo module #417 2022-12-14 22:17:43 +01:00
LICENSE theme: reorder license #40 2021-08-22 13:30:05 +02:00
README.md docs: make nicer screenshots 2023-01-24 23:58:16 +01:00
theme.toml icon: add new shortcode #412 2022-12-02 18:31: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.

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
  • Support for GFM (GitHub Flavored Markdown)
  • 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 styling like sizing, shadow, border and alignment
  • Syntax highlighting
  • Customizable look and feel
  • Predefined (light, dark) and customizable color variants
  • 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
  • Badges
  • 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 What's New page for release highlights or the history for a complete list of changes per release.

Contribution

You are most welcome to contribute bugfixes or even new features to the source code. 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.

See the credits for a detailed list.