bda57027b3
switch to details/summary elements which hopefully has better a11y and will simplify state handling as it is build into the browser |
||
|---|---|---|
| .githooks | ||
| .github | ||
| .vscode | ||
| archetypes | ||
| assets | ||
| content/_relearn | ||
| exampleSite | ||
| i18n | ||
| images | ||
| layouts | ||
| static | ||
| vscode-frontmatter | ||
| .editorconfig | ||
| .gitignore | ||
| .grenrc.js | ||
| .imgbotconfig | ||
| .issuetracker | ||
| .prettierignore | ||
| .prettierrc.json | ||
| CHANGELOG.md | ||
| go.mod | ||
| hugo.toml | ||
| LICENSE | ||
| README.md | ||
| theme.toml | ||
Hugo Relearn Theme
A theme for Hugo designed for documentation.
★ What's new in the latest version ★
Overview
The Relearn theme is an enhanced fork of the popular Learn theme. 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 - Integration with the VSCode Front Matter CMS extension for on-premise CMS capabilities
-
Customizable Appearance
-
Advanced Functionality
-
Multilingual Support
- Full right-to-left (RTL) language support
- Extensive list of supported languages: 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
-
Enhanced Markdown Features
-
Rich Shortcode Library
- Customizable marker badges
- Flexible buttons
- Child page listing
- Expandable content areas
- Font Awesome icon integration
- File inclusion capabilities
- Math support for mathematical and chemical formulae
- Mermaid diagram integration
- Styled notice boxes
- OpenAPI specification rendering
- Page bundle resource display
- Site configuration parameter display
- Tab-based content organization and multi-tab panels
Getting Started
For a comprehensive guide on the theme's capabilities, please refer to the official documentation.
Updates and Changes
Visit the What's New page for feature highlights or the detailed changelog for a complete list of updates.
Contributing
We welcome contributions for bug fixes and new features. Please see the contribution guidelines before getting started.
Licensing
The Relearn theme is distributed under the MIT License.
Credits
This theme builds upon the work of many contributors.