{"id":14981379,"url":"https://github.com/mcshelby/hugo-theme-relearn","last_synced_at":"2025-12-30T01:04:52.870Z","repository":{"id":37705059,"uuid":"295128524","full_name":"McShelby/hugo-theme-relearn","owner":"McShelby","description":"A theme for Hugo designed for documentation","archived":false,"fork":false,"pushed_at":"2025-05-01T12:27:49.000Z","size":758653,"stargazers_count":516,"open_issues_count":19,"forks_count":213,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-05-08T23:48:43.355Z","etag":null,"topics":["documentation-template","hugo","hugo-theme"],"latest_commit_sha":null,"homepage":"https://mcshelby.github.io/hugo-theme-relearn/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"matcornic/hugo-theme-learn","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/McShelby.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["McShelby"]}},"created_at":"2020-09-13T10:34:08.000Z","updated_at":"2025-05-05T06:50:54.000Z","dependencies_parsed_at":"2024-06-05T22:56:30.280Z","dependency_job_id":"a80a348c-2b54-4154-a852-2122fd097d64","html_url":"https://github.com/McShelby/hugo-theme-relearn","commit_stats":{"total_commits":2334,"total_committers":124,"mean_commits":"18.822580645161292","dds":0.2660668380462725,"last_synced_commit":"d5a0ee04ad986394d6d2f1e1a57f2334d24bf317"},"previous_names":[],"tags_count":229,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/McShelby%2Fhugo-theme-relearn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/McShelby%2Fhugo-theme-relearn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/McShelby%2Fhugo-theme-relearn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/McShelby%2Fhugo-theme-relearn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/McShelby","download_url":"https://codeload.github.com/McShelby/hugo-theme-relearn/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254264766,"owners_count":22041793,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-template","hugo","hugo-theme"],"created_at":"2024-09-24T14:03:27.333Z","updated_at":"2025-12-30T01:04:52.864Z","avatar_url":"https://github.com/McShelby.png","language":"CSS","funding_links":["https://github.com/sponsors/McShelby"],"categories":[],"sub_categories":[],"readme":"# Hugo Relearn Theme\n\nA theme for [Hugo](https://gohugo.io/) designed for documentation.\n\n[★ What's new in the latest version ★](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes)\n\n![Image of the Relearn theme in light and dark mode on phone, tablet and desktop](https://mcshelby.github.io/hugo-theme-relearn/images/hero.png)\n\n## Overview\n\nThe 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.\n\n## Key Features\n\n- **Versatile Usage**\n  - [Responsive design for mobile devices](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/width)\n  - [Looks nice on paper](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/outputformats) - if it has to\n  - [Usable offline with no external dependencies](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/deployment#offline-usage)\n  - [Usable from your local file system without a web server](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/deployment#file-system) via `file://` protocol\n  - [Integration with the VSCode Front Matter CMS extension](https://mcshelby.github.io/hugo-theme-relearn/introduction/tools#front-matter-cms) for on-premise CMS capabilities\n\n- **Customizable Appearance**\n  - [Flexible brand image configuration](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/logo#change-the-logo)\n  - [Automatic light/dark mode switching based on OS settings](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/colors#adjust-to-os-settings)\n  - [Many pre-defined color variants](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/colors#shipped-variants)\n  - [User-selectable variants](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/colors#multiple-variants)\n  - [Built-in stylesheet generator](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/generator)\n  - [Customizable syntax highlighting](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/modules/#change-syntax-highlighting)\n\n- **Advanced Functionality**\n  - [Chapter and site-wide printing capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/outputformats#print-support)\n  - [Versatile search options: in-page, popup, and dedicated search page](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/search)\n  - [Customizable topbar buttons](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/topbar)\n  - [Configurable sidebar menus](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/menus)\n  - [Support for hidden pages](https://mcshelby.github.io/hugo-theme-relearn/configuration/content/hidden)\n  - [Comprehensive taxonomy support](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/taxonomy)\n  - [Versioning support](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/versioning)\n  - [Social media integration](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/meta#social-media-images)\n\n- **Multilingual Support**\n  - [Full right-to-left (RTL) language support](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/multilingual)\n  - [Extensive list of supported languages](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/multilingual): Arabic, Chinese (Simplified and Traditional), Czech, Danish, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Persian, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Ukrainian, Vietnamese\n  - [Multilingual content search capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/search#mixed-language-support)\n\n- **Enhanced Markdown Features**\n  - [CommonMark compliant](https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown)\n  - [Support for Markdown extensions like GitHub Flavored Markdown](https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown#standard-and-extensions)\n  - [Support for Obsidian callouts](https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown#obsidian-callouts)\n  - [Advanced link manipulation like download and target](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/linkeffects)\n  - [Advanced image manipulation like lightbox, sizing, shadows, borders and alignment](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/imageeffects)\n\n- **Rich Shortcode Library**\n  - [Marker badges](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/badge)\n  - [Flexible buttons](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/button)\n  - [Card-based content organization](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/card) and [card sets](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/cards)\n  - [Child page listing](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children)\n  - [Expandable content areas](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/expand)\n  - [Font Awesome icon integration](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon)\n  - [File inclusion capabilities](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/include)\n  - [Math support for mathematical and chemical formulae](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/math)\n  - [Mermaid diagram integration](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid)\n  - [Styled notice boxes](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/notice)\n  - [OpenAPI specification rendering](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/openapi)\n  - [Page bundle resource display](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources)\n  - [Site configuration parameter display](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/siteparam)\n  - [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)\n  - [Nicely formatted tree lists](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tree)\n\n## Getting Started\n\nFor a comprehensive guide on the theme's capabilities, please refer to the [official documentation](https://mcshelby.github.io/hugo-theme-relearn/introduction/quickstart).\n\n## Updates and Changes\n\nVisit 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.\n\n## Contributing\n\nWe welcome contributions for bug fixes and new features. Please see the [contribution guidelines](https://mcshelby.github.io/hugo-theme-relearn/development/contributing) before getting started.\n\n## Licensing\n\nThe Relearn theme is distributed under the [MIT License](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE).\n\n## Credits\n\nThis theme is built on the shoulders of [giants](https://mcshelby.github.io/hugo-theme-relearn/more/credits).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcshelby%2Fhugo-theme-relearn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmcshelby%2Fhugo-theme-relearn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcshelby%2Fhugo-theme-relearn/lists"}