mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 07:47:54 +00:00

A theme for Hugo designed for documentation

Find a file

Sören Weber 7dd41c5142 docs: fix links #721		2023-11-29 21:37:06 +01:00
.frontmatter/database	[frontmatter] upstream changes	2023-05-04 14:15:38 +02:00
.github	build: reduce build time #685	2023-10-19 21:25:35 +02:00
archetypes	fix frontmatter on home.md	2022-10-09 12:19:12 +02:00
assets/css	variant: make chroma style dynamically switchable #679	2023-11-25 14:23:58 +01:00
exampleSite	docs: fix links #721	2023-11-29 21:37:06 +01:00
i18n	i18n: support for languageDirection #733	2023-11-28 21:39:50 +01:00
images	[ImgBot] Optimize images	2023-11-24 17:22:57 +01:00
layouts	button: fix whitespace on minify #737	2023-11-29 10:33:48 +01:00
static	clipboard: fix O(n²) buttons #738	2023-11-29 17:11:04 +01:00
vscode-frontmatter	frontmatter: resemble documented shortcode style #672	2023-10-03 21:08:17 +02:00
.editorconfig	theme: wildspace config	2022-03-13 14:15:26 +01:00
.gitignore	theme: revamp 404 page #566	2023-06-10 13:56:58 +02:00
.grenrc.js	build: add new label "support"	2023-11-12 13:44:18 +01:00
.imgbotconfig	build: add imagebot #485	2023-02-21 19:44:22 +01:00
.issuetracker	repo: add issuetracker configuration	2022-03-03 23:49:28 +01:00
config.toml	theme: require new hugo version for leveraging findRESubmatch #679	2023-11-26 21:02:51 +01:00
frontmatter.json	frontmatter: support VSCode Front Matter extension #481	2023-02-20 00:20:37 +01:00
go.mod	theme: make it a Hugo module #417	2022-12-14 22:17:43 +01:00
hugo-theme-relearn.code-workspace	frontmatter: support VSCode Front Matter extension #481	2023-02-20 00:20:37 +01:00
LICENSE	theme: reorder license #40	2021-08-22 13:30:05 +02:00
README.md	docs: fix links #721	2023-11-29 20:46:56 +01:00
theme.toml	i18n: raise required min hugo version #733	2023-11-28 22:12:59 +01:00

README.md

Hugo Relearn Theme

A theme for Hugo designed for documentation.

★ What's new in the latest release ★

Motivation

The Relearn theme is a fork of the great Learn theme with the aim of fixing long outstanding bugs and adapting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.

Features

Wide set of usage scenarios
- Responsive design for mobile usage
- Looks nice on paper (if it has to)
- Usable offline, no external dependencies
- Usable from your local file system via file:// protocol
- Support for the VSCode Front Matter extension for on-premise CMS capabilities
- Support for Internet Explorer 11
- Support for Open Graph and Twitter Cards
Configurable theming and visuals
- Configurable brand images
- Automatic switch for light/dark variant dependend on your OS settings
- Predefined light, dark and color variants
- User selectable variants
- Stylesheet generator
- Configurable syntax highlighting
Unique theme features
- Print whole chapters or even the complete site
- In page search
- Site search
- Dedicated search page
- Taxonomy support
- Configurable topbar buttons
- Unlimited nested menu items
- Configurable shortcut links
- Hidden pages
Multi language support
- Full support for languages written right to left
- Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese
- Search support for mixed language content
Additional Markdown features
Shortcodes galore

Installation & Usage

For a detailed description of the theme's capabilities visit the official documentation.

Changelog

See the What's New page for release highlights or the detailed change history for a complete list of changes.

Contributions

You are most welcome to contribute bugfixes or new features. Check the contribution guidelines first before starting.

License

The Relearn theme is licensed under the MIT License.

Credits

This theme would not be possible without the work of many others.