mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-10-27 02:33:18 +00:00

A theme for Hugo designed for documentation

Find a file

Sören Weber 64b4ad751e theme: sync Hugo templates and unification #841 #845 - description - title - tags		2024-04-27 14:38:19 +02:00
.githooks	build: unify git hook output	2024-01-18 21:07:09 +01:00
.github	build: update action to v3	2024-04-12 17:23:31 +02:00
archetypes	docs: make installation tutorial work without making changes #801	2024-03-15 20:59:59 +01:00
assets/css	variant: darker purple for neon	2024-04-23 22:07:53 +02:00
exampleSite	swagger: remove shortcode #847	2024-04-27 00:40:16 +02:00
i18n	theme: fixing typos #581	2024-04-12 17:30:31 +02:00
images	[ImgBot] Optimize images	2023-11-24 17:22:57 +01:00
layouts	theme: sync Hugo templates and unification #841 #845	2024-04-27 14:38:19 +02:00
static	search: remove JSON outputformat for search index #846	2024-04-27 00:21:02 +02:00
vscode-frontmatter	resources: deprecate attachments shortcode in frontmatter CMS config #22	2024-03-24 00:42:55 +01:00
.editorconfig	theme: wildspace config	2022-03-13 14:15:26 +01:00
.gitignore	build: pre-push refinement	2024-01-05 16:15:09 +01:00
.grenrc.js	include: use Hugo's resources #835	2024-04-19 17:58:38 +02: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
CHANGELOG.md	include: use Hugo's resources #835	2024-04-19 17:58:38 +02:00
go.mod	theme: make it a Hugo module #417	2022-12-14 22:17:43 +01:00
hugo.toml	theme: raise minimum Hugo version to 0.121.0 #825	2024-04-07 21:54:27 +02:00
LICENSE	theme: reorder license #40	2021-08-22 13:30:05 +02:00
README.md	schema: add schema support in meta data #844	2024-04-24 21:20:11 +02:00
theme.toml	schema: add schema support in meta data #844	2024-04-24 21:20:11 +02: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 Open Graph, Schema and Twitter Cards
Configurable theming and visuals
- Configurable brand images
- Automatic switch for light/dark variant depending 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, Romanian, 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.