Basics on Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/index.html Recent content in Basics on Hugo Relearn Theme Hugo -- gohugo.io en What's New https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html This document shows you what’s new in the latest release and flags it with one of the following badges. For a detailed list of changes, see the history page. 0.112.4 The minimum required Hugo version. Breaking A change that requires action by you after upgrading to assure the site is still functional. Change A change in default behavior that may requires action by you if you want to revert it. Requirements https://mcshelby.github.io/hugo-theme-relearn/basics/requirements/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/requirements/index.html Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements. Just download at least version 0.112.4 of the Hugo binary for your OS (Windows, Linux, Mac). It’s a kind of magic Installation https://mcshelby.github.io/hugo-theme-relearn/basics/installation/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/installation/index.html The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this great documentation for beginners. Tip The following tutorial leads you thru the steps of creating a first, minimal new site. You don’t need to edit any files besides your hugo.toml and only need to execute the commands in the given order. Configuration https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo.toml. Note that some of these options are explained in detail in other sections of this documentation. All config options The values reflect the options active in this documentation. The defaults can be taken from the annotated example below. hugo. toml yaml json [params] additionalContentLanguage = ['en'] alwaysopen = '' breadcrumbSeparator = '>' collapsibleMenu = true customMathJaxURL = '' customMermaidURL = '' customOpenapiURL = '' description = 'Documentation for Hugo Relearn Theme' disableAssetsBusting = false disableBreadcrumb = false disableExplicitIndexURLs = false disableGeneratorVersion = false disableHoverBlockCopyToClipBoard = false disableInlineCopyToClipBoard = true disableLandingPageButton = true disableLanguageSwitchingButton = false disableMathJax = true disableMermaid = true disableNextPrev = false disableOpenapi = true disableRandomIds = false disableRootBreadcrumb = true disableSearch = false disableSearchHiddenPages = false disableSeoHiddenPages = true disableShortcutsTitle = false disableTagHiddenPages = false disableTermBreadcrumbs = false disableToc = false editURL = 'https://github. Branding https://mcshelby.github.io/hugo-theme-relearn/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/branding/index.html The Relearn theme provides configuration options to change your your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed thru so called color variants. A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your hugo. Customization https://mcshelby.github.io/hugo-theme-relearn/basics/customization/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/customization/index.html Usage scenarios The theme is usable in different scenarios, requiring the following mandatory settings in your hugo.toml. All settings not mentioned can be set to your liking. Public Webserver from Root hugo. toml yaml json baseURL = 'https://example.com/' baseURL: https://example.com/ { "baseURL": "https://example.com/" } Public Webserver from Subdirectory hugo. toml yaml json baseURL = 'https://example.com/mysite/' relativeURLs = false baseURL: https://example.com/mysite/ relativeURLs: false { "baseURL": "https://example.com/mysite/", "relativeURLs": false } Private Webserver (LAN) The same settings as with any of the public webserver usage scenarios or Stylesheet generator https://mcshelby.github.io/hugo-theme-relearn/basics/generator/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/generator/index.html This interactive tool may help you to generate your own color variant stylesheet. Show usage instructions To get started, first select a color variant from the variant selector in the lower left sidebar that fits you best as a starting point. The graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly. Topbar Modification https://mcshelby.github.io/hugo-theme-relearn/basics/topbar/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/topbar/index.html The theme comes with a reasonably configured topbar. Nevertheless, your requirements may differ from this configuration. Luckily the theme got you covered as the themebar, its buttons and the functionality behind these buttons is fully configurable by you. Tip All mentioned file names below can be clicked and show you the implementation for a better understanding. Areas The default configuration comes with three predefined areas that may contain an arbitrary set of buttons. History https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html Changelog 5.26.2 (2024-03-18) Enhancements [feature] icons: use fixed width to ease layout #812 Fixes [bug] search: broken since version 5.26.1 #813 [bug] search: fix result links for pages in root #810 5.26.1 (2024-03-17) Fixes [bug] mermaid: show reset button after pan #807 [bug] openapi: make it run for file:// protocol #806 [bug] theme: fix relative path detection if relativeURLs=false #804 5.26.0 (2024-03-16) Enhancements [feature] image: add lazy loading image effect option #803 [feature] render-hook: support Markdown attributes #795 [feature] theme: support full page width #752 Fixes [bug] clipboard: fix broken style if block code is in table #790 [bug] nav: browser back navigation does not jump to the correct position #509 Maintenance [task] build: update all available actions to nodejs 20 #802 [task] openapi: update swagger-ui to 5.