hugo-theme-relearn/README.md

84 lines
6.2 KiB
Markdown
Raw Normal View History

# Hugo Relearn Theme
2016-03-17 11:05:36 +00:00
2023-02-10 23:03:31 +00:00
A theme for [Hugo](https://gohugo.io/) designed for documentation.
2023-02-10 21:16:59 +00:00
2024-09-29 21:54:17 +00:00
[★ What's new in the latest version ★](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes)
2018-08-10 09:29:11 +00:00
![Image of the Relearn theme in light and dark mode on phone, tablet and desktop](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/hero.png)
2021-07-01 12:35:27 +00:00
2024-09-24 12:19:10 +00:00
## Overview
2024-09-24 12:19:10 +00:00
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.
2024-09-24 12:19:10 +00:00
## Key Features
2017-08-20 16:20:13 +00:00
2024-09-24 12:19:10 +00:00
- **Versatile Usage**
- Responsive design for mobile devices
2023-09-23 23:29:41 +00:00
- Looks nice on paper (if it has to)
2024-09-24 12:19:10 +00:00
- Usable offline with no external dependencies
2024-09-29 21:48:56 +00:00
- [Usable from your local file system without a web server via `file://` protocol](https://mcshelby.github.io/hugo-theme-relearn/configuration/siteorganization/deploymentscenarios/)
2024-09-24 12:19:10 +00:00
- Integration with the [VSCode Front Matter extension](https://github.com/estruyf/vscode-front-matter) for on-premise CMS capabilities
- **Customizable Appearance**
2024-09-29 21:48:56 +00:00
- [Flexible brand image configuration](https://mcshelby.github.io/hugo-theme-relearn/configuration/appearance/branding#change-the-logo)
- [Automatic light/dark mode switching based on OS settings](https://mcshelby.github.io/hugo-theme-relearn/configuration/appearance/branding#adjust-to-os-settings)
2024-09-24 12:19:10 +00:00
- Pre-defined color schemes and variants
2024-09-29 21:48:56 +00:00
- [User-selectable theme variants](https://mcshelby.github.io/hugo-theme-relearn/configuration/appearance/branding#multiple-variants)
- [Built-in stylesheet generator](https://mcshelby.github.io/hugo-theme-relearn/configuration/appearance/generator)
2024-09-24 12:19:10 +00:00
- [Customizable syntax highlighting](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/highlight)
- **Advanced Functionality**
2024-09-29 21:48:56 +00:00
- [Chapter and site-wide printing capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/appearance/topbar/#print-support)
- [Versatile search options: in-page, popup, and dedicated search page](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/search/)
- [Customizable top bar buttons](https://mcshelby.github.io/hugo-theme-relearn/configuration/modifications/topbar/)
2024-09-24 12:19:10 +00:00
- [Unlimited nested menu structure](https://mcshelby.github.io/hugo-theme-relearn/content/organization)
2024-09-29 21:48:56 +00:00
- [Configurable menu shortcuts](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/shortcutmenu/)
2024-09-24 12:19:10 +00:00
- Support for hidden pages
2024-10-06 14:19:13 +00:00
- [Comprehensive taxonomy support](https://mcshelby.github.io/hugo-theme-relearn/configuration/modifications/taxonomy)
2024-09-29 21:48:56 +00:00
- [Social media integration](https://mcshelby.github.io/hugo-theme-relearn/configuration/content/image/)
2024-09-24 12:19:10 +00:00
- **Multilingual Support**
2024-09-29 21:48:56 +00:00
- [Full right-to-left (RTL) language support](https://mcshelby.github.io/hugo-theme-relearn/configuration/siteorganization/multilingual/)
- [Extensive list of supported languages](https://mcshelby.github.io/hugo-theme-relearn/configuration/siteorganization/multilingual): 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/sidebar/search/#search-with-mixed-language-support)
2024-09-24 12:19:10 +00:00
- **Enhanced Markdown Features**
- [GitHub Flavored Markdown (GFM) support](https://mcshelby.github.io/hugo-theme-relearn/content/markdown)
- [Support for Obsidian callouts](https://mcshelby.github.io/hugo-theme-relearn/content/markdown#obsidian-callouts)
- [Advanced image manipulation like lightbox, sizing, shadows, borders, and alignment](https://mcshelby.github.io/hugo-theme-relearn/configuration/modifications/imageeffects)
2024-09-24 12:19:10 +00:00
- **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
2024-09-29 21:54:17 +00:00
For a comprehensive guide on the theme's capabilities, please refer to the [official documentation](https://mcshelby.github.io/hugo-theme-relearn/introduction/quickstart).
2024-09-24 12:19:10 +00:00
## Updates and Changes
2024-09-29 21:54:17 +00:00
Visit the [What's New](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes) page for feature highlights or the [detailed changelog](https://mcshelby.github.io/hugo-theme-relearn/introduction/changelog) for a complete list of updates.
2024-09-24 12:19:10 +00:00
## 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).
2021-07-01 12:35:27 +00:00
## Credits
2024-09-24 12:19:10 +00:00
This theme builds upon the work of [many contributors](https://mcshelby.github.io/hugo-theme-relearn/more/credits).