github.com/choria-io/go-choria@v0.28.1-0.20240416190746-b3bf9c7d5a45/docs/themes/hugo-theme-relearn/README.md (about)

     1  # Hugo Relearn Theme
     2  
     3  A theme for [Hugo](https://gohugo.io/) designed for documentation.
     4  
     5  [★ What's new in the latest release ★](https://mcshelby.github.io/hugo-theme-relearn/basics/migration)
     6  
     7  ![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)
     8  
     9  ## Motivation
    10  
    11  The Relearn theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo-theme-learn) 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.
    12  
    13  ## Features
    14  
    15  - **Wide set of usage scenarios**
    16    - Responsive design for mobile usage
    17    - Looks nice on paper (if it has to)
    18    - Usable offline, no external dependencies
    19    - [Usable from your local file system via `file://` protocol](https://mcshelby.github.io/hugo-theme-relearn/basics/customization#file-system)
    20    - Support for the [VSCode Front Matter extension](https://github.com/estruyf/vscode-front-matter) for on-premise CMS capabilities
    21    - Support for Internet Explorer 11
    22    - [Support for Open Graph and Twitter Cards](https://mcshelby.github.io/hugo-theme-relearn/basics/customization#social-media-meta-tags)
    23  - **Configurable theming and visuals**
    24    - [Configurable brand images](https://mcshelby.github.io/hugo-theme-relearn/basics/branding#change-the-logo)
    25    - [Automatic switch for light/dark variant dependend on your OS settings](https://mcshelby.github.io/hugo-theme-relearn/basics/branding#adjust-to-os-settings)
    26    - Predefined light, dark and color variants
    27    - [User selectable variants](https://mcshelby.github.io/hugo-theme-relearn/basics/branding#multiple-variants)
    28    - [Stylesheet generator](https://mcshelby.github.io/hugo-theme-relearn/basics/generator)
    29    - [Configurable syntax highlighting](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/highlight)
    30  - **Unique theme features**
    31    - [Print whole chapters or even the complete site](https://mcshelby.github.io/hugo-theme-relearn/basics/customization#activate-print-support)
    32    - In page search
    33    - [Site search](https://mcshelby.github.io/hugo-theme-relearn/basics/customization#activate-search)
    34    - [Dedicated search page](https://mcshelby.github.io/hugo-theme-relearn/basics/customization#activate-dedicated-search-page)
    35    - [Taxonomy support](https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy)
    36    - [Configurable topbar buttons](https://mcshelby.github.io/hugo-theme-relearn/basics/topbar)
    37    - [Unlimited nested menu items](https://mcshelby.github.io/hugo-theme-relearn/cont/pages)
    38    - [Configurable shortcut links](https://mcshelby.github.io/hugo-theme-relearn/cont/menushortcuts)
    39    - Hidden pages
    40  - **Multi language support**
    41    - [Full support for languages written right to left](https://mcshelby.github.io/hugo-theme-relearn/cont/i18n)
    42    - [Available languages](https://mcshelby.github.io/hugo-theme-relearn/cont/i18n#basic-configuration): Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese
    43    - [Search support for mixed language content](https://mcshelby.github.io/hugo-theme-relearn/cont/i18n#search)
    44  - **Additional Markdown features**
    45    - [Support for GFM (GitHub Flavored Markdown)](https://mcshelby.github.io/hugo-theme-relearn/cont/markdown)
    46    - [Image effects like sizing, shadow, border and alignment](https://mcshelby.github.io/hugo-theme-relearn/cont/markdown#image-effects)
    47    - [Image lightbox](https://mcshelby.github.io/hugo-theme-relearn/cont/markdown#lightbox)
    48  - **Shortcodes galore**
    49    - [Display resources contained in a page bundle](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources)
    50    - [Marker badges](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/badge)
    51    - [Configurable buttons](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/button)
    52    - [List child pages](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children)
    53    - [Expand areas to reveal content](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/expand)
    54    - [Font Awesome icons](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon)
    55    - [Inclusion of other files](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/include)
    56    - [Math and chemical formulae using MathJax](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/math)
    57    - [Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid)
    58    - [Colorful boxes](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/notice)
    59    - [OpenAPI specifications using Swagger UI](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/openapi)
    60    - [Reveal you site's configuration parameter](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/siteparam)
    61    - [Single tabbed panels](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tab) and [multiple tabbed panels](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tabs)
    62  
    63  ## Installation & Usage
    64  
    65  For a detailed description of the theme's capabilities visit the [official documentation](https://mcshelby.github.io/hugo-theme-relearn/).
    66  
    67  ## Changelog
    68  
    69  See the [What's New](https://mcshelby.github.io/hugo-theme-relearn/basics/migration) page for release highlights or the detailed [change history](https://mcshelby.github.io/hugo-theme-relearn/basics/history) for a complete list of changes.
    70  
    71  ## Contributions
    72  
    73  You are most welcome to contribute bugfixes or new features. Check the [contribution guidelines](https://mcshelby.github.io/hugo-theme-relearn/dev/contributing) first before starting.
    74  
    75  ## License
    76  
    77  The Relearn theme is licensed under the [MIT License](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE).
    78  
    79  ## Credits
    80  
    81  This theme would not be possible without the work of [many others](https://mcshelby.github.io/hugo-theme-relearn/more/credits).