mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 01:33:04 +00:00
83 lines
6 KiB
Markdown
83 lines
6 KiB
Markdown
# Hugo Relearn Theme
|
|
|
|
A theme for [Hugo](https://gohugo.io/) designed for documentation.
|
|
|
|
[★ What's new in the latest version ★](https://mcshelby.github.io/hugo-theme-relearn/basics/releasenotes)
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
The Relearn theme is an enhanced fork of the popular [Learn theme](https://github.com/matcornic/hugo-theme-learn). It aims to address long-standing issues and incorporate the latest Hugo features while trying to maintain compatibility with its predecessor.
|
|
|
|
## Key Features
|
|
|
|
- **Versatile Usage**
|
|
- Responsive design for mobile devices
|
|
- Looks nice on paper (if it has to)
|
|
- Usable offline with no external dependencies
|
|
- [Usable from your local file system without a web server via `file://` protocol](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization#file-system)
|
|
- Integration with the [VSCode Front Matter extension](https://github.com/estruyf/vscode-front-matter) for on-premise CMS capabilities
|
|
|
|
- **Customizable Appearance**
|
|
- [Flexible brand image configuration](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding#change-the-logo)
|
|
- [Automatic light/dark mode switching based on OS settings](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding#adjust-to-os-settings)
|
|
- Pre-defined color schemes and variants
|
|
- [User-selectable theme variants](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding#multiple-variants)
|
|
- [Built-in stylesheet generator](https://mcshelby.github.io/hugo-theme-relearn/configuration/generator)
|
|
- [Customizable syntax highlighting](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/highlight)
|
|
|
|
- **Advanced Functionality**
|
|
- [Chapter and site-wide printing capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization#activate-print-support)
|
|
- [Versatile search options: in-page, popup, and dedicated search page](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization#configure-search)
|
|
- [Customizable top bar buttons](https://mcshelby.github.io/hugo-theme-relearn/configuration/topbar)
|
|
- [Unlimited nested menu structure](https://mcshelby.github.io/hugo-theme-relearn/content/organization)
|
|
- [Configurable menu shortcuts](https://mcshelby.github.io/hugo-theme-relearn/configuration/menushortcuts)
|
|
- Support for hidden pages
|
|
- [Comprehensive taxonomy support](https://mcshelby.github.io/hugo-theme-relearn/content/taxonomy)
|
|
- [Social media integration](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization#social-media-meta-tags)
|
|
|
|
- **Multilingual Support**
|
|
- [Full right-to-left (RTL) language support](https://mcshelby.github.io/hugo-theme-relearn/configuration/i18n)
|
|
- [Extensive list of supported languages](https://mcshelby.github.io/hugo-theme-relearn/configuration/i18n#basic-configuration): Arabic, Chinese (Simplified and Traditional), Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese
|
|
- [Multilingual content search capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/i18n#search)
|
|
|
|
- **Enhanced Markdown Features**
|
|
- [GitHub Flavored Markdown (GFM) support](https://mcshelby.github.io/hugo-theme-relearn/content/markdown)
|
|
- [Support for Obsidian styled alerts](https://mcshelby.github.io/hugo-theme-relearn/content/markdown#obsidian-styled-alerts)
|
|
- [Advanced image manipulation like lightbox, sizing, shadows, borders, and alignment](https://mcshelby.github.io/hugo-theme-relearn/content/imageeffects)
|
|
|
|
- **Rich Shortcode Library**
|
|
- [Customizable marker badges](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/badge)
|
|
- [Flexible button creation](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/button)
|
|
- [Child page listing](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children)
|
|
- [Expandable content areas](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/expand)
|
|
- [Font Awesome icon integration](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon)
|
|
- [File inclusion capabilities](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/include)
|
|
- [MathJax support for mathematical and chemical formulae](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/math)
|
|
- [Mermaid diagram integration](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid)
|
|
- [Styled notice boxes](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/notice)
|
|
- [OpenAPI specification rendering with Swagger UI](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/openapi)
|
|
- [Page bundle resource display](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources)
|
|
- [Site configuration parameter display](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/siteparam)
|
|
- [Tab-based content organization](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tab) and [multi-tab panels](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tabs)
|
|
|
|
## Getting Started
|
|
|
|
For a comprehensive guide on the theme's capabilities, please refer to the [official documentation](https://mcshelby.github.io/hugo-theme-relearn/basics/quickstart).
|
|
|
|
## Updates and Changes
|
|
|
|
Visit the [What's New](https://mcshelby.github.io/hugo-theme-relearn/basics/releasenotes) page for feature highlights or the [detailed changelog](https://mcshelby.github.io/hugo-theme-relearn/basics/changelog) for a complete list of updates.
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions for bug fixes and new features. Please see the [contribution guidelines](https://mcshelby.github.io/hugo-theme-relearn/dev/contributing) before getting started.
|
|
|
|
## Licensing
|
|
|
|
The Relearn theme is distributed under the [MIT License](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE).
|
|
|
|
## Credits
|
|
|
|
This theme builds upon the work of [many contributors](https://mcshelby.github.io/hugo-theme-relearn/more/credits).
|