nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-10-27 10:43:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
hugo-theme-relearn/searchindex.en.js
McShelby 0880ffa1f9 deploy: ad8ee549a7
2024-10-24 22:24:55 +00:00

2573 lines
577 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

var relearn_searchindex = [
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo’s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use .LinkTitle instead of .Title if available #816 Fixes [bug] scrollbar: scroll bar in side menu gets stuck in dragged state on mobile #808",
"description": "5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo’s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use .LinkTitle instead of .Title if available #816 Fixes [bug] scrollbar: scroll bar in side menu gets stuck in dragged state on mobile #808",
"tags": [],
"title": "Version 5.27",
"uri": "/hugo-theme-relearn/introduction/changelog/5/27/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.27.0 (2024-04-07) Hugo 0.121.0 0.121.0 This release requires a newer Hugo version. Change Change If the theme is configured to generate warnings or errors during build by setting image.errorlevel to either warning or error in your hugo.toml, it will now also generate output if a link fragment is not found in the target page.\nChange The dependency loader was made more versatile.\nThe configuration in your hugo.toml does not require the location parameter anymore. If you still use it, the theme will work as before but will generate a warning. So you don’t need to change anything, yet.\nWith the new mechanism, your dependency loader now receives an additional location parameter instead that you can query to inject your dependencies in the desired location.\nBy that you can now call the dependency mechanism in your own overriden partials by giving it a distinct location parameter. In addition your injected files can now be spread to multiple locations which wasn’t previously possible.\nNew New Additional styling was added for the native HTML elements \u003cmark\u003e and \u003ckbd\u003e. To use them you must allow the usage of HTML in your hugo.toml. The Markdown documentation was enhanced for this.\nNew You now can scroll forward and backward through all headings of a page by using ALT 🡑 and ALT 🡓. This also works for the PRINT output format.\nNew The breadcrumbs used in the topbar, search results and the taxonomy term lists are now using the pages front matter linktitle instead of title if set.",
"description": "5.27.0 (2024-04-07) Hugo 0.121.0 0.121.0 This release requires a newer Hugo version. Change Change If the theme is configured to generate warnings or errors during build by setting image.errorlevel to either warning or error in your hugo.toml, it will now also generate output if a link fragment is not found in the target page.",
"tags": [],
"title": "Version 5.27",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/27/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "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.11.10 #798 [task] mermaid: update to 10.9.0 #797",
"description": "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",
"tags": [],
"title": "Version 5.26",
"uri": "/hugo-theme-relearn/introduction/changelog/5/26/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.26.0 (2024-03-18) New New The lazy loading of images is now configurable by using the new lazy image effect. The default value hasn’t changed in comparison to older versions, you don’t need to change anything.\nNew It is now possible to adjust the max width of the main area, eg. in case you want to use the full page width for your content.\nNew Images and Markdown codefences are now respecting Hugo’s Markdown attributes.\nNew The theme has updated its Mermaid dependency to 10.6.0. This adds support for block diagrams.\nNew This release fixes a long-standing bug where the page wasn’t repositioning correctly when going forward or backward in your browser history.",
"description": "5.26.0 (2024-03-18) New New The lazy loading of images is now configurable by using the new lazy image effect. The default value hasn’t changed in comparison to older versions, you don’t need to change anything.",
"tags": [],
"title": "Version 5.26",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/26/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.25.0 (2024-02-29) Enhancements [feature][change] theme: print out GitInfo in page footer if configured #786 [feature][change] resources: new shortcode to deprecate attachments shortcode #22 Fixes [bug] swagger: fix compat warning #787",
"description": "5.25.0 (2024-02-29) Enhancements [feature][change] theme: print out GitInfo in page footer if configured #786 [feature][change] resources: new shortcode to deprecate attachments shortcode #22 Fixes [bug] swagger: fix compat warning #787",
"tags": [],
"title": "Version 5.25",
"uri": "/hugo-theme-relearn/introduction/changelog/5/25/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.25.0 (2024-02-29) Change Change This release deprecates the attachments shortcode in favor of the new the resources shortcode.\nIf you are using Hugo below 0.123.0, you don’t need to change anything as the old shortcode still works (but may generate warnings).\nAnyways, users are strongly advised to migrate as the attachments shortcode will not receive support anymore. Migration instructions are listed on the attachments shortcode page.\nChange If you run Hugo with GitInfo configured, the default page footer now prints out name, email address and date of the last commit. If you want to turn this off you either have to run Hugo without GitInfo (which is the default) or overwrite the content-footer.html partial.",
"description": "5.25.0 (2024-02-29) Change Change This release deprecates the attachments shortcode in favor of the new the resources shortcode.",
"tags": [],
"title": "Version 5.25",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/25/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.24.3 (2024-02-28) Fixes [bug] theme: avoid crash on 404 if author settings want to warn #785 5.24.2 (2024-02-24) Enhancements [feature] image: adjust to Hugo 0.123 #777 Fixes [bug] link: resolve fragments #775 5.24.1 (2024-02-18) Enhancements [feature] link: make resolution reporting configurable #774 5.24.0 (2024-02-17) Enhancements [feature] theme: compatibility with Hugo 0.123 #771 [feature] topbar: support editURL in frontmatter #764 [feature] menu: use –MENU-WIDTH-S to adjust mobile flyout #761 [feature] figure: support built-in shortcode #746 [feature] theme: make heading a template #744 [feature] taxonomy: make arrow nav browse through terms #742 [feature] theme: switch from config.toml to hugo.toml #741 [feature] button: make non-interactive if used as mock #740 [feature][change] topbar: allow text for button #739 [feature] theme: run hugo demo site without warning #736 [feature] menu: make swipe handler passive #735 [feature] i18n: support standard Hugo options #733 [feature] a11y: show tab focus on images #730 [feature] a11y: improve discovering links on keyboard navigation #726 [feature][change] variant: increase contrast for light themes #722 [feature] theme: break build if minimum Hugo version is not matched #719 [feature] taxonomy: humanize term on missing term title #713 Fixes [bug] taxonomy: display translated title #772 [bug] highlight: fix codefence syntax in Hugo \u003e= 0.121.0 #749 [bug] link: fix links to pages containing dots in their name #748 [bug] image: get resource images if link is prefixed with ./ #747 [bug] theme: switch dependency colors on OS color scheme change #745 [bug] clipboard: fix O(n²) buttons #738 [bug] button: fix whitespacing in FF #737 [bug] i18n: fix warning messages for zh-CN #732 [bug] mermaid: fix zoom button #725 [bug] theme: fix JS errors on hugo --minifiy #724 [bug] include: fix whitespacing in codefences #723",
"description": "5.24.3 (2024-02-28) Fixes [bug] theme: avoid crash on 404 if author settings want to warn #785",
"tags": [],
"title": "Version 5.24",
"uri": "/hugo-theme-relearn/introduction/changelog/5/24/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.24.0 (2024-02-28) Hugo 0.112.4 0.112.4 This release requires a newer Hugo version. Change Change The topbar button received a way to add text next to the icon. For this, the original title option was renamed to hint while the new title option is now displayed next to the icon.\nChange The front matter option menuTitle is now deprecated in favor for Hugo’s own linkTitle. You don’t need to change anything as the old menuTitle option is still supported.\nChange The light themes have a bit more contrast for content text and headings. Also the syntaxhighlighting was changed to the more colorful MonokaiLight. This brings the syntaxhighlighting in sync with the corresponding dark theme variants, which are using Monokai. If you dislike this, you can create your own color variant file as described here.\nNew New If the theme can not resolve a link to a page or image, you can now generate warnings or errors during build by setting link.errorlevel or image.errorlevel to either warning or error in your hugo.toml respectively. By default this condition is silently ignored and the link is written as-is.\nPlease note that a page link will generate false negatives if uglyURLs=true and it references an ordinary page before 0.123.0.\nPlease note that an image link will generate false negatives if the file resides in your static directory.\nNew You now can configure additional options for every theme variant in your hugo.toml. This allows for optional advanced functionality. You don’t need to change anything as the old configuration options will still work (but may generate warnings now).\nThe advanced functionality allows you to set an explicit name for a theme variant and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.\nNew New partial for defining the heading. See documentation for further reading.\nNew Support for Hugo’s built-in figure shortcode.\nNew On taxonomy and term pages you can now use prev/next navigation as within the normal page structure.\nNew In additiion to the existing menu width customization, it is now also possible to set the width of the menu flyout for small screen sizes with the --MENU-WIDTH-S CSS property.\nNew Improvements for accessibility when tabbing through the page for images, links and tab handles.\nNew The editURL config parameter is now overwritable in your pages front matter. In addition it received more versatility by letting you control where to put the file path into the URL. This is achieved by replacing the variable ${FilePath} in your URL by the pages file path. You don’t need to change anything in your existing configuration as the old way without the replacement variable still works.\nNew The themes config and front matter options received a comprehensive documentation update. In addition the theme switched from config.toml to hugo.toml.\nNew Restored compatibility with Hugo versions 0.121.0 or higher for the highlight shortcode. This does not change the minimum required Hugo version.\nNew Restored compatibility with Hugo versions 0.123.0 or higher for theme specific output formats and handling of taxonomy and term titles. This does not change the minimum required Hugo version.",
"description": "5.24.0 (2024-02-28) Hugo 0.112.4 0.112.4 This release requires a newer Hugo version. Change Change The topbar button received a way to add text next to the icon. For this, the original title option was renamed to hint while the new title option is now displayed next to the icon.",
"tags": [],
"title": "Version 5.24",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/24/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.23.2 (2023-11-03) Enhancements [feature] taxonomy: improve taxonomy page #712 [feature] taxonomy: warn on missing term title #709 Fixes [bug] taxonomy: fix sorting of terms on content pages #710 5.23.1 (2023-10-30) Enhancements [feature] taxonomy: improve term page #705 Fixes [bug] variant: fix typo in chroma-learn.css #708 [bug] links: ignore local markdown links linking to files with extension #707 5.23.0 (2023-10-29) Enhancements [feature] taxonomy: allow for content on term pages #701 [feature] theme: write full file path on warnings #699 [feature] theme: show anchor link and copy to clipboard button on mobile #697 [feature][change] config: adjust to changes in Hugo 0.120 #693 [feature] variants: add more contrast to neon #692 [feature] mermaid: only show zoom reset button if zoomed #691 [feature] menu: add additional sort options #684 [feature] theme: add social media meta information #683 [feature] theme: simplify additional JS dependencies #682 [feature] links: warn if ref/relref is used falsly #681 [feature] menu: make width configurable #677 [feature] tabs: use color for link of inactive tabs #675 [feature] taxonomy: modularize term list generation #671 [feature] theme: remove warnings with hugo --printI18nWarnings #670 [feature] theme: implement portable linking #377 Fixes [bug] links: extra space before link text #700 [bug] mermaid: reset zoom correctly #690 [bug] theme: fix mobile layout for width=48rem #676 [bug] frontmatter: resemble documented shortcode style #672 [bug] taxonomy: display terms in pages if removePathAccents=true #669 Maintenance [task] mermaid: update mermaid to 10.6.0 #703 [task] openapi: update swagger-ui to 5.9.1 #702",
"description": "5.23.2 (2023-11-03) Enhancements [feature] taxonomy: improve taxonomy page #712 [feature] taxonomy: warn on missing term title #709 Fixes [bug] taxonomy: fix sorting of terms on content pages #710",
"tags": [],
"title": "Version 5.23",
"uri": "/hugo-theme-relearn/introduction/changelog/5/23/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.23.0 (2023-11-03) Change Change With 0.120.0 the author settings move into the [params] array in your hugo.toml. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.\nChange your previous setting from\nhugo. toml yaml json [params] author = 'Hugo' params: author: Hugo { \"params\": { \"author\": \"Hugo\" } } to\nhugo. toml yaml json [params] [params.author] name = 'Hugo' params: author: name: Hugo { \"params\": { \"author\": { \"name\": \"Hugo\" } } } Change Taxonomy term pages now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your hugo.toml by adding disableTermBreadcrumbs=true.\nNew New Taxonomy and term pages are now allowed to contain content. This is added inbetween the title and the page list.\nNew It is now possible to print custom taxonomies anywhere in your page. See the docs.\nNew It is now possible to adjust the menu width for your whole site. See the docs.\nNew This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. See the docs.\nNew This release comes with additional sort options for the menu and the children shortcode. Both will now accept the following values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adhering to Hugo’s default sort order).\nNew The theme now provides a mechanism to load further JavaScript dependencies defined by you only if it is needed. This comes in handy if you want to add own shortcodes that depend on additional JavaScript code to be loaded. See the docs.\nNew The theme has updated its Mermaid dependency to 10.6.0. This adds support for the xychart type.\nNew This release adds portable Markdown links.\nPreviously it was not possible to use pure Markdown links in a configuration independent way to link to pages inside of your project. It always required you to know how your uglyURLs setting is, wheather you link to a page or page bundle and in case of relative links if your current page is a page or page bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This is a hassle as you have to change these links manually once you change your uglyURLs setting or change the type of a page.\nYou could work around this by using the relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results in non-portable Markdown.\nNow it’s possible to use the same path of a call to relref in a plain Markdown link (eg [generator](../generator)). This is independent of any configuration settings or the page types involved in linking. Note, that this requires your links to be given without any extension, so [generator](generator/index.html) will work as before.\nThe following types of linking are supported:\nlink description [generator](en/configuration/branding/generator) absolute from your project root (multilang) [generator](/en/configuration/branding/generator) absolute from your project root (multilang) [generator](configuration/branding/generator) absolute from your current language root [generator](/configuration/branding/generator) absolute from your current language root [generator](./../generator) relative from the current page [generator](../generator) relative from the current page",
"description": "5.23.0 (2023-11-03) Change Change With 0.120.0 the author settings move into the [params] array in your hugo.toml. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.",
"tags": [],
"title": "Version 5.23",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/23/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.22.1 (2023-10-02) Enhancements [feature] i18n: add Swahili translation #666 [feature] math: hide unrendered math #663 [feature] tabs: improve a11y by removing duplicate hidden title #662 [feature] mermaid: improve zoom UX #659 Fixes [bug] variant: fix sidebar-flyout borders color for zen #667 [bug] clipboard: fix RTL location of tooltip #661 [bug] clipboard: ignore RTL for code #660 [bug] expand: fix aria-controls #658 [bug] theme: fix id generation for markdownified titles #657 [bug] mermaid: avoid graph bombing on hugo –minify #656 [bug] mermaid: fix width for some graphs #655 5.22.0 (2023-09-26) Enhancements [feature] mermaid: add pan\u0026zoom reset #651 [feature] markdown: add interlace color for tables #648 [feature] search: add breadcrumb to dedicated search results #647 [feature][change] menu: optionally disable index pages for sections #642 Fixes [bug] variants: restore generator zoom #650 [bug] clipboard: malused Fontawesome style #649 [bug][change] theme: avoid id collisions between headings and theme #646 [bug] theme: remove HTML validation errors #644 [bug] breadcrumb: remove superflous whitespace between items #643",
"description": "5.22.1 (2023-10-02) Enhancements [feature] i18n: add Swahili translation #666 [feature] math: hide unrendered math #663 [feature] tabs: improve a11y by removing duplicate hidden title #662 [feature] mermaid: improve zoom UX #659 Fixes [bug] variant: fix sidebar-flyout borders color for zen #667 [bug] clipboard: fix RTL location of tooltip #661 [bug] clipboard: ignore RTL for code #660 [bug] expand: fix aria-controls #658 [bug] theme: fix id generation for markdownified titles #657 [bug] mermaid: avoid graph bombing on hugo –minify #656 [bug] mermaid: fix width for some graphs #655",
"tags": [],
"title": "Version 5.22",
"uri": "/hugo-theme-relearn/introduction/changelog/5/22/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.22.0 (2023-10-02) Change Change This release fixes an issue where in unfortunate conditions DOM ids generated by Hugo may collide with DOM ids set by the theme. To avoid this, all theme DOM ids are now prefixed with R-.\nIf you haven’t modified anything, everything is fine. Otherwise you have to check your custom CSS rules and JavaScript code.\nChange You can now have structural sections in the hierarchical menu without generating a page for it.\nThis can come in handy, if content for such a section page doesn’t make much sense to you. See the documentation for how to do this.\nThis feature may require you to make changes to your existing installation if you are already using shortcuts to pages inside of your project with a headless branch parent.\nIn this case it is advised to remove the title from the headless branch parent’s front matter, as it will otherwise appear in your breadcrumbs.\nNew New It is now possible to overwrite the setting for collapsibleMenu of your hugo.toml inside of a page’s front matter.\nNew If a Mermaid graph is zoomable a button to reset the view is now added to the upper right corner. The button is only shown once the mouse is moved over the graph.\nNew It is now possible to remove the root breadcrumb by setting disableRootBreadcrumb=true in your hugo.toml.\nNew The output of the dedicated search page now displays the result’s breadcrumb.\nNew Table rows now change their background color on every even row.\nNew Translation into Swahili. This language is not supported for search.",
"description": "5.22.0 (2023-10-02) Change Change This release fixes an issue where in unfortunate conditions DOM ids generated by Hugo may collide with DOM ids set by the theme. To avoid this, all theme DOM ids are now prefixed with R-.",
"tags": [],
"title": "Version 5.22",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/22/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.21.0 (2023-09-18) Enhancements [feature] topbar: make buttons configurable #639 [feature][change] menu: fix footer padding #637 Fixes [bug] breadcrumb: don’t ignore spaces for separator #636 [bug] theme: fix snyk code issues #633 [bug] images: apply image effects to lightbox images #631 Maintenance [task] openapi: update to swagger 5.7.2 #641",
"description": "5.21.0 (2023-09-18) Enhancements [feature] topbar: make buttons configurable #639 [feature][change] menu: fix footer padding #637 Fixes [bug] breadcrumb: don’t ignore spaces for separator #636 [bug] theme: fix snyk code issues #633 [bug] images: apply image effects to lightbox images #631 Maintenance [task] openapi: update to swagger 5.7.2 #641",
"tags": [],
"title": "Version 5.21",
"uri": "/hugo-theme-relearn/introduction/changelog/5/21/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.21.0 (2023-09-18) Change Change We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your menu-footer.html partial overridden, you may want to review the styling (eg. margins/paddings) of your partial. New New This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See the documentation for further details.\nNew The theme has updated its Swagger dependency to 5.7.2 for the openapi shortcode. This brings support for OpenAPI Specification 3.1.",
"description": "5.21.0 (2023-09-18) Change Change We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your menu-footer.html partial overridden, you may want to review the styling (eg. margins/paddings) of your partial. New New This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See the documentation for further details.",
"tags": [],
"title": "Version 5.21",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/21/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.20.0 (2023-08-26) Enhancements [feature][change] theme: support for colored borders between menu and content #626 [feature] image: allow option to apply image effects globally #623 [feature][change] openapi: switch to light syntaxhighlighting where applicable #621 [feature] images: document usage of images with links #576 Fixes [bug] highlight: fix rendering for Hugo \u003c 0.111 #630 [bug] search: remove link underline on dedicated search page #627 [bug] highlight: don’t switch to block view if hl_inline=true #618 [bug] variant: minor adjustments to zen variants #617 [bug] mermaid: lazy render graph if it is initially hidden #187 Maintenance [task] openapi: update to swagger 5.4.1 #620",
"description": "5.20.0 (2023-08-26) Enhancements [feature][change] theme: support for colored borders between menu and content #626 [feature] image: allow option to apply image effects globally #623 [feature][change] openapi: switch to light syntaxhighlighting where applicable #621 [feature] images: document usage of images with links #576 Fixes [bug] highlight: fix rendering for Hugo \u003c 0.111 #630 [bug] search: remove link underline on dedicated search page #627 [bug] highlight: don’t switch to block view if hl_inline=true #618 [bug] variant: minor adjustments to zen variants #617 [bug] mermaid: lazy render graph if it is initially hidden #187 Maintenance [task] openapi: update to swagger 5.4.1 #620",
"tags": [],
"title": "Version 5.20",
"uri": "/hugo-theme-relearn/introduction/changelog/5/20/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.20.0 (2023-08-26) Change Change The theme has updated its Swagger dependency to 5.4.1 for the openapi shortcode.\nWith this comes a change in the light theme variants of Relearn Bright, Relearn Light and Zen Light by switching the syntaxhighlighting inside of openapi to a light scheme. This brings it more in sync with the code style used by the theme variants itself.\nAdditionally, the syntaxhighlighting inside of openapi for printing was switched to a light scheme for all theme variants.\nIf you dislike this change, you can revert this in your theme variants CSS by adding\n--OPENAPI-CODE-theme: obsidian; --PRINT-OPENAPI-CODE-theme: obsidian; Change For consistency reasons, we renamed the CSS variable --MENU-SECTION-HR-color to --MENU-SECTION-SEPARATOR-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew New The theme variants Zen Light and Zen Dark now add more contrast between menu, topbar and content by adding thin borders.\nThose borders are now configurable by using the CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color and --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.\nFor existing variants nothing has changed visually.\nNew The default values for the image effects are now configurable for your whole site via hugo.toml or for each page through front matter.\nNew This release fixes a long-standing bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed expand or inactive tabs.\nNew Restored compatibility with Hugo versions lower than 0.111.0 for the highlight shortcode. This does not change the minimum required Hugo version.",
"description": "5.20.0 (2023-08-26) Change Change The theme has updated its Swagger dependency to 5.4.1 for the openapi shortcode.",
"tags": [],
"title": "Version 5.20",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/20/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.19.0 (2023-08-12) Enhancements [feature] highlight: add title parameter #616 [feature] variant: signal variant switch as event #614 [feature] variant: add zen variant in light and dark #613 [feature] i18n: add Hungarian translation #604 [feature] mermaid: update to 10.3.0 #601 Fixes [bug] siteparam: avoid halt if param is a map/slice #611 [bug] mermaid: fix broken zoom since update to v10 #608 [bug] mermaid: variant generator diagram does not respond to events #607 [bug] print: avoid chroma leak for relearn-dark #605 Maintenance [task] mermaid: update to 10.3.1 #610",
"description": "5.19.0 (2023-08-12) Enhancements [feature] highlight: add title parameter #616 [feature] variant: signal variant switch as event #614 [feature] variant: add zen variant in light and dark #613 [feature] i18n: add Hungarian translation #604 [feature] mermaid: update to 10.3.0 #601 Fixes [bug] siteparam: avoid halt if param is a map/slice #611 [bug] mermaid: fix broken zoom since update to v10 #608 [bug] mermaid: variant generator diagram does not respond to events #607 [bug] print: avoid chroma leak for relearn-dark #605 Maintenance [task] mermaid: update to 10.3.1 #610",
"tags": [],
"title": "Version 5.19",
"uri": "/hugo-theme-relearn/introduction/changelog/5/19/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.19.0 (2023-08-12) New New The highlight shortcode now accepts the new parameter title. This displays the code like a single tab. This is also available using Markdown codefences and makes it much easier to write nicer code samples.\nNew The theme has added two new color variants zen-light and zen-dark. Check it out!\nNew The theme now dispatches the custom event themeVariantLoaded on the document when the variant is fully loaded either initially or by switching the variant manually with the variant selector.\nNew The theme has updated its Mermaid dependency to 10.3.1. This adds support for the sankey diagram type and now comes with full support for YAML inside Mermaid graphs (previously, the theme ignored explicit Mermaid theme settings in YAML).\nNew Translation into Hungarian.",
"description": "5.19.0 (2023-08-12) New New The highlight shortcode now accepts the new parameter title. This displays the code like a single tab. This is also available using Markdown codefences and makes it much easier to write nicer code samples.",
"tags": [],
"title": "Version 5.19",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/19/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.18.0 (2023-07-27) Enhancements [feature][change] shortcodes: add more deprecation warnings #598 [feature][change] shortcodes: change context parameter to page if called as partial #595 [feature] siteparam: support nested parameters and text formatting #590 [feature][change] a11y: improve when tabbing through links #581 Fixes [bug] openapi: inherit RTL setting from Hugo content #600 [bug] 404: fix display in RTL #597 [bug] highlight: fix position of copy-to-clipboard button in RTL #594 [bug] openapi: fix spelling #593 [bug] search: fix typo in output format #591 [bug] tabs: fix tab selection by groupid #582 [bug] theme: restore compat with Hugo 0.95.0 #580 [bug][change] theme: improve display of links #577",
"description": "5.18.0 (2023-07-27) Enhancements [feature][change] shortcodes: add more deprecation warnings #598 [feature][change] shortcodes: change context parameter to page if called as partial #595 [feature] siteparam: support nested parameters and text formatting #590 [feature][change] a11y: improve when tabbing through links #581 Fixes [bug] openapi: inherit RTL setting from Hugo content #600 [bug] 404: fix display in RTL #597 [bug] highlight: fix position of copy-to-clipboard button in RTL #594 [bug] openapi: fix spelling #593 [bug] search: fix typo in output format #591 [bug] tabs: fix tab selection by groupid #582 [bug] theme: restore compat with Hugo 0.95.0 #580 [bug][change] theme: improve display of links #577",
"tags": [],
"title": "Version 5.18",
"uri": "/hugo-theme-relearn/introduction/changelog/5/18/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.18.0 (2023-07-27) Change Change The theme adds additional warnings for deprecated or now unsupported features.\nChange There are visual improvements in displaying text links in your content as well as to some other clickable areas in the theme. If you’ve overwritten some theme styles in your own CSS, keep this in mind.\nNew New Restored compatibility with Hugo 0.95.0 or higher. This does not change the minimum required Hugo version.\nNew The siteparam shortcode is now capable in displaying nested params as well as supporting text formatting.",
"description": "5.18.0 (2023-07-27) Change Change The theme adds additional warnings for deprecated or now unsupported features.",
"tags": [],
"title": "Version 5.18",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/18/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.17.1 (2023-06-22) Enhancements [feature][change] highlight: make copy to clipboard appear on hover #574 5.17.0 (2023-06-22) Enhancements [feature] highlight: add configurable line breaks #169 Fixes [bug] theme: support Hugo 0.114.0 #573 [bug] taxonomy: fix number tags #570 [bug] highlight: improve copy to clipboard #569",
"description": "5.17.1 (2023-06-22) Enhancements [feature][change] highlight: make copy to clipboard appear on hover #574",
"tags": [],
"title": "Version 5.17",
"uri": "/hugo-theme-relearn/introduction/changelog/5/17/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.17.0 (2023-06-22) Change Change The default behavior for the copy-to-clipboard feature for code blocks has changed.\nThe copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.\nIf you dislike this new behavior you can turn it off and revert to the old behavior by adding [params] disableHoverBlockCopyToClipBoard=true to your hugo.toml.\nNew New Restored compatibility with Hugo 0.114.0 or higher. This does not change the minimum required Hugo version.\nNew The new highlight shortcode replaces Hugo’s default implementation and is fully compatible. So you don’t need to change anything.\nIn addition it offers some extensions. Currently only the wrap extension option is provided to control whether a code block should be wrapped or scrolled if to long to fit.",
"description": "5.17.0 (2023-06-22) Change Change The default behavior for the copy-to-clipboard feature for code blocks has changed.",
"tags": [],
"title": "Version 5.17",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/17/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.16.2 (2023-06-10) Enhancements [feature] theme: revamp 404 page #566 5.16.1 (2023-06-09) Enhancements [feature] theme: add deprecation warnings #565 Fixes [bug] mermaid: allow for YAML frontmatter inside of graph #564 [bug] alias: fix redirect URLs in case of empty BaseURL #562 5.16.0 (2023-06-08) Enhancements [feature] tabs: add title and icon option #552 [feature] shortcodes: add style option to mimic code box color scheme #551 [feature] tabs: support color options #550 [feature] favicon: add light \u0026 dark option for OS’s preferred color scheme #549 Fixes [bug] icon: remove whitespace on start #560 [bug] shortcodes: avoid superflous margin at start and end of content #558 [bug] expand: fix html encoding of finishing content tag #557 [bug] icon: fix ouput “raw HTML omitted” with goldmark config unsafe=false #555",
"description": "5.16.2 (2023-06-10) Enhancements [feature] theme: revamp 404 page #566 5.16.1 (2023-06-09) Enhancements [feature] theme: add deprecation warnings #565 Fixes [bug] mermaid: allow for YAML frontmatter inside of graph #564 [bug] alias: fix redirect URLs in case of empty BaseURL #562",
"tags": [],
"title": "Version 5.16",
"uri": "/hugo-theme-relearn/introduction/changelog/5/16/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.16.0 (2023-06-10) Change Change The theme now provides warnings for deprecated or now unsupported features. The warnings include hints how to fix them and an additional link to the documentation.\nDEPRECATION warnings mark features that still work but may be removed in the future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange The 404 error page was revamped. Hopefully you will not see this very often.\nNew New The tabs shortcode and the tab shortcode received some love and now align with their style, color, title and icon parameter to the other shortcodes.\nThe visuals are now slightly different compared to previous versions. Most noteable, if you now display a single code block in a tab, its default styling will adapt to that of a code block but with a tab handle at the top.\nAdditionally the name parameter was renamed to title but you don’t need to change anything yet as the old name will be used as a fallback. Nevertheless you will get deprecation warnings while executing Hugo.\nNew The theme now optionally supports separate favicons for light \u0026 dark mode.",
"description": "5.16.0 (2023-06-10) Change Change The theme now provides warnings for deprecated or now unsupported features. The warnings include hints how to fix them and an additional link to the documentation.",
"tags": [],
"title": "Version 5.16",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/16/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.15.2 (2023-05-29) Enhancements [feature] taxonomy: add support for category default taxonomy #541 Fixes [bug] attachments: work for Hugo \u003c 0.112 #546 5.15.1 (2023-05-25) Fixes [bug] shortcodes: intermediately use random ids instead of .Ordinal #543 5.15.0 (2023-05-25) Enhancements [feature] tab: new shortcode to display single tab #538 [feature][change] tabs: treat groupid as unique if not set #537 [feature] expand: indent expanded content #536 [feature] notice: make boxes more prominent #535 Fixes [bug] attachments: fix build error since Hugo 0.112 #540 Maintenance [task] chore: update Mermaid to 9.4.3 #534 [task] mermaid: update to 10.2.0 #499",
"description": "5.15.2 (2023-05-29) Enhancements [feature] taxonomy: add support for category default taxonomy #541 Fixes [bug] attachments: work for Hugo \u003c 0.112 #546",
"tags": [],
"title": "Version 5.15",
"uri": "/hugo-theme-relearn/introduction/changelog/5/15/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.15.0 (2023-05-29) Change Change Restored compatibility with Hugo 0.112.0 or higher. This does not change the minimum required Hugo version.\nThe attachments shortcode has compatibility issues with newer Hugo versions. You must switch to leaf bundles or are locked to Hugo \u003c 0.112.0 for now.\nIt is planned to refactor the attchments shortcode in the future. This will make it possible to use the shortcode in branch bundles again but not in simple pages anymore. This will most likely come with a breaking change.\nChange The tabs shortcode has changed behavior if you haven’t set the groupid parameter.\nFormerly all tab views without a groupid were treated as so they belong to the same group. Now, each tab view is treated as it was given a unique id.\nNew New The already known tabshas a new friend the tab shortcode to make it easier to create a tab view in case you only need one single tab. Really handy if you want to flag your code examples with a language identifier.\nAdditionally for such a use case, the whitespace between a tab outline and the code is removed if only a single code block is contained.\nNew Besides the tag taxonomy the theme now also provides the category taxonomy out of the box and shows them in the content footer of each page.",
"description": "5.15.0 (2023-05-29) Change Change Restored compatibility with Hugo 0.112.0 or higher. This does not change the minimum required Hugo version.",
"tags": [],
"title": "Version 5.15",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/15/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.14.3 (2023-05-20) Fixes [bug] tags: show taxonomy toc for standard installation #533 5.14.2 (2023-05-20) Fixes [bug] tags: translate breadcrumb and title for taxonomy #532 5.14.1 (2023-05-20) No changelog for this release. 5.14.0 (2023-05-19) Enhancements [feature] tags: improve search index for tags #531 [feature] tags: increase readability of taxonomy pages #530 [feature] nav: make breadcrumb separator configurable #529 [feature] i18n: add translation for default taxonomies #528 [feature] theme: set appropriate defaults for all theme specific params #516 [feature] theme: allow to display tags below article #513 Fixes [bug] shortcode: make .context always a page #527",
"description": "5.14.3 (2023-05-20) Fixes [bug] tags: show taxonomy toc for standard installation #533",
"tags": [],
"title": "Version 5.14",
"uri": "/hugo-theme-relearn/introduction/changelog/5/14/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.14.0 (2023-05-20) New New The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.\nHugo’s default taxonmies tags and categories are already contained in the theme’s i18n files. If you have self-defined taxonomies, you can add translations by adding them to your own i18n files. If you don’t provide translations, the singualar and plural forms are taken as configured in your hugo.toml.\nNew To give you more flexibility in customizing your article layout a new partial content-header.html is introduced.\nThis came out of the requirement to customize the position of article tags, which by default are displayed above the title. A second requirement was to also show additional taxonomies not supported by the theme natively. While Hugo supports tags and categories by default, the theme only displays tags.\nSo how to adjust the position of tags starting from the theme’s default where tags are only shown above the title?\nHide tags above title: Overwrite content-header.html with an empty file. Show tags between title and content: Overwrite heading-post.html and add {{ partial \"tags.html\" . }} to it. Show tags below content: Overwrite content-footer.html and add {{ partial \"tags.html\" . }} to it. New The new parameter breadcrumbSeparator is now available in your hugo.toml to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything.",
"description": "5.14.0 (2023-05-20) New New The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.",
"tags": [],
"title": "Version 5.14",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/14/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.13.2 (2023-05-17) Fixes [bug] print: enable print for pages with _build options #522 5.13.1 (2023-05-16) Fixes [bug] openapi: allow toc to scroll page #526 5.13.0 (2023-05-14) Enhancements [feature][change] openapi: replace implementation with swagger-ui #523 Fixes [bug] variant: avoid leaking shadows in neon print style #524",
"description": "5.13.2 (2023-05-17) Fixes [bug] print: enable print for pages with _build options #522",
"tags": [],
"title": "Version 5.13",
"uri": "/hugo-theme-relearn/introduction/changelog/5/13/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.13.0 (2023-05-17) Change Change The swagger shortcode was deprecated in favor for the openapi shortcode. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the swagger shortcode in the next major release.\nAdditionally, the implemantion of this shortcode was switched from RapiDoc to SwaggerUI.",
"description": "5.13.0 (2023-05-17) Change Change The swagger shortcode was deprecated in favor for the openapi shortcode. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the swagger shortcode in the next major release.",
"tags": [],
"title": "Version 5.13",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/13/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.12.6 (2023-05-04) Enhancements [feature] theme: better HTML titles and breadcrumbs for search and tag pages #521 Fixes [bug] menu: avoid hiding of expander on hover when active item has children #520 [bug] menu: showVisitedLinks not working for some theme variants #518 [bug] theme: fix resource URLs for 404 page on subdirectories #515 5.12.5 (2023-03-28) Fixes [bug] expand: not properly exanded when used in bullet point list #508 5.12.4 (2023-03-24) Fixes [bug] theme: disableExplicitIndexURLs param is not working as expected #505 5.12.3 (2023-03-14) Fixes [bug] attachments: fix links if only one language is present #503 [bug] shortcodes: allow markdown for title and content #502 5.12.2 (2023-03-03) Fixes [bug] menu: fix state for alwaysopen=false + collapsibleMenu=false #498 5.12.1 (2023-02-26) Enhancements [feature] variant: add relearn bright theme #493 Fixes [bug] generator: fix setting of colors #494 5.12.0 (2023-02-24) Enhancements [feature] frontmatter: support VSCode Front Matter extension #481 [feature] theme: make expand and image ids stable #477 [feature] variant: set scrollbar color to dark for dark variants #471 [feature] i18n: add full RTL support #470 [feature] piratify: fix some quirks, arrr #469 [feature][change] theme: optimization for huge screen sizes #466 Fixes [bug] i18n: write code ltr even for rtl languages #492 [bug] anchor: fix link in FF when served from file system #482 [bug] shortcodes: don’t break build and render for invalid parameters #480 [bug] nav: restore scroll position on browser back #476 [bug] variant: avoid style leak for auto style #473 Maintenance [task] build: add imagebot #485",
"description": "5.12.6 (2023-05-04) Enhancements [feature] theme: better HTML titles and breadcrumbs for search and tag pages #521 Fixes [bug] menu: avoid hiding of expander on hover when active item has children #520 [bug] menu: showVisitedLinks not working for some theme variants #518 [bug] theme: fix resource URLs for 404 page on subdirectories #515",
"tags": [],
"title": "Version 5.12",
"uri": "/hugo-theme-relearn/introduction/changelog/5/12/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.12.0 (2023-05-04) Change Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed (again). While Internet Explorer 11 has issues in displaying it, the functionality still works. New New Support for the great VSCode Front Matter CMS extension which provides on-premise CMS capabilties to Hugo.\nThe theme provides Front Matter CMS snippets for its shortcodes. Currently only English and German is supported. Put a reference into your frontmatter.json like this\n​ frontmatter.json { ... \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] ... } New Support for languages that are written right to left (like Arabic) is now complete and extended to the menu, the top navigation bar and print. You can experience this in the pirate translation. This feature is not available in Internet Explorer 11.\nNew The scrollbars are now colored according to their variant color scheme to better fit into the visuals.",
"description": "5.12.0 (2023-05-04) Change Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed (again). While Internet Explorer 11 has issues in displaying it, the functionality still works. New New Support for the great VSCode Front Matter CMS extension which provides on-premise CMS capabilties to Hugo.",
"tags": [],
"title": "Version 5.12",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/12/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.11.2 (2023-02-07) Fixes [bug] tabs: nested tabs content is not displayed #468 5.11.1 (2023-02-06) Fixes [bug] variant: include missing theme-auto.css in distribution #467 5.11.0 (2023-02-05) Enhancements [feature] i18n: add Czech translation #455 [feature][change] lightbox: switch to CSS-only solution #451 [feature][change] variant: add support for prefers-color-scheme #445 [feature][change] expand: refactor for a11y #339 [feature][change] mermaid: make zoom configurable #144 Fixes [bug] swagger: avoid errors when using invalid rapi-doc fragment ids #465 [bug] search: fix oddities in keyboard handling #463 [bug] badge: fix text color for IE11 #462 [bug] mermaid: rerender graph if search term is present and variant is switched #460 [bug] tags: show tag on pages when tag has space #459 [bug] edit: remove double slash on root page link #450 Maintenance [task] build: add moving version tags #453 [task][change] theme: remove jQuery #452 [task] build: check for release notes before release #448",
"description": "5.11.2 (2023-02-07) Fixes [bug] tabs: nested tabs content is not displayed #468",
"tags": [],
"title": "Version 5.11",
"uri": "/hugo-theme-relearn/introduction/changelog/5/11/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.11.0 (2023-02-07) Change Change The theme removed the popular jQuery library from its distribution.\nIn case you made changes to the theme that are depending on this library you can place a copy of jQuery into your static/js directory and load it from your own layouts/partials/custom-header.html like this:\n​ layouts/partials/custom-header.html \u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Mermaid diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.\nThe default setting of on, in effect since 1.1.0, changed back to off as there was interference with scrolling on mobile and big pages.\nChange The theme is now capable to visually adapt to your OS’s light/dark mode setting.\nThis is also the new default setting if you haven’t configured themeVariant in your hugo.toml.\nAdditionally you can configure the variants to be taken for light/dark mode with the new themeVariantAuto parameter.\nThis is not supported for Internet Explorer 11, which still displays in the relearn-light variant.\nChange The JavaScript code for handling image lightboxes (provided by Featherlight) was replaced by a CSS-only solution.\nThis also changed the lightbox effects parameter from featherlight=false to lightbox=false. Nevertheless you don’t need to change anything as the old name will be used as a fallback.\nChange In the effort to comply with WCAG standards, the implementation of the expand shortcode was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works.\nNew New Translation into Czech. This language is not supported for search.\nNew GitHub releases are also now tagged for the main version (eg. 1.2.x), major version (eg. 1.x) and the latest (just x) release making it easier for you to pin the theme to a certain version.",
"description": "5.11.0 (2023-02-07) Change Change The theme removed the popular jQuery library from its distribution.",
"tags": [],
"title": "Version 5.11",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/11/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.10.2 (2023-01-25) Fixes [bug] nav: fix breadcrumb for huge installations #446 5.10.1 (2023-01-25) Fixes [bug] print: fix image links with relative path #444 5.10.0 (2023-01-25) Enhancements [feature] shortcodes: support for accent color #440 [feature] shortcodes: add color parameter where applicable #438 [feature] theme: announce translations as alternate links #422 Fixes [bug] nav: fix breadcrumbs for deeply nested sections #442 [bug] theme: improve whitespacing in tables #441",
"description": "5.10.2 (2023-01-25) Fixes [bug] nav: fix breadcrumb for huge installations #446",
"tags": [],
"title": "Version 5.10",
"uri": "/hugo-theme-relearn/introduction/changelog/5/10/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.10.0 (2023-01-25) New New The attachments, badge, button and notice shortcodes have a new parameter color to set arbitrary CSS color values.\nAdditionally the --ACCENT-color brand color introduced in version 5.8.0 is now supported with these shortcodes.",
"description": "5.10.0 (2023-01-25) New New The attachments, badge, button and notice shortcodes have a new parameter color to set arbitrary CSS color values.",
"tags": [],
"title": "Version 5.10",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/10/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigation respect ordersectionsby configuration #170 2.9.4 (2022-02-06) Fixes [bug] exampleSite: fix links in official documentation #168 2.9.3 (2022-02-06) Fixes [bug] menu: invalid URL when the shortcut is an internal link #163 2.9.2 (2021-11-26) Enhancements [feature] theme: add theme version info to head #158 Fixes [bug] theme: fix selection of *.ico files as favicons #160 2.9.1 (2021-11-22) Fixes [bug] menu: fix significantly low performance for collecting of meta info #157 2.9.0 (2021-11-19) Fixes [bug][breaking] relref: fix inconsistent behavior #156 [bug] search: make dropdown stick to search field when scrolling #155 [bug] menu: align long text properly #154 [bug] copyToClipBoard: add missing right border for inline code if disableInlineCopyToClipBoard=true #153 [bug] menu: show hidden sibling pages reliably #152 [bug] menu: bring active item in sight for large menus #149",
"description": "2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigation respect ordersectionsby configuration #170",
"tags": [],
"title": "Version 2.9",
"uri": "/hugo-theme-relearn/introduction/changelog/2/9/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.9.0 (2021-11-19) Breaking Breaking This release removes the themes implementation of ref/relref in favor for Hugo’s standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.\nIn a standard compliant form you must not link to the *.md file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:\nType Non-Standard Standard Branch bundle configuration/reference/_index.md configuration/reference Leaf bundle configuration/reference/index.md configuration/reference Page configuration/reference.md configuration/reference If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but Hugo got you covered as well.\nAlso, the old themes implementation allowed refs to non-existing content. This will cause Hugo’s implementation to show the error below and abort the generation. If your project relies on this old behavior, you can reconfigure the error handling of Hugo’s implementation.\nIn the best case your usage of the old implementation is already standard compliant and you don’t need to change anything. You’ll notice this very easily once you’ve started hugo server after an upgrade and no errors are written to the console.\nYou may see errors on the console after the update in the form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"configuration/reference/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": page not found In this case, you must apply one of two options:\nStart up a text editor with regular expression support for search and replace. Search for (ref\\s+\"[^\"]*?)(?:/_index|/index)?(?:\\.md)?(#[^\"]*?)?\" and replace it by $1$2\" in all *.md files. This is the recommended choice.\nCopy the old implementation files theme/hugo-theme-relearn/layouts/shortcode/ref.html and theme/hugo-theme-relearn/layouts/shortcode/relref.html to your own projects layouts/shortcode/ref.html and layouts/shortcode/relref.html respectively. This is not recommended as your project will still rely on non-standard behavior afterwards.",
"description": "2.9.0 (2021-11-19) Breaking Breaking This release removes the themes implementation of ref/relref in favor for Hugo’s standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.",
"tags": [],
"title": "Version 2.9",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/9/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.9.4 (2023-01-23) Fixes [bug] variant: fix search icon and text color #437 5.9.3 (2023-01-22) Fixes [bug] nav: fix left/right navigation for horizontal scrolling #435 [bug][breaking] theme: allow pages on top level #434 Maintenance [task] build: switch to wildcard version of actions #428 5.9.2 (2022-12-30) Fixes [bug] search: apply dependency scripts for Hindi and Japanese #427 5.9.1 (2022-12-23) Enhancements [feature] theme: make external link target configurable #426 5.9.0 (2022-12-23) Enhancements [feature][change] theme: open external links in separate tab #419 [feature] theme: make it a Hugo module #417 Fixes [bug][change] attachments: fix incorrect links for defaultContentLanguageInSubdir=true #425",
"description": "5.9.4 (2023-01-23) Fixes [bug] variant: fix search icon and text color #437",
"tags": [],
"title": "Version 5.9",
"uri": "/hugo-theme-relearn/introduction/changelog/5/9/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.9.0 (2022-12-23) Breaking Breaking With this version it is now possible to not only have sections on the first menu level but also pages.\nIt was later discovered, that this causes pages only meant to be displayed in the More section of the menu and stored directly inside your content directory to now show up in the menu as well.\nTo get rid of this undesired behavior you have two choices:\nMake the page file a headless branch bundle (contained in its own subdirectory and called _index.md) and add the following front matter configuration to the file (see exampleSite’s content/showcase/_index.en.md). This causes its content to not be ontained in the sitemap.\n​ toml yaml json +++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++ --- _build: list: never publishResources: true render: always title: Showcase --- { \"_build\": { \"list\": \"never\", \"publishResources\": true, \"render\": \"always\" }, \"title\": \"Showcase\" } Store the page file for below a parent headless branch bundle and add the following front matter to he parent (see exampleSite’s content/more/_index.en.md). Don’t give this page a title as this will cause it to be shown in the breadcrumbs - a thing you most likely don’t want.\n​ toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s content/more/credits.en.md). This causes its content to be contained in the sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } Change Change The required directory name for the attachments shortcode was changed for leaf bundles.\nPreviously, the attachments for leaf bundles in non-multilang setups were required to be in a files subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnecessary complexity. So attachments for leaf bundles in non-multilang setups can now also reside in a index.files directory. Although the old files directory is now deprecated, if both directories are present, only the old files directory will be used for compatibility.\nChange Absolute links prefixed with http:// or https:// are now opened in a separate browser tab.\nYou can revert back to the old behavior by defining externalLinkTarget=\"_self\" in the params section of your hugo.toml.\nNew New The theme now supports Hugo’s module system.",
"description": "5.9.0 (2022-12-23) Breaking Breaking With this version it is now possible to not only have sections on the first menu level but also pages.",
"tags": [],
"title": "Version 5.9",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/9/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset to initial size #145 [bug] mermaid: remove whitespace from big graphs #143 2.8.2 (2021-11-08) Fixes [bug] mermaid: always load javascript to avoid break if code fences are used #142 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS in multilang setup if search is disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally available via config.toml #133 [feature] mermaid: only load javascript if necessary #95 [feature][change] theme: switch font #83 [feature] theme: make favicon configurable #2 Fixes [bug] mermaid: assert that window.mermaid is actually mermaid #136 [bug] menu: remove usage of Hugo’s UniqueID #131 [bug] theme: reduce margin for children shortcode #130 [bug] theme: left-align h3 in chapters #129 [bug] theme: align copy link to clipboard #128",
"description": "2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset to initial size #145 [bug] mermaid: remove whitespace from big graphs #143",
"tags": [],
"title": "Version 2.8",
"uri": "/hugo-theme-relearn/introduction/changelog/2/8/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.8.0 (2021-11-03) Change Change Although never officially documented, this release removes the font Novacento/Novecento. If you use it in an overwritten CSS please replace it with Work Sans. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for Czech. New New The theme now supports favicons served from static/images/ named as favicon or logo in SVG, PNG or ICO format out of the box. An overridden partial layouts/partials/favicon.html may not be necessary anymore in most cases.\nNew You can hide the table of contents menu for the whole site by setting the disableToc option in your hugo.toml. For an example see the example configuration.",
"description": "2.8.0 (2021-11-03) Change Change Although never officially documented, this release removes the font Novacento/Novecento. If you use it in an overwritten CSS please replace it with Work Sans. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for Czech. New New The theme now supports favicons served from static/images/ named as favicon or logo in SVG, PNG or ICO format out of the box. An overridden partial layouts/partials/favicon.html may not be necessary anymore in most cases.",
"tags": [],
"title": "Version 2.8",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/8/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.8.1 (2022-12-11) Fixes [bug] theme: fix alias for home page if defaultContentLanguageInSubdir=true #414 5.8.0 (2022-12-08) Enhancements [feature] icon: add new shortcode #412 [feature] theme: style and document markdown extensions #411 [feature] badge: add new shortcode #410 [feature] theme: add accent color #409 Fixes [bug] theme: fix spacing for tag flyout in FF #413",
"description": "5.8.1 (2022-12-11) Fixes [bug] theme: fix alias for home page if defaultContentLanguageInSubdir=true #414",
"tags": [],
"title": "Version 5.8",
"uri": "/hugo-theme-relearn/introduction/changelog/5/8/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.8.0 (2022-12-08) New New The new badge shortcode is now available to add highly configurable markers to your content as you can see it on this page.\nNew The new icon shortcode simplyfies the usage of icons. This can even be combined with also new badge shortcode.\nNew The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely task lists, defintion lists and footnotes.\nNew A new color --ACCENT-color was introduced which is used for highlighting search results on the page. In case you simply don’t care, you don’t need to change anything in your variant stylesheet as the old yellow color is still used as default.",
"description": "5.8.0 (2022-12-08) New New The new badge shortcode is now available to add highly configurable markers to your content as you can see it on this page.",
"tags": [],
"title": "Version 5.8",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/8/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.7.0 (2021-10-24) Enhancements [feature] notice: support custom titles #124",
"description": "2.7.0 (2021-10-24) Enhancements [feature] notice: support custom titles #124",
"tags": [],
"title": "Version 2.7",
"uri": "/hugo-theme-relearn/introduction/changelog/2/7/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.7.0 (2021-10-24) New New Optional second parameter for notice shortcode to set title in box header.",
"description": "2.7.0 (2021-10-24) New New Optional second parameter for notice shortcode to set title in box header.",
"tags": [],
"title": "Version 2.7",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/7/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.7.0 (2022-11-29) Enhancements [feature] button: refactor for a11y #372 Fixes [bug] search: don’t freeze browser on long search terms #408 [bug] search: fix searchbox placeholder color in FF and IE #405 [bug][change] i18n: rename Korean translation from country to lang code #404 Maintenance [task] search: update lunr languages to 1.10.0 #403",
"description": "5.7.0 (2022-11-29) Enhancements [feature] button: refactor for a11y #372 Fixes [bug] search: don’t freeze browser on long search terms #408 [bug] search: fix searchbox placeholder color in FF and IE #405 [bug][change] i18n: rename Korean translation from country to lang code #404 Maintenance [task] search: update lunr languages to 1.10.0 #403",
"tags": [],
"title": "Version 5.7",
"uri": "/hugo-theme-relearn/introduction/changelog/5/7/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.7.0 (2022-11-29) Change Change The Korean language translation for this theme is now available with the language code ko. Formerly the country code kr was used instead. New New The button shortcode can now also be used as a real button inside of HTML forms - although this is a pretty rare use case. The documentation was updated accordingly.\nNew The search now supports the Korean language.",
"description": "5.7.0 (2022-11-29) Change Change The Korean language translation for this theme is now available with the language code ko. Formerly the country code kr was used instead. New New The button shortcode can now also be used as a real button inside of HTML forms - although this is a pretty rare use case. The documentation was updated accordingly.",
"tags": [],
"title": "Version 5.7",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/7/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "7.1.0 (2024-10-24) Enhancements [feature][change] children: use LinkTitle instead of Title #939 [feature][change] menu: support nested Hugo menus #423 [feature] menu: support for external links #148 Fixes [bug] search: wrong searchindex URL with multilang per server config #940 7.0.1 (2024-10-15) Fixes [bug] search: search page not generated with renderer.unsafe #929 7.0.0 (2024-10-13) Enhancements [feature][change] logo: move Relearn logo to exampleSite #924 [feature][change] math: adhere to Hugo’s default config params #923 [feature][change] theme: replace font #922 [feature][breaking] theme: reduce build time #685 Fixes [bug] theme: remove duplicate path warning #926 Maintenance [task] theme: remove author deprecation warning #919 [task] theme: remove deprecation waring for usage of .Sites.First #912 [task][breaking] theme: restructure code #891 [task][breaking] search: improve generation of dedicated search page #888 [task] theme: remove warning for usage of .Site.IsMultiLingual #877 [task][breaking] roadmap: upcoming major changes for 7.0.0 #715",
"description": "7.1.0 (2024-10-24) Enhancements [feature][change] children: use LinkTitle instead of Title #939 [feature][change] menu: support nested Hugo menus #423 [feature] menu: support for external links #148 Fixes [bug] search: wrong searchindex URL with multilang per server config #940",
"tags": [],
"title": "Version 7",
"uri": "/hugo-theme-relearn/introduction/changelog/7/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "7.1.0 (2024-10-24) Change Change The sidebar menus are now completely configurable.\nThis is provided by the new parameter sidebarmenus. With the new system, you can\nshow arbitrary amounts of menus set headings for each menu base it on your page structure or use Hugo’s menu feature configure a starting page if a menu is based on page structure display unlimited nesting for both menu types reconfigure the menus in a page’s front matter apply the usual parameter alwaysopen, collapsibleMenu, etc. for all menu types You don’t need to change anything in your existing installation as the old configuration is used as a default.\nChange The children shortcode was changed to output a page’s LinkTitle instead of previously using the Title.\nAs the shortcode always outputs subpages in context of the parent page, it functions similar to the sidebar menu. The sidebar menu itself uses the LinkTitle for naming the menu entries and so should the shortcode do.\nThe parameter value sort=linktitle was deprecated for the easier sort=title. You can still use the old value but both behave the same way in sorting by LinkTitle.\nNew New Menus created by your page structure are now able to contain arbitrary links inserted into the structure using the menuUrl or menuPageRef front matter. 7.0.0 (2024-10-15) Hugo 0.126.0 0.126.0 This release requires a newer Hugo version. Breaking Breaking This release comes with significant changes in file naming of partials and how the theme works internally. This was done because the theme\nsuffered from poor build performance for sites with 1000 or more pages reinvented the wheel instead of using available Hugo mechanisms What do I gain, you may ask. A significant performance boost during build! Usually, the build time has been cut at least in half for bigger sites. It is now possible to build even larger sites with 5000 or more pages. This was previously almost impossible due to rapidly increasing build time with the more pages you’ve introduced. For even bigger sites, the theme now has configurable performance optimizations - at the price of feature limitations.\nIf you haven’t done customizations to any partials, you can update right away.\nIf you have customized your templates, in the best cases, you will get build warnings or even errors. In the worst cases, your build succeeds but the site will not work as intended by you.\nSpecifically, you will have to adapt your site if you have\noverwritten the header.html, menu.html or footer.html partials self-defined output formats self-defined archetype partials in layouts/partials/archetypes - now becoming page designs overwritten prev/next topbar buttons - needs sync with implementation changes Breaking This release changes the way the search index and the dedicated search page are generated. This may require reconfiguration by you to still work as you have intended.\nYou need to remove the now obsolete search and searchpage output format from [outputs.home] in your hugo.toml, resulting in something similar to\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'print'] outputs: home: - html - rss - print { \"outputs\": { \"home\": [ \"html\", \"rss\", \"print\" ] } } After that, your build will succeed but will most likely cause new defaults to be applied. With no further settings, in-page search, search popup and dedicated search page are all active by default. This can be reconfigured.\nIn addition, you are now able to overwrite the default file name of the search index and the default page name of the dedicated search page by changing searchIndexURL and searchPageURL respectively in your hugo.toml.\nSee the updated documentation for reference.\nChange Change Once again, the theme changed the font. We switched to the excellent Roboto Flex font.\nCare was taken to configure the font to look similar to the previously used Work Sans. Nevertheless, in direct comparison, you will see slight differences in appearance.\nThis change was necessary as the previously used font had display issues with marked text, contrast, and some other minor stuff. As an aftermath, the number of requests and the download size were decreased when loading a page.\nThe font was created by Google, is licensed under OFL 1.1 and is delivered from your theme’s installation. As always, no third-party server calls are involved.\nIf you have changed the font-family in your installation, you most likely have to adjust the variables --MAIN-font-weight, --MAIN-BOLD-font-weight and --MAIN-letter-spacing.\nAdditionally, if you have changed the font to a variable font in your installation, you may have to adjust the variable --MAIN-font-variation-settings. As this only applies to variable fonts, this should rarely be necessary.\nChange While switching the font, it was discovered that certain CSS variables were falsely named. You don’t need to change anything in your custom variant stylesheet as the old names will be used as a fallback.\n--MAIN-TITLES-TEXT-font was renamed to --MAIN-TITLES-font, --MAIN-TITLES-H\u003cn\u003e-color was renamed to --MAIN-TITLES-H\u003cn\u003e-TEXT-color.\nChange The options and front matter to force loading a math, mermaid or openapi library has been changed.\nPreviously, you had to set the unintuitive disableMathJax=false to force load the math library in case of a passthrough configuration. This is replaced by the simpler math=true or math.force=true and is now in line with Hugo’s official documentation.\nYou don’t need to change anything yet but will receive warnings if the old settings are used.\nChange The default logo is not contained inside of the theme’s logo partial anymore.\nThis is to avoid usage of the theme’s branding throughout the web in non-modified installations.\nIn addition, the default text for the logo partial is now taken from the linkTitle setting of your hugo.toml.\nNew New The docs received a much-needed overhaul for all chapters.\nBasically, the structure was reorganized, giving each topic its own page while keeping the amount of items for each menu level comprehensible by adding sub-pages.\nThe docs now clearly differentiate between configuration of your site, all things writing page content and the shortcodes docs that cover both topics, configuration and usage.\nTo give you a better overview of what’s possible with the theme, we introduced reference pages for all theme configuration options and front matter and mark each occurrence of such on all pages with the badges Option and Front Matter.\nAlso, a lot of previously undocumented features are now included, namely\nthe hidden pages feature options of the menus configuring breadcrumb, titles and headings of your content options for using links adding custom output formats",
"description": "7.1.0 (2024-10-24) Change Change The sidebar menus are now completely configurable.",
"tags": [],
"title": "Version 7",
"uri": "/hugo-theme-relearn/introduction/releasenotes/7/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.6.0 (2021-10-21) Fixes [bug] theme: generate correct links if theme served from subdirectory #120",
"description": "2.6.0 (2021-10-21) Fixes [bug] theme: generate correct links if theme served from subdirectory #120",
"tags": [],
"title": "Version 2.6",
"uri": "/hugo-theme-relearn/introduction/changelog/2/6/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.6.0 (2021-10-21) New New Your site can now be served from a subdirectory if you set baseURL in your hugo.toml. See the documentation for a detailed example.",
"description": "2.6.0 (2021-10-21) New New Your site can now be served from a subdirectory if you set baseURL in your hugo.toml. See the documentation for a detailed example.",
"tags": [],
"title": "Version 2.6",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/6/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.6.6 (2022-11-23) Enhancements [feature] search: make build and js forgiving against config errors #400 Fixes [bug] variant: minor color adjustments #402 [bug] variant: fix generator for use of neon #401 5.6.5 (2022-11-19) Fixes [bug] menu: relax usage of background color #399 5.6.4 (2022-11-19) Fixes [bug] theme: make alias pages usable by file:// protocol #398 5.6.3 (2022-11-19) Fixes [bug] theme: be compatible with Hugo \u003e= 0.95.0 #397 5.6.2 (2022-11-19) Fixes [bug] theme: build breaks sites without “output” section in config #396 5.6.1 (2022-11-19) Fixes [bug] theme: fix image distortion #395 5.6.0 (2022-11-18) Enhancements [feature] toc: improve keyboard handling #390 [feature] search: improve keyboard handling #387 [feature] search: add dedicated search page #386 [feature] theme: make creation of generator meta tag configurable #383 [feature] theme: increase build performance #380 Fixes [bug] mermaid: avoid leading whitespace #394 [bug] theme: fix build errors when referencing SVGs in markdown #393 [bug] variant: avoid neon to leak into IE11 fallback #392 [bug] theme: fix urls for file:// protocol in sitemap #385 [bug] theme: add id to h1 elements #384 [bug] rss: fix display of hidden subpages #382 [bug] nav: fix key navigation when pressing wrong modifiers #379 Maintenance [task] mermaid: update to version 9.2.2 #391",
"description": "5.6.6 (2022-11-23) Enhancements [feature] search: make build and js forgiving against config errors #400 Fixes [bug] variant: minor color adjustments #402 [bug] variant: fix generator for use of neon #401",
"tags": [],
"title": "Version 5.6",
"uri": "/hugo-theme-relearn/introduction/changelog/5/6/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.6.0 (2022-11-18) New New This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning through large number of results.\nTo activate this feature, you need to configure it in your hugo.toml as a new outputformat searchpage for the home page. If you don’t configure it, no dedicated search page will be accessible and the theme works as before.\nYou can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.\nNew Keyboard handling for the TOC and search was improved.\nPressing CTRL+ALT+t now will not only toggle the TOC overlay but also places the focus to the first heading on opening. Subsequently this makes it possible to easily select headings by using the TAB key.\nThe search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus the cursor inside of the search box so you can immediately start your search by typing.\nNew You are now able to turn off the generation of generator meta tags in your HTML head to hide the used versions of Hugo and this theme.\nTo configure this in your hugo.toml make sure to set Hugo’s disableHugoGeneratorInject=true and also [params] disableGeneratorVersion=true, otherwise Hugo will generate a meta tag into your home page automagically.\nNew Creation of your project gets a little bit faster with this release.\nThis addresses increased build time with the version 5 releases. The theme now heavily caches partial results leading to improved performance. To further increase performance, unnecessary parts of the page are now skipped for creation of the print output (eg. menus, navigation bar, etc.).",
"description": "5.6.0 (2022-11-18) New New This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning through large number of results.",
"tags": [],
"title": "Version 5.6",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/6/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "6.4.1 (2024-10-11) Fixes [bug] highlight: remove additional newlines from code if copied from cursor selection #925 6.4.0 (2024-09-12) Enhancements [feature] notice: support user defined box styles #913 [feature] frontmatter: add expanded parameter for shortcodes #911 [feature] resources: add expanded parameter #908 [feature][change] notice: collapse borders if single code block is displayed #906 Fixes [bug] include: don’t erroneously remove headings if hidefirstheading=true #914 Maintenance [task] build: add link for migration into changelog #915 [task] shortcodes: fix whitespace issues #907 6.3.0 (2024-09-03) Enhancements [feature] theme: support Obsidian styled alerts #903 [feature] notice: add expander to box title #901 Fixes [bug] children: fix sort parameter #898 [bug] mermaid: classDiagram breaks when using «interface» #895 [bug] toc: don’t show toc button if empty #893 Maintenance [task] mermaid: update to 11.1.0 #904 [task][change] expand: rename open parameter to expanded #902 [task] i18n: update Arabic translation #900 6.2.0 (2024-08-26) Enhancements [feature][change] anchor: add option to scroll into view #886 [feature] theme: support for GitHub styled alerts #885 Fixes [bug] arrownav: avoid rude event handling for form elements #887 Maintenance [task] 404: move styles to separate file #889 6.1.1 (2024-08-02) Fixes [bug] link: link resolving stopped working in certain configurations #882 6.1.0 (2024-08-02) Enhancements [feature][change] assetbuster: use asset buster for all resources #875 [feature] theme: sync to Hugo changes for PublishDate #872 [feature] theme: allow errorlevel override on page level #870 [feature] relref: provide shortcodes to lift certain restrictions #864 [feature] openapi: adjust to Hugo’s build-in link render hook #860 [feature][change] include: adjust to Hugo’s build-in link render hook #859 Fixes [bug] variant: auto variant references potentially wrong chroma style #873 [bug] schema: sync to Hugo changes for LanguageCode #866 [bug] taxonomy: simplify code #852 [bug] alias: index.html has displays error in content #851 Maintenance [task] icon: update Font Awesome to 6.6.0 #881 [task] math: update MathJax to 3.2.2 #880 [task] openapi: update swagger-ui to 5.17.14 #879 [task] mermaid: update to 10.9.1 #878 [task] theme: remove special cases for LanguageCode #861 [task] link: adjust to Hugo’s build-in code #858 [task] image: adjust to Hugo’s build-in code #857 [task] opengraph: sync to Hugo’s implementation #856 [task] i18n: improve file naming #848 6.0.0 (2024-04-27) Enhancements [feature][breaking] theme: unify description #845 [feature] schema: add schema support in meta data #844 [feature] include: use Hugo’s resources #835 [feature] math: allow to work with Hugo’s passthrough configuration #832 [feature] i18n: add Romanian translation #828 [feature][breaking] menu: remove menuTitle frontmatter #714 [feature][breaking] theme: end support for Internet Explorer 11 #584 Fixes [bug] frontmatter: move frontmatter config for exampleSite out of root #843 [bug] images: color outline using primary color #838 [bug][breaking] variant: avoid Hugo permission errors on build #831 [bug] theme: unwanted paragraph break with AsciiDoc #829 Maintenance [task][breaking] swagger: remove shortcode #847 [task][breaking] search: remove JSON outputformat for search index #846 [task] theme: sync to Hugo’s implementation #841 [task][change] fontawesome: update to 6.5.2 #834",
"description": "6.4.1 (2024-10-11) Fixes [bug] highlight: remove additional newlines from code if copied from cursor selection #925",
"tags": [],
"title": "Version 6",
"uri": "/hugo-theme-relearn/introduction/changelog/6/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "6.4.0 (2024-10-11) Change Change If you now display a single code block in a notice box, its margin and border will be removed so only the colored notice border is visible. New New It is now possible to have user-defined styles for all shortcodes that accept the style parameter. See the notice shortcode for configuration.\nNew The resources shortcode has a new parameter expanded to make the resource list collapsible. 6.3.0 (2024-09-03) Change Change The expand shortcode changed the naming of the open parameter to expanded. You don’t need to change anything yet but may get deprecation warnings.\nChange If the content for the notice shortcode is empty, now only the title bar will be displayed. Previously an empty content box was displayed.\nNew New The notice shortcode has a new parameter expanded to make the content collapsible.\nNew If you are running Hugo 0.134.0 or later, the theme now supports Obsidian callouts.\nNew The theme has updated its Mermaid dependency to 11.1.0. This adds support for packet and architecture diagrams. 6.2.0 (2024-08-26) Change Change The heading anchor links are extended in functionality.\nIf you now click on it, not only is the link copied to the clipboard (previous behavior) but also the heading scrolls to the top of the page.\nIf you dislike the new behavior, you can deactivate it by setting disableAnchorScrolling=true in your hugo.toml. See the docs for further options.\nNew New If you are running Hugo 0.132.0 or later, the theme is now capable to print GitHub alerts.\nNew To support new severity levels for GitHub alerts, all shortcodes that support severity levels with their style parameter were expanded with the new severities caution and important and the color parameter was expanded with cyan and magenta. Please note, that coloring and icons of severities may defer from the display you see on GitHub.\nNew To support new severity levels for GitHub alerts, the new severities and their according colors are also available as CSS variables BOX-MAGENTA-color, BOX-MAGENTA-TEXT-color, BOX-CAUTION-color, BOX-CAUTION-TEXT-color, BOX-CYAN-color, BOX-CYAN-TEXT-color, BOX-IMPORTANT-color, BOX-IMPORTANT-TEXT-color. You don’t need to change anything in your custom color stylesheet as appropriate default colors will be used. 6.1.0 (2024-08-02) Change Change The include shortcode is now able to resolve links to pages as well as resources or files in the file system (the old behavior).\nChange To make the asset buster mechanism more robust, some internally used stylesheets where restructured. This generally should not affect your page in any negative way.\nNew New The openapi shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting openapi.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.\nNew Shortcodes supporting an errorlevel configuration can now have overridden values in the front matter section of each individual page.\nNew The theme now comes with its own overridden version of the relref shortcode.\nWhile the usage of relref is obsolete and discouraged by Hugo for a while, existing installations may use it. In configurations using a baseURL with a subdirectory, and having relativeURLs=false (the default) Hugo’s standard relref implementation was failing.\nThe shortcode is deactivated by default and can be activated by setting\nhugo. toml yaml json [params] disableDefaultRelref = true params: disableDefaultRelref: true { \"params\": { \"disableDefaultRelref\": true } } in your hugo.toml. Only do this if your site fulfills all of the above assumptions. 6.0.0 (2024-04-27) Breaking Breaking This release requires you to move your self-defined variant (theme-*.css) and chroma stylesheets (chroma-*.css) from static/css to assets/css.\nThis was necessary to avoid permission errors on build if running in certain Unix configurations.\nIn addition it is not allowed anymore to @import your chroma stylesheet from inside of your variant stylesheet.\nSay, your chroma stylesheet is named chroma-monokai.css, you have to add the following inside your variant stylesheet:\n--CODE-theme: monokai; Breaking The parameter description in your hugo.toml will now be ignored.\nWith the newly introduced unified handling of descriptions throughout the theme, the only place the old parameter would have been used was your home page.\nFor migration, move the description parameter of your hugo.toml into the front matter section of your home page.\nBreaking Search support for the json outputformat deprecated in 5.4.0 was removed.\nChange it to search for the homepage in your hugo.toml. See the docs for detailed configuration.\nBreaking The front matter option menuTitle deprecated in 5.24.0 was removed in favor for Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead of title to generate the breadcrumb.\nBreaking The swagger shortcode deprecated in 5.13.0 was removed in favor for the openapi shortcode with the same set of parameter.\nBreaking Support for Internet Explorer 11 was finally dropped.\nChange Change With the removal of support for Internet Explorer 11, Font Awesome was upgraded to version 6.5.2.\nYou may experience slight changes for some icons. In addition you have additional ~1700 icons to chose from.\nChange The children shortcode was fixed to adhere to its documentation, generating the description based on this rule: When no description or summary exists for the page, the first 70 words of the content is taken.\nPreviously, the summary erroneously was ignored which now can lead to different output if you set description=true as a parameter.\nNew New The include shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting include.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.\nNew Math is now usable without enclosing it in a shortcode or Markdown codefence by using Hugo’s passthrough configuration.\nNew Translation into Romanian.",
"description": "6.4.0 (2024-10-11) Change Change If you now display a single code block in a notice box, its margin and border will be removed so only the colored notice border is visible. New New It is now possible to have user-defined styles for all shortcodes that accept the style parameter. See the notice shortcode for configuration.",
"tags": [],
"title": "Version 6",
"uri": "/hugo-theme-relearn/introduction/releasenotes/6/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.5.1 (2021-10-12) Fixes [bug] security: fix XSS for malicious image URLs #117 2.5.0 (2021-10-08) Enhancements [feature][change] syntax highlight: provide default colors for unknown languages #113 Fixes [bug] security: fix XSS for malicious URLs #114 [bug] menu: write correct local shortcut links #112",
"description": "2.5.1 (2021-10-12) Fixes [bug] security: fix XSS for malicious image URLs #117",
"tags": [],
"title": "Version 2.5",
"uri": "/hugo-theme-relearn/introduction/changelog/2/5/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.5.0 (2021-10-08) Change Change New colors --CODE-BLOCK-color and --CODE-BLOCK-BG-color were added to provide a fallback for Hugo’s syntax highlighting in case no language was given or the language is unsupported. Ideally the colors are set to the same values as the ones from your chosen chroma style.",
"description": "2.5.0 (2021-10-08) Change Change New colors --CODE-BLOCK-color and --CODE-BLOCK-BG-color were added to provide a fallback for Hugo’s syntax highlighting in case no language was given or the language is unsupported. Ideally the colors are set to the same values as the ones from your chosen chroma style.",
"tags": [],
"title": "Version 2.5",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/5/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo’s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use .LinkTitle instead of .Title if available #816 Fixes [bug] scrollbar: scroll bar in side menu gets stuck in dragged state on mobile #808 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.11.10 #798 [task] mermaid: update to 10.9.0 #797 5.25.0 (2024-02-29) Enhancements [feature][change] theme: print out GitInfo in page footer if configured #786 [feature][change] resources: new shortcode to deprecate attachments shortcode #22 Fixes [bug] swagger: fix compat warning #787 5.24.3 (2024-02-28) Fixes [bug] theme: avoid crash on 404 if author settings want to warn #785 5.24.2 (2024-02-24) Enhancements [feature] image: adjust to Hugo 0.123 #777 Fixes [bug] link: resolve fragments #775 5.24.1 (2024-02-18) Enhancements [feature] link: make resolution reporting configurable #774 5.24.0 (2024-02-17) Enhancements [feature] theme: compatibility with Hugo 0.123 #771 [feature] topbar: support editURL in frontmatter #764 [feature] menu: use –MENU-WIDTH-S to adjust mobile flyout #761 [feature] figure: support built-in shortcode #746 [feature] theme: make heading a template #744 [feature] taxonomy: make arrow nav browse through terms #742 [feature] theme: switch from config.toml to hugo.toml #741 [feature] button: make non-interactive if used as mock #740 [feature][change] topbar: allow text for button #739 [feature] theme: run hugo demo site without warning #736 [feature] menu: make swipe handler passive #735 [feature] i18n: support standard Hugo options #733 [feature] a11y: show tab focus on images #730 [feature] a11y: improve discovering links on keyboard navigation #726 [feature][change] variant: increase contrast for light themes #722 [feature] theme: break build if minimum Hugo version is not matched #719 [feature] taxonomy: humanize term on missing term title #713 Fixes [bug] taxonomy: display translated title #772 [bug] highlight: fix codefence syntax in Hugo \u003e= 0.121.0 #749 [bug] link: fix links to pages containing dots in their name #748 [bug] image: get resource images if link is prefixed with ./ #747 [bug] theme: switch dependency colors on OS color scheme change #745 [bug] clipboard: fix O(n²) buttons #738 [bug] button: fix whitespacing in FF #737 [bug] i18n: fix warning messages for zh-CN #732 [bug] mermaid: fix zoom button #725 [bug] theme: fix JS errors on hugo --minifiy #724 [bug] include: fix whitespacing in codefences #723 5.23.2 (2023-11-03) Enhancements [feature] taxonomy: improve taxonomy page #712 [feature] taxonomy: warn on missing term title #709 Fixes [bug] taxonomy: fix sorting of terms on content pages #710 5.23.1 (2023-10-30) Enhancements [feature] taxonomy: improve term page #705 Fixes [bug] variant: fix typo in chroma-learn.css #708 [bug] links: ignore local markdown links linking to files with extension #707 5.23.0 (2023-10-29) Enhancements [feature] taxonomy: allow for content on term pages #701 [feature] theme: write full file path on warnings #699 [feature] theme: show anchor link and copy to clipboard button on mobile #697 [feature][change] config: adjust to changes in Hugo 0.120 #693 [feature] variants: add more contrast to neon #692 [feature] mermaid: only show zoom reset button if zoomed #691 [feature] menu: add additional sort options #684 [feature] theme: add social media meta information #683 [feature] theme: simplify additional JS dependencies #682 [feature] links: warn if ref/relref is used falsly #681 [feature] menu: make width configurable #677 [feature] tabs: use color for link of inactive tabs #675 [feature] taxonomy: modularize term list generation #671 [feature] theme: remove warnings with hugo --printI18nWarnings #670 [feature] theme: implement portable linking #377 Fixes [bug] links: extra space before link text #700 [bug] mermaid: reset zoom correctly #690 [bug] theme: fix mobile layout for width=48rem #676 [bug] frontmatter: resemble documented shortcode style #672 [bug] taxonomy: display terms in pages if removePathAccents=true #669 Maintenance [task] mermaid: update mermaid to 10.6.0 #703 [task] openapi: update swagger-ui to 5.9.1 #702 5.22.1 (2023-10-02) Enhancements [feature] i18n: add Swahili translation #666 [feature] math: hide unrendered math #663 [feature] tabs: improve a11y by removing duplicate hidden title #662 [feature] mermaid: improve zoom UX #659 Fixes [bug] variant: fix sidebar-flyout borders color for zen #667 [bug] clipboard: fix RTL location of tooltip #661 [bug] clipboard: ignore RTL for code #660 [bug] expand: fix aria-controls #658 [bug] theme: fix id generation for markdownified titles #657 [bug] mermaid: avoid graph bombing on hugo –minify #656 [bug] mermaid: fix width for some graphs #655 5.22.0 (2023-09-26) Enhancements [feature] mermaid: add pan\u0026zoom reset #651 [feature] markdown: add interlace color for tables #648 [feature] search: add breadcrumb to dedicated search results #647 [feature][change] menu: optionally disable index pages for sections #642 Fixes [bug] variants: restore generator zoom #650 [bug] clipboard: malused Fontawesome style #649 [bug][change] theme: avoid id collisions between headings and theme #646 [bug] theme: remove HTML validation errors #644 [bug] breadcrumb: remove superflous whitespace between items #643 5.21.0 (2023-09-18) Enhancements [feature] topbar: make buttons configurable #639 [feature][change] menu: fix footer padding #637 Fixes [bug] breadcrumb: don’t ignore spaces for separator #636 [bug] theme: fix snyk code issues #633 [bug] images: apply image effects to lightbox images #631 Maintenance [task] openapi: update to swagger 5.7.2 #641 5.20.0 (2023-08-26) Enhancements [feature][change] theme: support for colored borders between menu and content #626 [feature] image: allow option to apply image effects globally #623 [feature][change] openapi: switch to light syntaxhighlighting where applicable #621 [feature] images: document usage of images with links #576 Fixes [bug] highlight: fix rendering for Hugo \u003c 0.111 #630 [bug] search: remove link underline on dedicated search page #627 [bug] highlight: don’t switch to block view if hl_inline=true #618 [bug] variant: minor adjustments to zen variants #617 [bug] mermaid: lazy render graph if it is initially hidden #187 Maintenance [task] openapi: update to swagger 5.4.1 #620 5.19.0 (2023-08-12) Enhancements [feature] highlight: add title parameter #616 [feature] variant: signal variant switch as event #614 [feature] variant: add zen variant in light and dark #613 [feature] i18n: add Hungarian translation #604 [feature] mermaid: update to 10.3.0 #601 Fixes [bug] siteparam: avoid halt if param is a map/slice #611 [bug] mermaid: fix broken zoom since update to v10 #608 [bug] mermaid: variant generator diagram does not respond to events #607 [bug] print: avoid chroma leak for relearn-dark #605 Maintenance [task] mermaid: update to 10.3.1 #610 5.18.0 (2023-07-27) Enhancements [feature][change] shortcodes: add more deprecation warnings #598 [feature][change] shortcodes: change context parameter to page if called as partial #595 [feature] siteparam: support nested parameters and text formatting #590 [feature][change] a11y: improve when tabbing through links #581 Fixes [bug] openapi: inherit RTL setting from Hugo content #600 [bug] 404: fix display in RTL #597 [bug] highlight: fix position of copy-to-clipboard button in RTL #594 [bug] openapi: fix spelling #593 [bug] search: fix typo in output format #591 [bug] tabs: fix tab selection by groupid #582 [bug] theme: restore compat with Hugo 0.95.0 #580 [bug][change] theme: improve display of links #577 5.17.1 (2023-06-22) Enhancements [feature][change] highlight: make copy to clipboard appear on hover #574 5.17.0 (2023-06-22) Enhancements [feature] highlight: add configurable line breaks #169 Fixes [bug] theme: support Hugo 0.114.0 #573 [bug] taxonomy: fix number tags #570 [bug] highlight: improve copy to clipboard #569 5.16.2 (2023-06-10) Enhancements [feature] theme: revamp 404 page #566 5.16.1 (2023-06-09) Enhancements [feature] theme: add deprecation warnings #565 Fixes [bug] mermaid: allow for YAML frontmatter inside of graph #564 [bug] alias: fix redirect URLs in case of empty BaseURL #562 5.16.0 (2023-06-08) Enhancements [feature] tabs: add title and icon option #552 [feature] shortcodes: add style option to mimic code box color scheme #551 [feature] tabs: support color options #550 [feature] favicon: add light \u0026 dark option for OS’s preferred color scheme #549 Fixes [bug] icon: remove whitespace on start #560 [bug] shortcodes: avoid superflous margin at start and end of content #558 [bug] expand: fix html encoding of finishing content tag #557 [bug] icon: fix ouput “raw HTML omitted” with goldmark config unsafe=false #555 5.15.2 (2023-05-29) Enhancements [feature] taxonomy: add support for category default taxonomy #541 Fixes [bug] attachments: work for Hugo \u003c 0.112 #546 5.15.1 (2023-05-25) Fixes [bug] shortcodes: intermediately use random ids instead of .Ordinal #543 5.15.0 (2023-05-25) Enhancements [feature] tab: new shortcode to display single tab #538 [feature][change] tabs: treat groupid as unique if not set #537 [feature] expand: indent expanded content #536 [feature] notice: make boxes more prominent #535 Fixes [bug] attachments: fix build error since Hugo 0.112 #540 Maintenance [task] chore: update Mermaid to 9.4.3 #534 [task] mermaid: update to 10.2.0 #499 5.14.3 (2023-05-20) Fixes [bug] tags: show taxonomy toc for standard installation #533 5.14.2 (2023-05-20) Fixes [bug] tags: translate breadcrumb and title for taxonomy #532 5.14.1 (2023-05-20) No changelog for this release. 5.14.0 (2023-05-19) Enhancements [feature] tags: improve search index for tags #531 [feature] tags: increase readability of taxonomy pages #530 [feature] nav: make breadcrumb separator configurable #529 [feature] i18n: add translation for default taxonomies #528 [feature] theme: set appropriate defaults for all theme specific params #516 [feature] theme: allow to display tags below article #513 Fixes [bug] shortcode: make .context always a page #527 5.13.2 (2023-05-17) Fixes [bug] print: enable print for pages with _build options #522 5.13.1 (2023-05-16) Fixes [bug] openapi: allow toc to scroll page #526 5.13.0 (2023-05-14) Enhancements [feature][change] openapi: replace implementation with swagger-ui #523 Fixes [bug] variant: avoid leaking shadows in neon print style #524 5.12.6 (2023-05-04) Enhancements [feature] theme: better HTML titles and breadcrumbs for search and tag pages #521 Fixes [bug] menu: avoid hiding of expander on hover when active item has children #520 [bug] menu: showVisitedLinks not working for some theme variants #518 [bug] theme: fix resource URLs for 404 page on subdirectories #515 5.12.5 (2023-03-28) Fixes [bug] expand: not properly exanded when used in bullet point list #508 5.12.4 (2023-03-24) Fixes [bug] theme: disableExplicitIndexURLs param is not working as expected #505 5.12.3 (2023-03-14) Fixes [bug] attachments: fix links if only one language is present #503 [bug] shortcodes: allow markdown for title and content #502 5.12.2 (2023-03-03) Fixes [bug] menu: fix state for alwaysopen=false + collapsibleMenu=false #498 5.12.1 (2023-02-26) Enhancements [feature] variant: add relearn bright theme #493 Fixes [bug] generator: fix setting of colors #494 5.12.0 (2023-02-24) Enhancements [feature] frontmatter: support VSCode Front Matter extension #481 [feature] theme: make expand and image ids stable #477 [feature] variant: set scrollbar color to dark for dark variants #471 [feature] i18n: add full RTL support #470 [feature] piratify: fix some quirks, arrr #469 [feature][change] theme: optimization for huge screen sizes #466 Fixes [bug] i18n: write code ltr even for rtl languages #492 [bug] anchor: fix link in FF when served from file system #482 [bug] shortcodes: don’t break build and render for invalid parameters #480 [bug] nav: restore scroll position on browser back #476 [bug] variant: avoid style leak for auto style #473 Maintenance [task] build: add imagebot #485 5.11.2 (2023-02-07) Fixes [bug] tabs: nested tabs content is not displayed #468 5.11.1 (2023-02-06) Fixes [bug] variant: include missing theme-auto.css in distribution #467 5.11.0 (2023-02-05) Enhancements [feature] i18n: add Czech translation #455 [feature][change] lightbox: switch to CSS-only solution #451 [feature][change] variant: add support for prefers-color-scheme #445 [feature][change] expand: refactor for a11y #339 [feature][change] mermaid: make zoom configurable #144 Fixes [bug] swagger: avoid errors when using invalid rapi-doc fragment ids #465 [bug] search: fix oddities in keyboard handling #463 [bug] badge: fix text color for IE11 #462 [bug] mermaid: rerender graph if search term is present and variant is switched #460 [bug] tags: show tag on pages when tag has space #459 [bug] edit: remove double slash on root page link #450 Maintenance [task] build: add moving version tags #453 [task][change] theme: remove jQuery #452 [task] build: check for release notes before release #448 5.10.2 (2023-01-25) Fixes [bug] nav: fix breadcrumb for huge installations #446 5.10.1 (2023-01-25) Fixes [bug] print: fix image links with relative path #444 5.10.0 (2023-01-25) Enhancements [feature] shortcodes: support for accent color #440 [feature] shortcodes: add color parameter where applicable #438 [feature] theme: announce translations as alternate links #422 Fixes [bug] nav: fix breadcrumbs for deeply nested sections #442 [bug] theme: improve whitespacing in tables #441 5.9.4 (2023-01-23) Fixes [bug] variant: fix search icon and text color #437 5.9.3 (2023-01-22) Fixes [bug] nav: fix left/right navigation for horizontal scrolling #435 [bug][breaking] theme: allow pages on top level #434 Maintenance [task] build: switch to wildcard version of actions #428 5.9.2 (2022-12-30) Fixes [bug] search: apply dependency scripts for Hindi and Japanese #427 5.9.1 (2022-12-23) Enhancements [feature] theme: make external link target configurable #426 5.9.0 (2022-12-23) Enhancements [feature][change] theme: open external links in separate tab #419 [feature] theme: make it a Hugo module #417 Fixes [bug][change] attachments: fix incorrect links for defaultContentLanguageInSubdir=true #425 5.8.1 (2022-12-11) Fixes [bug] theme: fix alias for home page if defaultContentLanguageInSubdir=true #414 5.8.0 (2022-12-08) Enhancements [feature] icon: add new shortcode #412 [feature] theme: style and document markdown extensions #411 [feature] badge: add new shortcode #410 [feature] theme: add accent color #409 Fixes [bug] theme: fix spacing for tag flyout in FF #413 5.7.0 (2022-11-29) Enhancements [feature] button: refactor for a11y #372 Fixes [bug] search: don’t freeze browser on long search terms #408 [bug] search: fix searchbox placeholder color in FF and IE #405 [bug][change] i18n: rename Korean translation from country to lang code #404 Maintenance [task] search: update lunr languages to 1.10.0 #403 5.6.6 (2022-11-23) Enhancements [feature] search: make build and js forgiving against config errors #400 Fixes [bug] variant: minor color adjustments #402 [bug] variant: fix generator for use of neon #401 5.6.5 (2022-11-19) Fixes [bug] menu: relax usage of background color #399 5.6.4 (2022-11-19) Fixes [bug] theme: make alias pages usable by file:// protocol #398 5.6.3 (2022-11-19) Fixes [bug] theme: be compatible with Hugo \u003e= 0.95.0 #397 5.6.2 (2022-11-19) Fixes [bug] theme: build breaks sites without “output” section in config #396 5.6.1 (2022-11-19) Fixes [bug] theme: fix image distortion #395 5.6.0 (2022-11-18) Enhancements [feature] toc: improve keyboard handling #390 [feature] search: improve keyboard handling #387 [feature] search: add dedicated search page #386 [feature] theme: make creation of generator meta tag configurable #383 [feature] theme: increase build performance #380 Fixes [bug] mermaid: avoid leading whitespace #394 [bug] theme: fix build errors when referencing SVGs in markdown #393 [bug] variant: avoid neon to leak into IE11 fallback #392 [bug] theme: fix urls for file:// protocol in sitemap #385 [bug] theme: add id to h1 elements #384 [bug] rss: fix display of hidden subpages #382 [bug] nav: fix key navigation when pressing wrong modifiers #379 Maintenance [task] mermaid: update to version 9.2.2 #391 5.5.3 (2022-11-10) Fixes [bug] tags: fix non-latin tag display on pages #378 5.5.2 (2022-11-08) Fixes [bug] theme: fix typo in 404.html #376 [bug] theme: allow menu items and children to be served by file:// protocol #375 5.5.1 (2022-11-07) Fixes [bug] theme: fix overflowing issue with anchors and tooltips #364 5.5.0 (2022-11-06) Enhancements [feature][change] theme: optimize page load for images #304 Fixes [bug] theme: fix context in render hooks #373 [bug] print: make canonical URL absolute #371 5.4.3 (2022-11-05) Enhancements [feature] history: refactor for a11y #341 Fixes [bug] theme: fix multilang links when site served from subdirectory #370 5.4.2 (2022-11-05) Maintenance [task] build: change set-output to env vars #348 5.4.1 (2022-11-05) Fixes [bug] mermaid: fix Gantt chart width #365 5.4.0 (2022-11-01) Enhancements [feature] math: allow passing of parameters with codefence syntax #363 [feature] i18n: add Finnish translation #361 [feature] mermaid: allow passing of parameters with codefence syntax #360 [feature] i18n: support RTL #357 [feature][change] button: add option for target #351 [feature][change] theme: allow to be served by file:// protocol #349 5.3.3 (2022-10-09) Fixes [bug] archetypes: fix frontmatter on home.md template #346 5.3.2 (2022-10-08) Fixes [bug] nav: change defunct keyboard shortcuts #344 5.3.1 (2022-10-08) Enhancements [feature] i18n: update Spanish translation #343 [feature] theme: option to align images #327 5.3.0 (2022-10-07) Enhancements [feature] expander: improve whitespace between label and content #338 [feature] swagger: improve print version #333 Fixes [bug] print: fix links of subsections #340 [bug] theme: remove W3C validator errors #337 [bug] children: remove unused page parameter from docs #336 [bug] print: remove menu placeholder in Firefox #335 [bug] swagger: fix download button overflow #334 [bug][change] a11y: remove WCAG errors where applicable #307 5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter pages overwrite font-size #328 5.2.2 (2022-08-23) Fixes [bug] print: fix urls for uglyURLs=true #322 5.2.1 (2022-08-05) Enhancements [feature] i18n: improve Japanese translation #318 Fixes [bug] nav: prev/next ignores ordersectionby #320 Maintenance [task] task: bump Hugo minimum requirement to 0.95 #319 5.2.0 (2022-08-03) Enhancements [feature][change] menu: expand collapsed menus if search term is found in submenus #312 Fixes [bug] print: switch mermaid and swagger style before print #316 [bug] theme: fix chapter margins on big screens #315 5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme to light #313 [bug] mermaid: header is showing up in FF #311 5.1.1 (2022-07-15) Fixes [bug] tags: don’t count tags if page is hidden #310 5.1.0 (2022-07-15) Enhancements [feature][change] print: make print url deterministic #309 [feature] theme: allow overriding partials for output formats #308 5.0.3 (2022-07-07) Fixes [bug] ie11: no styles after rework of archetypes #306 5.0.2 (2022-07-07) Fixes [bug] theme: load CSS if JS is disabled #305 5.0.1 (2022-07-07) Enhancements [feature][breaking] theme: optimize loading of js and css #303 5.0.0 (2022-07-05) Enhancements [feature][change] archetypes: modularize rendering #300 [feature] history: don’t reload page when history gets cleared #299 [feature] menu: replace expander by fontawesome chevrons #296 [feature] theme: align content with topbar icon limits #290 [feature] button: allow for empty href #288 [feature] i18n: make Simplified Chinese the standard language for the zn code #287 [feature] clipboard: move head styles to stylesheet #286 [feature] math: add mathjax rendering #235 [feature] theme: allow for page heading modification #139 Fixes [bug] favicon: fix URL if site resides in subdirectory #302 [bug] code: show copy-to-clipboard marker for blocklevel code #298 [bug] menu: make active expander visible on hover #297 [bug] print: disable arrow navigation #294 [bug] print: add missing page break after index or section #292 [bug] theme: use more space on wide screens #291 [bug] theme: fix size of chapter heading #289 Maintenance [task] chore: update RapiDoc 9.3.3 #301 [task] chore: update Mermaid 9.1.3 #293",
"description": "5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo’s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use .LinkTitle instead of .Title if available #816 Fixes [bug] scrollbar: scroll bar in side menu gets stuck in dragged state on mobile #808",
"tags": [],
"title": "Version 5",
"uri": "/hugo-theme-relearn/introduction/changelog/5/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "5.27.0 (2024-04-07) Hugo 0.121.0 0.121.0 This release requires a newer Hugo version. Change Change If the theme is configured to generate warnings or errors during build by setting image.errorlevel to either warning or error in your hugo.toml, it will now also generate output if a link fragment is not found in the target page.\nChange The dependency loader was made more versatile.\nThe configuration in your hugo.toml does not require the location parameter anymore. If you still use it, the theme will work as before but will generate a warning. So you don’t need to change anything, yet.\nWith the new mechanism, your dependency loader now receives an additional location parameter instead that you can query to inject your dependencies in the desired location.\nBy that you can now call the dependency mechanism in your own overriden partials by giving it a distinct location parameter. In addition your injected files can now be spread to multiple locations which wasn’t previously possible.\nNew New Additional styling was added for the native HTML elements \u003cmark\u003e and \u003ckbd\u003e. To use them you must allow the usage of HTML in your hugo.toml. The Markdown documentation was enhanced for this.\nNew You now can scroll forward and backward through all headings of a page by using ALT 🡑 and ALT 🡓. This also works for the PRINT output format.\nNew The breadcrumbs used in the topbar, search results and the taxonomy term lists are now using the pages front matter linktitle instead of title if set. 5.26.0 (2024-03-18) New New The lazy loading of images is now configurable by using the new lazy image effect. The default value hasn’t changed in comparison to older versions, you don’t need to change anything.\nNew It is now possible to adjust the max width of the main area, eg. in case you want to use the full page width for your content.\nNew Images and Markdown codefences are now respecting Hugo’s Markdown attributes.\nNew The theme has updated its Mermaid dependency to 10.6.0. This adds support for block diagrams.\nNew This release fixes a long-standing bug where the page wasn’t repositioning correctly when going forward or backward in your browser history. 5.25.0 (2024-02-29) Change Change This release deprecates the attachments shortcode in favor of the new the resources shortcode.\nIf you are using Hugo below 0.123.0, you don’t need to change anything as the old shortcode still works (but may generate warnings).\nAnyways, users are strongly advised to migrate as the attachments shortcode will not receive support anymore. Migration instructions are listed on the attachments shortcode page.\nChange If you run Hugo with GitInfo configured, the default page footer now prints out name, email address and date of the last commit. If you want to turn this off you either have to run Hugo without GitInfo (which is the default) or overwrite the content-footer.html partial. 5.24.0 (2024-02-28) Hugo 0.112.4 0.112.4 This release requires a newer Hugo version. Change Change The topbar button received a way to add text next to the icon. For this, the original title option was renamed to hint while the new title option is now displayed next to the icon.\nChange The front matter option menuTitle is now deprecated in favor for Hugo’s own linkTitle. You don’t need to change anything as the old menuTitle option is still supported.\nChange The light themes have a bit more contrast for content text and headings. Also the syntaxhighlighting was changed to the more colorful MonokaiLight. This brings the syntaxhighlighting in sync with the corresponding dark theme variants, which are using Monokai. If you dislike this, you can create your own color variant file as described here.\nNew New If the theme can not resolve a link to a page or image, you can now generate warnings or errors during build by setting link.errorlevel or image.errorlevel to either warning or error in your hugo.toml respectively. By default this condition is silently ignored and the link is written as-is.\nPlease note that a page link will generate false negatives if uglyURLs=true and it references an ordinary page before 0.123.0.\nPlease note that an image link will generate false negatives if the file resides in your static directory.\nNew You now can configure additional options for every theme variant in your hugo.toml. This allows for optional advanced functionality. You don’t need to change anything as the old configuration options will still work (but may generate warnings now).\nThe advanced functionality allows you to set an explicit name for a theme variant and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.\nNew New partial for defining the heading. See documentation for further reading.\nNew Support for Hugo’s built-in figure shortcode.\nNew On taxonomy and term pages you can now use prev/next navigation as within the normal page structure.\nNew In additiion to the existing menu width customization, it is now also possible to set the width of the menu flyout for small screen sizes with the --MENU-WIDTH-S CSS property.\nNew Improvements for accessibility when tabbing through the page for images, links and tab handles.\nNew The editURL config parameter is now overwritable in your pages front matter. In addition it received more versatility by letting you control where to put the file path into the URL. This is achieved by replacing the variable ${FilePath} in your URL by the pages file path. You don’t need to change anything in your existing configuration as the old way without the replacement variable still works.\nNew The themes config and front matter options received a comprehensive documentation update. In addition the theme switched from config.toml to hugo.toml.\nNew Restored compatibility with Hugo versions 0.121.0 or higher for the highlight shortcode. This does not change the minimum required Hugo version.\nNew Restored compatibility with Hugo versions 0.123.0 or higher for theme specific output formats and handling of taxonomy and term titles. This does not change the minimum required Hugo version. 5.23.0 (2023-11-03) Change Change With 0.120.0 the author settings move into the [params] array in your hugo.toml. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.\nChange your previous setting from\nhugo. toml yaml json [params] author = 'Hugo' params: author: Hugo { \"params\": { \"author\": \"Hugo\" } } to\nhugo. toml yaml json [params] [params.author] name = 'Hugo' params: author: name: Hugo { \"params\": { \"author\": { \"name\": \"Hugo\" } } } Change Taxonomy term pages now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your hugo.toml by adding disableTermBreadcrumbs=true.\nNew New Taxonomy and term pages are now allowed to contain content. This is added inbetween the title and the page list.\nNew It is now possible to print custom taxonomies anywhere in your page. See the docs.\nNew It is now possible to adjust the menu width for your whole site. See the docs.\nNew This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. See the docs.\nNew This release comes with additional sort options for the menu and the children shortcode. Both will now accept the following values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adhering to Hugo’s default sort order).\nNew The theme now provides a mechanism to load further JavaScript dependencies defined by you only if it is needed. This comes in handy if you want to add own shortcodes that depend on additional JavaScript code to be loaded. See the docs.\nNew The theme has updated its Mermaid dependency to 10.6.0. This adds support for the xychart type.\nNew This release adds portable Markdown links.\nPreviously it was not possible to use pure Markdown links in a configuration independent way to link to pages inside of your project. It always required you to know how your uglyURLs setting is, wheather you link to a page or page bundle and in case of relative links if your current page is a page or page bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This is a hassle as you have to change these links manually once you change your uglyURLs setting or change the type of a page.\nYou could work around this by using the relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results in non-portable Markdown.\nNow it’s possible to use the same path of a call to relref in a plain Markdown link (eg [generator](../generator)). This is independent of any configuration settings or the page types involved in linking. Note, that this requires your links to be given without any extension, so [generator](generator/index.html) will work as before.\nThe following types of linking are supported:\nlink description [generator](en/configuration/branding/generator) absolute from your project root (multilang) [generator](/en/configuration/branding/generator) absolute from your project root (multilang) [generator](configuration/branding/generator) absolute from your current language root [generator](/configuration/branding/generator) absolute from your current language root [generator](./../generator) relative from the current page [generator](../generator) relative from the current page 5.22.0 (2023-10-02) Change Change This release fixes an issue where in unfortunate conditions DOM ids generated by Hugo may collide with DOM ids set by the theme. To avoid this, all theme DOM ids are now prefixed with R-.\nIf you haven’t modified anything, everything is fine. Otherwise you have to check your custom CSS rules and JavaScript code.\nChange You can now have structural sections in the hierarchical menu without generating a page for it.\nThis can come in handy, if content for such a section page doesn’t make much sense to you. See the documentation for how to do this.\nThis feature may require you to make changes to your existing installation if you are already using shortcuts to pages inside of your project with a headless branch parent.\nIn this case it is advised to remove the title from the headless branch parent’s front matter, as it will otherwise appear in your breadcrumbs.\nNew New It is now possible to overwrite the setting for collapsibleMenu of your hugo.toml inside of a page’s front matter.\nNew If a Mermaid graph is zoomable a button to reset the view is now added to the upper right corner. The button is only shown once the mouse is moved over the graph.\nNew It is now possible to remove the root breadcrumb by setting disableRootBreadcrumb=true in your hugo.toml.\nNew The output of the dedicated search page now displays the result’s breadcrumb.\nNew Table rows now change their background color on every even row.\nNew Translation into Swahili. This language is not supported for search. 5.21.0 (2023-09-18) Change Change We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your menu-footer.html partial overridden, you may want to review the styling (eg. margins/paddings) of your partial. New New This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See the documentation for further details.\nNew The theme has updated its Swagger dependency to 5.7.2 for the openapi shortcode. This brings support for OpenAPI Specification 3.1. 5.20.0 (2023-08-26) Change Change The theme has updated its Swagger dependency to 5.4.1 for the openapi shortcode.\nWith this comes a change in the light theme variants of Relearn Bright, Relearn Light and Zen Light by switching the syntaxhighlighting inside of openapi to a light scheme. This brings it more in sync with the code style used by the theme variants itself.\nAdditionally, the syntaxhighlighting inside of openapi for printing was switched to a light scheme for all theme variants.\nIf you dislike this change, you can revert this in your theme variants CSS by adding\n--OPENAPI-CODE-theme: obsidian; --PRINT-OPENAPI-CODE-theme: obsidian; Change For consistency reasons, we renamed the CSS variable --MENU-SECTION-HR-color to --MENU-SECTION-SEPARATOR-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew New The theme variants Zen Light and Zen Dark now add more contrast between menu, topbar and content by adding thin borders.\nThose borders are now configurable by using the CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color and --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.\nFor existing variants nothing has changed visually.\nNew The default values for the image effects are now configurable for your whole site via hugo.toml or for each page through front matter.\nNew This release fixes a long-standing bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed expand or inactive tabs.\nNew Restored compatibility with Hugo versions lower than 0.111.0 for the highlight shortcode. This does not change the minimum required Hugo version. 5.19.0 (2023-08-12) New New The highlight shortcode now accepts the new parameter title. This displays the code like a single tab. This is also available using Markdown codefences and makes it much easier to write nicer code samples.\nNew The theme has added two new color variants zen-light and zen-dark. Check it out!\nNew The theme now dispatches the custom event themeVariantLoaded on the document when the variant is fully loaded either initially or by switching the variant manually with the variant selector.\nNew The theme has updated its Mermaid dependency to 10.3.1. This adds support for the sankey diagram type and now comes with full support for YAML inside Mermaid graphs (previously, the theme ignored explicit Mermaid theme settings in YAML).\nNew Translation into Hungarian. 5.18.0 (2023-07-27) Change Change The theme adds additional warnings for deprecated or now unsupported features.\nChange There are visual improvements in displaying text links in your content as well as to some other clickable areas in the theme. If you’ve overwritten some theme styles in your own CSS, keep this in mind.\nNew New Restored compatibility with Hugo 0.95.0 or higher. This does not change the minimum required Hugo version.\nNew The siteparam shortcode is now capable in displaying nested params as well as supporting text formatting. 5.17.0 (2023-06-22) Change Change The default behavior for the copy-to-clipboard feature for code blocks has changed.\nThe copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.\nIf you dislike this new behavior you can turn it off and revert to the old behavior by adding [params] disableHoverBlockCopyToClipBoard=true to your hugo.toml.\nNew New Restored compatibility with Hugo 0.114.0 or higher. This does not change the minimum required Hugo version.\nNew The new highlight shortcode replaces Hugo’s default implementation and is fully compatible. So you don’t need to change anything.\nIn addition it offers some extensions. Currently only the wrap extension option is provided to control whether a code block should be wrapped or scrolled if to long to fit. 5.16.0 (2023-06-10) Change Change The theme now provides warnings for deprecated or now unsupported features. The warnings include hints how to fix them and an additional link to the documentation.\nDEPRECATION warnings mark features that still work but may be removed in the future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange The 404 error page was revamped. Hopefully you will not see this very often.\nNew New The tabs shortcode and the tab shortcode received some love and now align with their style, color, title and icon parameter to the other shortcodes.\nThe visuals are now slightly different compared to previous versions. Most noteable, if you now display a single code block in a tab, its default styling will adapt to that of a code block but with a tab handle at the top.\nAdditionally the name parameter was renamed to title but you don’t need to change anything yet as the old name will be used as a fallback. Nevertheless you will get deprecation warnings while executing Hugo.\nNew The theme now optionally supports separate favicons for light \u0026 dark mode. 5.15.0 (2023-05-29) Change Change Restored compatibility with Hugo 0.112.0 or higher. This does not change the minimum required Hugo version.\nThe attachments shortcode has compatibility issues with newer Hugo versions. You must switch to leaf bundles or are locked to Hugo \u003c 0.112.0 for now.\nIt is planned to refactor the attchments shortcode in the future. This will make it possible to use the shortcode in branch bundles again but not in simple pages anymore. This will most likely come with a breaking change.\nChange The tabs shortcode has changed behavior if you haven’t set the groupid parameter.\nFormerly all tab views without a groupid were treated as so they belong to the same group. Now, each tab view is treated as it was given a unique id.\nNew New The already known tabshas a new friend the tab shortcode to make it easier to create a tab view in case you only need one single tab. Really handy if you want to flag your code examples with a language identifier.\nAdditionally for such a use case, the whitespace between a tab outline and the code is removed if only a single code block is contained.\nNew Besides the tag taxonomy the theme now also provides the category taxonomy out of the box and shows them in the content footer of each page. 5.14.0 (2023-05-20) New New The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.\nHugo’s default taxonmies tags and categories are already contained in the theme’s i18n files. If you have self-defined taxonomies, you can add translations by adding them to your own i18n files. If you don’t provide translations, the singualar and plural forms are taken as configured in your hugo.toml.\nNew To give you more flexibility in customizing your article layout a new partial content-header.html is introduced.\nThis came out of the requirement to customize the position of article tags, which by default are displayed above the title. A second requirement was to also show additional taxonomies not supported by the theme natively. While Hugo supports tags and categories by default, the theme only displays tags.\nSo how to adjust the position of tags starting from the theme’s default where tags are only shown above the title?\nHide tags above title: Overwrite content-header.html with an empty file. Show tags between title and content: Overwrite heading-post.html and add {{ partial \"tags.html\" . }} to it. Show tags below content: Overwrite content-footer.html and add {{ partial \"tags.html\" . }} to it. New The new parameter breadcrumbSeparator is now available in your hugo.toml to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything. 5.13.0 (2023-05-17) Change Change The swagger shortcode was deprecated in favor for the openapi shortcode. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the swagger shortcode in the next major release.\nAdditionally, the implemantion of this shortcode was switched from RapiDoc to SwaggerUI. 5.12.0 (2023-05-04) Change Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed (again). While Internet Explorer 11 has issues in displaying it, the functionality still works. New New Support for the great VSCode Front Matter CMS extension which provides on-premise CMS capabilties to Hugo.\nThe theme provides Front Matter CMS snippets for its shortcodes. Currently only English and German is supported. Put a reference into your frontmatter.json like this\n​ frontmatter.json { ... \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] ... } New Support for languages that are written right to left (like Arabic) is now complete and extended to the menu, the top navigation bar and print. You can experience this in the pirate translation. This feature is not available in Internet Explorer 11.\nNew The scrollbars are now colored according to their variant color scheme to better fit into the visuals. 5.11.0 (2023-02-07) Change Change The theme removed the popular jQuery library from its distribution.\nIn case you made changes to the theme that are depending on this library you can place a copy of jQuery into your static/js directory and load it from your own layouts/partials/custom-header.html like this:\n​ layouts/partials/custom-header.html \u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Mermaid diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.\nThe default setting of on, in effect since 1.1.0, changed back to off as there was interference with scrolling on mobile and big pages.\nChange The theme is now capable to visually adapt to your OS’s light/dark mode setting.\nThis is also the new default setting if you haven’t configured themeVariant in your hugo.toml.\nAdditionally you can configure the variants to be taken for light/dark mode with the new themeVariantAuto parameter.\nThis is not supported for Internet Explorer 11, which still displays in the relearn-light variant.\nChange The JavaScript code for handling image lightboxes (provided by Featherlight) was replaced by a CSS-only solution.\nThis also changed the lightbox effects parameter from featherlight=false to lightbox=false. Nevertheless you don’t need to change anything as the old name will be used as a fallback.\nChange In the effort to comply with WCAG standards, the implementation of the expand shortcode was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works.\nNew New Translation into Czech. This language is not supported for search.\nNew GitHub releases are also now tagged for the main version (eg. 1.2.x), major version (eg. 1.x) and the latest (just x) release making it easier for you to pin the theme to a certain version. 5.10.0 (2023-01-25) New New The attachments, badge, button and notice shortcodes have a new parameter color to set arbitrary CSS color values.\nAdditionally the --ACCENT-color brand color introduced in version 5.8.0 is now supported with these shortcodes. 5.9.0 (2022-12-23) Breaking Breaking With this version it is now possible to not only have sections on the first menu level but also pages.\nIt was later discovered, that this causes pages only meant to be displayed in the More section of the menu and stored directly inside your content directory to now show up in the menu as well.\nTo get rid of this undesired behavior you have two choices:\nMake the page file a headless branch bundle (contained in its own subdirectory and called _index.md) and add the following front matter configuration to the file (see exampleSite’s content/showcase/_index.en.md). This causes its content to not be ontained in the sitemap.\n​ toml yaml json +++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++ --- _build: list: never publishResources: true render: always title: Showcase --- { \"_build\": { \"list\": \"never\", \"publishResources\": true, \"render\": \"always\" }, \"title\": \"Showcase\" } Store the page file for below a parent headless branch bundle and add the following front matter to he parent (see exampleSite’s content/more/_index.en.md). Don’t give this page a title as this will cause it to be shown in the breadcrumbs - a thing you most likely don’t want.\n​ toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s content/more/credits.en.md). This causes its content to be contained in the sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } Change Change The required directory name for the attachments shortcode was changed for leaf bundles.\nPreviously, the attachments for leaf bundles in non-multilang setups were required to be in a files subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnecessary complexity. So attachments for leaf bundles in non-multilang setups can now also reside in a index.files directory. Although the old files directory is now deprecated, if both directories are present, only the old files directory will be used for compatibility.\nChange Absolute links prefixed with http:// or https:// are now opened in a separate browser tab.\nYou can revert back to the old behavior by defining externalLinkTarget=\"_self\" in the params section of your hugo.toml.\nNew New The theme now supports Hugo’s module system. 5.8.0 (2022-12-08) New New The new badge shortcode is now available to add highly configurable markers to your content as you can see it on this page.\nNew The new icon shortcode simplyfies the usage of icons. This can even be combined with also new badge shortcode.\nNew The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely task lists, defintion lists and footnotes.\nNew A new color --ACCENT-color was introduced which is used for highlighting search results on the page. In case you simply don’t care, you don’t need to change anything in your variant stylesheet as the old yellow color is still used as default. 5.7.0 (2022-11-29) Change Change The Korean language translation for this theme is now available with the language code ko. Formerly the country code kr was used instead. New New The button shortcode can now also be used as a real button inside of HTML forms - although this is a pretty rare use case. The documentation was updated accordingly.\nNew The search now supports the Korean language. 5.6.0 (2022-11-18) New New This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning through large number of results.\nTo activate this feature, you need to configure it in your hugo.toml as a new outputformat searchpage for the home page. If you don’t configure it, no dedicated search page will be accessible and the theme works as before.\nYou can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.\nNew Keyboard handling for the TOC and search was improved.\nPressing CTRL+ALT+t now will not only toggle the TOC overlay but also places the focus to the first heading on opening. Subsequently this makes it possible to easily select headings by using the TAB key.\nThe search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus the cursor inside of the search box so you can immediately start your search by typing.\nNew You are now able to turn off the generation of generator meta tags in your HTML head to hide the used versions of Hugo and this theme.\nTo configure this in your hugo.toml make sure to set Hugo’s disableHugoGeneratorInject=true and also [params] disableGeneratorVersion=true, otherwise Hugo will generate a meta tag into your home page automagically.\nNew Creation of your project gets a little bit faster with this release.\nThis addresses increased build time with the version 5 releases. The theme now heavily caches partial results leading to improved performance. To further increase performance, unnecessary parts of the page are now skipped for creation of the print output (eg. menus, navigation bar, etc.). 5.5.0 (2022-11-06) Change Change The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview.\nFor that the JavaScript code to handle the lightbox and image effects on the client side was removed in favour for static generation of those effects on the server.\nIf you have used HTML directly in your Markdown files, this now has the downside that it doesn’t respect the effect query parameter anymore. In this case you have to migrate all your HTML img URLs manually to the respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 5.4.0 (2022-11-01) Change Change With the proper settings in your hugo.toml your page is now servable from the local file system using file:// URLs.\nPlease note that the searchbox will only work for this if you reconfigure your outputformat for the home page in your hugo.toml from json to search. The now deprecated json outputformat still works as before, so there is no need to reconfigure your installation if it is only served from http:// or https://.\nChange The button shortcode has a new parameter target to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in a new window/tab.\nNew New The math shortcode and mermaid shortcode now also support the align parameter if Markdown codefences are used.\nNew Support for languages that are written right to left (like Arabic). This is only implemented for the content area but not the navigation sidebar. This feature is not available in Internet Explorer 11.\nNew Translation into Finnish (Suomi). 5.3.0 (2022-10-07) Change Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. The functionality of the new implementation does not work with old browsers (Internet Explorer 11). New New Image formatting has two new classes to align images to the left or right. Additionally, the already existing inline option is now documented.\nNew Printing for the swagger shortcode was optimized to expand sections that are usually closed in interactive mode. This requires print support to be configured. 5.2.0 (2022-08-03) Change Change If you’ve set collapsibleMenu = true in your hugo.toml, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus. 5.1.0 (2022-07-15) Hugo 0.95.0 0.95.0 This release requires a newer Hugo version. Change Change Because the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a index.print.html to the default URL.\nYou can revert this behavior by overwriting the print output format setting in your hugo.tomlto:\nhugo. toml yaml json [outputFormats] [outputFormats.print] baseName = 'index' isHTML = true mediaType = 'text/html' name = 'print' path = '_print' permalinkable = false outputFormats: print: baseName: index isHTML: true mediaType: text/html name: print path: _print permalinkable: false { \"outputFormats\": { \"print\": { \"baseName\": \"index\", \"isHTML\": true, \"mediaType\": \"text/html\", \"name\": \"print\", \"path\": \"_print\", \"permalinkable\": false } } } 5.0.0 (2022-07-05) Breaking Breaking The theme changed how JavaScript and CSS dependencies are loaded to provide a better performance. In case you’ve added own JavaScript code that depends on the themes jQuery implementation, you have to put it into a separate *.js file (if not already) and add the defer keyword to the script element. Eg.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e Change Change The way archetypes are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones.\nYour existing markdown files will still work like before and therefore you don’t need to change anything after the upgrade. Nevertheless, it is recommended to adapt your existing markdown files to the new way as follows:\nfor your home page, add the front matter parameter archetype = \"home\" and remove the leading heading\nfor all files containing the deprecated front matter parameter chapter = true, replace it with archetype = \"chapter\" and remove the leading headings\nChange The front matter options pre / post were renamed to menuPre / menuPost. The old options will still be used if the new options aren’t set. Therefore you don’t need to change anything after the upgrade.\nNew New Adding new partials heading-pre.html / heading-post.html and according front matter options headingPre / headingPost to modify the way your page`s main heading gets styled.\nNew The new shortcode math is available to add beautiful math and chemical formulae. See the documentation for available features. This feature will not work with Internet Explorer 11.",
"description": "5.27.0 (2024-04-07) Hugo 0.121.0 0.121.0 This release requires a newer Hugo version. Change Change If the theme is configured to generate warnings or errors during build by setting image.errorlevel to either warning or error in your hugo.toml, it will now also generate output if a link fragment is not found in the target page.",
"tags": [],
"title": "Version 5",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.5.3 (2022-11-10) Fixes [bug] tags: fix non-latin tag display on pages #378 5.5.2 (2022-11-08) Fixes [bug] theme: fix typo in 404.html #376 [bug] theme: allow menu items and children to be served by file:// protocol #375 5.5.1 (2022-11-07) Fixes [bug] theme: fix overflowing issue with anchors and tooltips #364 5.5.0 (2022-11-06) Enhancements [feature][change] theme: optimize page load for images #304 Fixes [bug] theme: fix context in render hooks #373 [bug] print: make canonical URL absolute #371",
"description": "5.5.3 (2022-11-10) Fixes [bug] tags: fix non-latin tag display on pages #378",
"tags": [],
"title": "Version 5.5",
"uri": "/hugo-theme-relearn/introduction/changelog/5/5/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.5.0 (2022-11-06) Change Change The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview.\nFor that the JavaScript code to handle the lightbox and image effects on the client side was removed in favour for static generation of those effects on the server.\nIf you have used HTML directly in your Markdown files, this now has the downside that it doesn’t respect the effect query parameter anymore. In this case you have to migrate all your HTML img URLs manually to the respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e",
"description": "5.5.0 (2022-11-06) Change Change The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview.",
"tags": [],
"title": "Version 5.5",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/5/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.4.1 (2021-10-07) Fixes [bug] theme: remove runtime styles from print #111 2.4.0 (2021-10-07) Enhancements [feature] lang: add vietnamese translation #109 [feature][change] theme: simplify stylesheet for color variants #107 [feature] hidden pages: remove from RSS feed, JSON, taxonomy etc #102 [feature] theme: announce alternative content in header #101 [feature] menu: frontmatter option to change sort predicate #98 [feature] menu: frontmatter option to change sort predicate #98 [feature] menu: add default setting for menu expansion #97 [feature] theme: improve print style #93 [feature] theme: improve style #92 Fixes [bug] include: don’t generate additional HTML if file should be displayed “as is” #110 [bug] attachments: fix broken links if multilang config is used #105 [bug] theme: fix sticky header to remove horizontal scrollbar #82 Maintenance [task] chore: update fontawesome #94",
"description": "2.4.1 (2021-10-07) Fixes [bug] theme: remove runtime styles from print #111",
"tags": [],
"title": "Version 2.4",
"uri": "/hugo-theme-relearn/introduction/changelog/2/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.4.0 (2021-10-07) Change Change Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included. New New Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your hugo.toml.\nNew You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your hugo.toml. Please see further documentation for possible values and default behavior.\nNew New front matter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.\nNew Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation.",
"description": "2.4.0 (2021-10-07) Change Change Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included. New New Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your hugo.toml.",
"tags": [],
"title": "Version 2.4",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translation #233 [feature] menu: expand/collapse menu items without navigation #231 [feature] print: add option to print whole chapter #230 [feature][breaking] theme: apply user supplied content footer below content #229 Fixes [bug] theme: scroll to heading on initial load #232",
"description": "3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translation #233 [feature] menu: expand/collapse menu items without navigation #231 [feature] print: add option to print whole chapter #230 [feature][breaking] theme: apply user supplied content footer below content #229 Fixes [bug] theme: scroll to heading on initial load #232",
"tags": [],
"title": "Version 3.4",
"uri": "/hugo-theme-relearn/introduction/changelog/3/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "3.4.0 (2022-04-03) Breaking Breaking If you had previously overwritten the custom-footer.html partial to add visual elements below the content of your page, you have to move this content to the new partial content-footer.html. custom-footer.html was never meant to contain HTML other than additional styles and JavaScript. New New If you prefer expandable/collapsible menu items, you can now set collapsibleMenu=true in your hugo.toml. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.\nNew You can activate print support in your hugo.toml to add the capability to print whole chapters or even the complete site.\nNew Translation into Traditional Chinese.",
"description": "3.4.0 (2022-04-03) Breaking Breaking If you had previously overwritten the custom-footer.html partial to add visual elements below the content of your page, you have to move this content to the new partial content-footer.html. custom-footer.html was never meant to contain HTML other than additional styles and JavaScript. New New If you prefer expandable/collapsible menu items, you can now set collapsibleMenu=true in your hugo.toml. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.",
"tags": [],
"title": "Version 3.4",
"uri": "/hugo-theme-relearn/introduction/releasenotes/3/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not load in documentation #285 [bug] children: descriptions not working #284 [bug] print: fix empty page for shortcut links #283 4.2.4 (2022-06-23) Fixes [bug] theme: fix url for logo and home button #282 4.2.3 (2022-06-23) Fixes [bug][breaking] include: second parameter is ignored #281 4.2.2 (2022-06-23) No changelog for this release. 4.2.1 (2022-06-23) No changelog for this release. 4.2.0 (2022-06-23) Enhancements [feature][change] tabs: don’t change tab selection if panel does not contain item #279 [feature] shortcodes: convert to partials #277 Fixes [bug] swagger: avoid builtin syntaxhighlighting #280 [bug] search: fix console message for missing lunr translations #278 [bug] tabs: fix wrapping when having many tabs #272 4.1.1 (2022-06-18) Fixes [bug] notice: fix layout when content starts with heading #275 4.1.0 (2022-06-12) Enhancements [feature] i18n: support multilang content #271 4.0.5 (2022-06-12) Fixes [bug] i18n: Vietnamese language with wrong lang code #270 [bug] i18n: fix search for non western languages #269 4.0.4 (2022-06-07) Enhancements [feature] theme: improve keyboard navigation for scrolling #268 Fixes [bug] swagger: adjust font-size for method buttons #267 [bug] menu: hide expander when only hidden subpages #264 [bug] theme: make compatible with Hugo 0.100.0 #263 Maintenance [task] swagger: update rapidoc to 9.3.2 #266 [task] mermaid: update to 9.1.1 #265 4.0.3 (2022-06-05) Enhancements [feature] toc: add scrollbar #262 4.0.2 (2022-06-05) Fixes [bug] theme: let browser scroll page on CTRL+f #242 4.0.1 (2022-06-05) No changelog for this release. 4.0.0 (2022-06-05) Enhancements [feature] shortcodes: add named parameter if missing #260 [feature][breaking] theme: remove –MAIN-ANCHOR-color from stylesheet #256 [feature] i18n: add Italian translation #254 [feature] attachments: support for brand colors #252 [feature] notice: support for brand colors #251 [feature][breaking] config: remove custom_css #248 [feature] theme: use proper file extension for page-meta.go #246 [feature] variant: add support for brand color variables #239 [feature] i18n: add Polish translation #237 Fixes [bug] shortcodes: accept boolean parameters if given as string #261 [bug] print: adjust button and tab size #259 [bug] print: show Mermaid if requested in frontmatter #255 [bug] theme: adjust thin scrollbar slider #244 [bug] mobile: fix broken scrollbar #243 [bug] theme: fix display of tooltip for heading anchor #241",
"description": "4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not load in documentation #285 [bug] children: descriptions not working #284 [bug] print: fix empty page for shortcut links #283",
"tags": [],
"title": "Version 4",
"uri": "/hugo-theme-relearn/introduction/changelog/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "4.2.0 (2022-06-23) Breaking Breaking The second parameter for the include shortcode was switched in meaning and was renamed from showfirstheading to hidefirstheading. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.\nIf you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.\nChange Change Previously, if the tabs shortcode could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.\nChange The landingPageURL was removed from hugo.toml. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically and will point to the project’s home page. If you want to support a different link, overwrite the logo.html partial.\nNew New All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode. 4.1.0 (2022-06-12) New New While fixing issues with the search functionality for non Latin languages, you can now configure to have multiple languages on a single page. 4.0.0 (2022-06-05) Breaking Breaking The custom_css config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the custom-header.html template in a much more generic manner.\nBreaking Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove --MAIN-ANCHOR-color instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from --MAIN-LINK-color and --MAIN-ANCHOR-HOVER-color respectively.\nNew New All shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don’t need to change anything in your installation.\nThis applies to expand, include, notice and siteparam.\nNew The button shortcode received some love and now has a parameter for the color style similar to other shortcodes.\nNew New colors --PRIMARY-color and --SECONDARY-color were added to provide easier modification of your custom style. Shortcodes with a color style can now have primary or secondary as additional values.\nThese two colors are the default for other, more specific color variables. You don’t need to change anything in your existing custom color stylesheets as those variables get reasonable default values.\nNew Translation into Polish. This language is not supported for search.\nNew The documentation for all shortcodes were revised.",
"description": "4.2.0 (2022-06-23) Breaking Breaking The second parameter for the include shortcode was switched in meaning and was renamed from showfirstheading to hidefirstheading. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.",
"tags": [],
"title": "Version 4",
"uri": "/hugo-theme-relearn/introduction/releasenotes/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.4.3 (2022-11-05) Enhancements [feature] history: refactor for a11y #341 Fixes [bug] theme: fix multilang links when site served from subdirectory #370 5.4.2 (2022-11-05) Maintenance [task] build: change set-output to env vars #348 5.4.1 (2022-11-05) Fixes [bug] mermaid: fix Gantt chart width #365 5.4.0 (2022-11-01) Enhancements [feature] math: allow passing of parameters with codefence syntax #363 [feature] i18n: add Finnish translation #361 [feature] mermaid: allow passing of parameters with codefence syntax #360 [feature] i18n: support RTL #357 [feature][change] button: add option for target #351 [feature][change] theme: allow to be served by file:// protocol #349",
"description": "5.4.3 (2022-11-05) Enhancements [feature] history: refactor for a11y #341 Fixes [bug] theme: fix multilang links when site served from subdirectory #370",
"tags": [],
"title": "Version 5.4",
"uri": "/hugo-theme-relearn/introduction/changelog/5/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.4.0 (2022-11-01) Change Change With the proper settings in your hugo.toml your page is now servable from the local file system using file:// URLs.\nPlease note that the searchbox will only work for this if you reconfigure your outputformat for the home page in your hugo.toml from json to search. The now deprecated json outputformat still works as before, so there is no need to reconfigure your installation if it is only served from http:// or https://.\nChange The button shortcode has a new parameter target to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in a new window/tab.\nNew New The math shortcode and mermaid shortcode now also support the align parameter if Markdown codefences are used.\nNew Support for languages that are written right to left (like Arabic). This is only implemented for the content area but not the navigation sidebar. This feature is not available in Internet Explorer 11.\nNew Translation into Finnish (Suomi).",
"description": "5.4.0 (2022-11-01) Change Change With the proper settings in your hugo.toml your page is now servable from the local file system using file:// URLs.",
"tags": [],
"title": "Version 5.4",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "6.4.1 (2024-10-11) Fixes [bug] highlight: remove additional newlines from code if copied from cursor selection #925 6.4.0 (2024-09-12) Enhancements [feature] notice: support user defined box styles #913 [feature] frontmatter: add expanded parameter for shortcodes #911 [feature] resources: add expanded parameter #908 [feature][change] notice: collapse borders if single code block is displayed #906 Fixes [bug] include: don’t erroneously remove headings if hidefirstheading=true #914 Maintenance [task] build: add link for migration into changelog #915 [task] shortcodes: fix whitespace issues #907",
"description": "6.4.1 (2024-10-11) Fixes [bug] highlight: remove additional newlines from code if copied from cursor selection #925",
"tags": [],
"title": "Version 6.4",
"uri": "/hugo-theme-relearn/introduction/changelog/6/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "6.4.0 (2024-10-11) Change Change If you now display a single code block in a notice box, its margin and border will be removed so only the colored notice border is visible. New New It is now possible to have user-defined styles for all shortcodes that accept the style parameter. See the notice shortcode for configuration.\nNew The resources shortcode has a new parameter expanded to make the resource list collapsible.",
"description": "6.4.0 (2024-10-11) Change Change If you now display a single code block in a notice box, its margin and border will be removed so only the colored notice border is visible. New New It is now possible to have user-defined styles for all shortcodes that accept the style parameter. See the notice shortcode for configuration.",
"tags": [],
"title": "Version 6.4",
"uri": "/hugo-theme-relearn/introduction/releasenotes/6/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translation #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translation to avoid crash on rendering #90 2.3.0 (2021-09-13) Fixes [bug] theme: fix usage of section element #88 Maintenance [task] theme: ensure IE11 compatibility #89 [task] docs: Arrr! showcase multilang featurrre #87",
"description": "2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translation #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translation to avoid crash on rendering #90",
"tags": [],
"title": "Version 2.3",
"uri": "/hugo-theme-relearn/introduction/changelog/2/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.3.0 (2021-09-13) Hugo 0.81.0 0.81.0 This release requires a newer Hugo version. New New Showcase multilanguage features by providing a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Piratish one due to maintenance constraints.",
"description": "2.3.0 (2021-09-13) Hugo 0.81.0 0.81.0 This release requires a newer Hugo version. New New Showcase multilanguage features by providing a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Piratish one due to maintenance constraints.",
"tags": [],
"title": "Version 2.3",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translation #233 [feature] menu: expand/collapse menu items without navigation #231 [feature] print: add option to print whole chapter #230 [feature][breaking] theme: apply user supplied content footer below content #229 Fixes [bug] theme: scroll to heading on initial load #232 3.3.0 (2022-03-28) Enhancements [feature] theme: add CSS font variables #227 [feature] swagger: add support for oas/swagger documentation #226 Fixes [bug] variant: make variant switch work on slow networks #228 3.2.1 (2022-03-25) Fixes [bug] print: fix minor inconsistencies #225 [bug] print: show more than just the title page #224 [bug] theme: align content scrollbar to the right on big screens #223 3.2.0 (2022-03-19) Enhancements [feature][change] mermaid: support differing themes for color variant switch #219 [feature] mermaid: load javascript on demand #218 Maintenance [task] mermaid: update to 8.14.0 #220 3.1.1 (2022-03-16) Enhancements [feature] i18n: add Korean translation #217 3.1.0 (2022-03-15) Enhancements [feature] notice: add icon parameter #212 [feature] mobile: remove breadcrumb ellipsis #211 Fixes [bug] theme: make storage of multiple Hugo sites on same server distinct #214 [bug] variant: switch breadcrumb color in Chrome #213 [bug] mobile: improve behavior of sidebar menu #210 3.0.4 (2022-02-24) Enhancements [feature] theme: improve font loading #201 [feature][change] variant: fix inconsistent color variable naming #200 Fixes [bug] variant: fix occasional fail when resetting generator #208 [bug] docs: don’t move header on logo hover in IE11 #207 [bug] variant: avoid flash of menu header when non default variant is active #206 [bug] theme: fix wrong HTML closing tag order in chapters #205 [bug] theme: adjust breadcrumb and title for empty home page titles #202 3.0.3 (2022-02-23) Enhancements [feature] tags: show tag count in taxonomy list #195 Fixes [bug] theme: remove Hugo build warning if page is not file based #197 [bug] tags: adhere to titleSeparator #196 [bug] theme: hide footer divider and variant selector in IE11 #194 3.0.2 (2022-02-23) Enhancements [feature] tags: sort by name #193 3.0.1 (2022-02-23) Enhancements [feature] children: set containerstyle automatically according to style #192 Fixes [bug] theme: revert fontawsome to version 5 for IE11 compat #191 3.0.0 (2022-02-22) Enhancements [feature] variant: build a variant generator #188 [feature] nav: only show toc if the page has headings #182 [feature][breaking] theme: change default colors to Relearn defaults #181 [feature] variant: add a variant selector #178 [feature][breaking] menu: rework footer UX #177 [feature] theme: support for dark mode #175 [feature] docs: use light syntax highlighting theme #174 [feature] notice: tweak dull colors #173 [feature] theme: rework header UX #151 Fixes [bug] search: remove additional X in filled out search box in IE11 #190 [bug] clipboard: localize tooltips #186 [bug] print: hide sidebar on Mac #183 [bug] menu: fix scrollbar height #180 [bug][change] search: fix color change for icons on hover #176",
"description": "3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translation #233 [feature] menu: expand/collapse menu items without navigation #231 [feature] print: add option to print whole chapter #230 [feature][breaking] theme: apply user supplied content footer below content #229 Fixes [bug] theme: scroll to heading on initial load #232",
"tags": [],
"title": "Version 3",
"uri": "/hugo-theme-relearn/introduction/changelog/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "3.4.0 (2022-04-03) Breaking Breaking If you had previously overwritten the custom-footer.html partial to add visual elements below the content of your page, you have to move this content to the new partial content-footer.html. custom-footer.html was never meant to contain HTML other than additional styles and JavaScript. New New If you prefer expandable/collapsible menu items, you can now set collapsibleMenu=true in your hugo.toml. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.\nNew You can activate print support in your hugo.toml to add the capability to print whole chapters or even the complete site.\nNew Translation into Traditional Chinese. 3.3.0 (2022-03-28) New New Introduction of new CSS variables to set the font. The theme distinguishes between --MAIN-font for all content text and --CODE-font for inline or block code. There are additional overrides for all headings. See the theme variant generator of the exampleSite for all available variables.\nNew The new shortcode swagger is available to include a UI for REST OpenAPI specifications. See the documentation for available features. This feature will not work with Internet Explorer 11. 3.2.0 (2022-03-19) Hugo 0.93.0 0.93.0 This release requires a newer Hugo version. Change Change In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Markdown codefences. This changes the behavior of disableMermaid config option as follows: If a Mermaid shortcode or Markdown codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.\nThe option is still useful in case you are using scripting to set up your graph. In this case no shortcode or Markdown codefence is involved and the library is not loaded by default. In this case you can set disableMermaid=false in your front matter to force the library to be loaded. See the theme variant generator of the exampleSite for an example.\nNew New Additional color variant variable --MERMAID-theme to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant. 3.1.0 (2022-03-15) New New attachment and notice shortcodes have a new parameter to override the default icon. Allowed values are all Font Awesome 5 Free icons. 3.0.0 (2022-02-22) Breaking Breaking We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the menu-footer.html partial that is coming with the exampleSite.\nThis change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and Clear history functionality).\nBreaking We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.\nThis change will only affect your installation if you’ve not set the themeVariant parameter in your hugo.toml. If you still want to use the Learn color variant, you have to explicitly set themeVariant=\"learn\" in your hugo.toml.\nNote, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Change Due to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove --MENU-SEARCH-BOX-ICONS-color and introduced --MENU-SEARCH-color instead. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color to --MENU-SEARCH-BORDER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew New With this release you are now capable to define your own dark mode variants.\nTo make this possible, we have introduced a lot more color variables you can use in your color variants. Your old variants will still work and don’t need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.\nTo see what’s now possible, see the new variants relearn-dark and neon that are coming with this release.\nNew To make the creation of new variants easier for you, we’ve added a new interactive theme variant generator. This feature will not work with Internet Explorer 11.\nNew You can now configure multiple color variants in your hugo.toml. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer. See the documentation for configuration.\nNote, that the new variant selector will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant selector will not be displayed with Internet Explorer 11.",
"description": "3.4.0 (2022-04-03) Breaking Breaking If you had previously overwritten the custom-footer.html partial to add visual elements below the content of your page, you have to move this content to the new partial content-footer.html. custom-footer.html was never meant to contain HTML other than additional styles and JavaScript. New New If you prefer expandable/collapsible menu items, you can now set collapsibleMenu=true in your hugo.toml. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.",
"tags": [],
"title": "Version 3",
"uri": "/hugo-theme-relearn/introduction/releasenotes/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.3.0 (2022-03-28) Enhancements [feature] theme: add CSS font variables #227 [feature] swagger: add support for oas/swagger documentation #226 Fixes [bug] variant: make variant switch work on slow networks #228",
"description": "3.3.0 (2022-03-28) Enhancements [feature] theme: add CSS font variables #227 [feature] swagger: add support for oas/swagger documentation #226 Fixes [bug] variant: make variant switch work on slow networks #228",
"tags": [],
"title": "Version 3.3",
"uri": "/hugo-theme-relearn/introduction/changelog/3/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "3.3.0 (2022-03-28) New New Introduction of new CSS variables to set the font. The theme distinguishes between --MAIN-font for all content text and --CODE-font for inline or block code. There are additional overrides for all headings. See the theme variant generator of the exampleSite for all available variables.\nNew The new shortcode swagger is available to include a UI for REST OpenAPI specifications. See the documentation for available features. This feature will not work with Internet Explorer 11.",
"description": "3.3.0 (2022-03-28) New New Introduction of new CSS variables to set the font. The theme distinguishes between --MAIN-font for all content text and --CODE-font for inline or block code. There are additional overrides for all headings. See the theme variant generator of the exampleSite for all available variables.",
"tags": [],
"title": "Version 3.3",
"uri": "/hugo-theme-relearn/introduction/releasenotes/3/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.3.3 (2022-10-09) Fixes [bug] archetypes: fix frontmatter on home.md template #346 5.3.2 (2022-10-08) Fixes [bug] nav: change defunct keyboard shortcuts #344 5.3.1 (2022-10-08) Enhancements [feature] i18n: update Spanish translation #343 [feature] theme: option to align images #327 5.3.0 (2022-10-07) Enhancements [feature] expander: improve whitespace between label and content #338 [feature] swagger: improve print version #333 Fixes [bug] print: fix links of subsections #340 [bug] theme: remove W3C validator errors #337 [bug] children: remove unused page parameter from docs #336 [bug] print: remove menu placeholder in Firefox #335 [bug] swagger: fix download button overflow #334 [bug][change] a11y: remove WCAG errors where applicable #307",
"description": "5.3.3 (2022-10-09) Fixes [bug] archetypes: fix frontmatter on home.md template #346",
"tags": [],
"title": "Version 5.3",
"uri": "/hugo-theme-relearn/introduction/changelog/5/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.3.0 (2022-10-07) Change Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. The functionality of the new implementation does not work with old browsers (Internet Explorer 11). New New Image formatting has two new classes to align images to the left or right. Additionally, the already existing inline option is now documented.\nNew Printing for the swagger shortcode was optimized to expand sections that are usually closed in interactive mode. This requires print support to be configured.",
"description": "5.3.0 (2022-10-07) Change Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. The functionality of the new implementation does not work with old browsers (Internet Explorer 11). New New Image formatting has two new classes to align images to the left or right. Additionally, the already existing inline option is now documented.",
"tags": [],
"title": "Version 5.3",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "6.3.0 (2024-09-03) Enhancements [feature] theme: support Obsidian styled alerts #903 [feature] notice: add expander to box title #901 Fixes [bug] children: fix sort parameter #898 [bug] mermaid: classDiagram breaks when using «interface» #895 [bug] toc: don’t show toc button if empty #893 Maintenance [task] mermaid: update to 11.1.0 #904 [task][change] expand: rename open parameter to expanded #902 [task] i18n: update Arabic translation #900",
"description": "6.3.0 (2024-09-03) Enhancements [feature] theme: support Obsidian styled alerts #903 [feature] notice: add expander to box title #901 Fixes [bug] children: fix sort parameter #898 [bug] mermaid: classDiagram breaks when using «interface» #895 [bug] toc: don’t show toc button if empty #893 Maintenance [task] mermaid: update to 11.1.0 #904 [task][change] expand: rename open parameter to expanded #902 [task] i18n: update Arabic translation #900",
"tags": [],
"title": "Version 6.3",
"uri": "/hugo-theme-relearn/introduction/changelog/6/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "6.3.0 (2024-09-03) Change Change The expand shortcode changed the naming of the open parameter to expanded. You don’t need to change anything yet but may get deprecation warnings.\nChange If the content for the notice shortcode is empty, now only the title bar will be displayed. Previously an empty content box was displayed.\nNew New The notice shortcode has a new parameter expanded to make the content collapsible.\nNew If you are running Hugo 0.134.0 or later, the theme now supports Obsidian callouts.\nNew The theme has updated its Mermaid dependency to 11.1.0. This adds support for packet and architecture diagrams.",
"description": "6.3.0 (2024-09-03) Change Change The expand shortcode changed the naming of the open parameter to expanded. You don’t need to change anything yet but may get deprecation warnings.",
"tags": [],
"title": "Version 6.3",
"uri": "/hugo-theme-relearn/introduction/releasenotes/6/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 1",
"content": "1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes and attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add option to open on page load #25 [feature] expand: rework styling #24 [feature] attachments: sort output #23 [feature] notice: make restyling of notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors to common standards #18 [feature] notice: use distinct icons for notice box type #17 Fixes [bug] attachments: support i18n for attachment size #21 [bug] notice: support i18n for box labels #16 [bug] notice: support multiple blocks in one box #15 Maintenance [task] dependency: upgrade jquery to 3.6.0 #30",
"description": "1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes and attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add option to open on page load #25 [feature] expand: rework styling #24 [feature] attachments: sort output #23 [feature] notice: make restyling of notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors to common standards #18 [feature] notice: use distinct icons for notice box type #17 Fixes [bug] attachments: support i18n for attachment size #21 [bug] notice: support i18n for box labels #16 [bug] notice: support multiple blocks in one box #15 Maintenance [task] dependency: upgrade jquery to 3.6.0 #30",
"tags": [],
"title": "Version 1.2",
"uri": "/hugo-theme-relearn/introduction/changelog/1/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 1",
"content": "1.2.0 (2021-07-26) New New Shortcode expand with new parameter to open on page load.",
"description": "1.2.0 (2021-07-26) New New Shortcode expand with new parameter to open on page load.",
"tags": [],
"title": "Version 1.2",
"uri": "/hugo-theme-relearn/introduction/releasenotes/1/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigation respect ordersectionsby configuration #170 2.9.4 (2022-02-06) Fixes [bug] exampleSite: fix links in official documentation #168 2.9.3 (2022-02-06) Fixes [bug] menu: invalid URL when the shortcut is an internal link #163 2.9.2 (2021-11-26) Enhancements [feature] theme: add theme version info to head #158 Fixes [bug] theme: fix selection of *.ico files as favicons #160 2.9.1 (2021-11-22) Fixes [bug] menu: fix significantly low performance for collecting of meta info #157 2.9.0 (2021-11-19) Fixes [bug][breaking] relref: fix inconsistent behavior #156 [bug] search: make dropdown stick to search field when scrolling #155 [bug] menu: align long text properly #154 [bug] copyToClipBoard: add missing right border for inline code if disableInlineCopyToClipBoard=true #153 [bug] menu: show hidden sibling pages reliably #152 [bug] menu: bring active item in sight for large menus #149 2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset to initial size #145 [bug] mermaid: remove whitespace from big graphs #143 2.8.2 (2021-11-08) Fixes [bug] mermaid: always load javascript to avoid break if code fences are used #142 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS in multilang setup if search is disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally available via config.toml #133 [feature] mermaid: only load javascript if necessary #95 [feature][change] theme: switch font #83 [feature] theme: make favicon configurable #2 Fixes [bug] mermaid: assert that window.mermaid is actually mermaid #136 [bug] menu: remove usage of Hugo’s UniqueID #131 [bug] theme: reduce margin for children shortcode #130 [bug] theme: left-align h3 in chapters #129 [bug] theme: align copy link to clipboard #128 2.7.0 (2021-10-24) Enhancements [feature] notice: support custom titles #124 2.6.0 (2021-10-21) Fixes [bug] theme: generate correct links if theme served from subdirectory #120 2.5.1 (2021-10-12) Fixes [bug] security: fix XSS for malicious image URLs #117 2.5.0 (2021-10-08) Enhancements [feature][change] syntax highlight: provide default colors for unknown languages #113 Fixes [bug] security: fix XSS for malicious URLs #114 [bug] menu: write correct local shortcut links #112 2.4.1 (2021-10-07) Fixes [bug] theme: remove runtime styles from print #111 2.4.0 (2021-10-07) Enhancements [feature] lang: add vietnamese translation #109 [feature][change] theme: simplify stylesheet for color variants #107 [feature] hidden pages: remove from RSS feed, JSON, taxonomy etc #102 [feature] theme: announce alternative content in header #101 [feature] menu: frontmatter option to change sort predicate #98 [feature] menu: frontmatter option to change sort predicate #98 [feature] menu: add default setting for menu expansion #97 [feature] theme: improve print style #93 [feature] theme: improve style #92 Fixes [bug] include: don’t generate additional HTML if file should be displayed “as is” #110 [bug] attachments: fix broken links if multilang config is used #105 [bug] theme: fix sticky header to remove horizontal scrollbar #82 Maintenance [task] chore: update fontawesome #94 2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translation #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translation to avoid crash on rendering #90 2.3.0 (2021-09-13) Fixes [bug] theme: fix usage of section element #88 Maintenance [task] theme: ensure IE11 compatibility #89 [task] docs: Arrr! showcase multilang featurrre #87 2.2.0 (2021-09-09) Enhancements [feature] sitemap: hide hidden pages from sitemap and SEO indexing #85 Fixes [bug] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary to schema #84 2.1.0 (2021-09-07) Enhancements [feature] search: open expand if it contains search term #80 [feature] menu: scroll active item into view #79 [feature] search: disable search in hidden pages #76 [feature] search: improve readability of index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site content #81 [bug] menu: always hide hidden sub pages #77 2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styling #65 [feature] theme: improve readability #64 [feature] menu: show hidden pages if accessed directly #60 [feature][change] theme: treat pages without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates for pre/post menu entries #56 [feature] theme: make chapter archetype more readable #55 [feature] children: add parameter for container style #53 [feature] theme: make content a template #50 [feature] menu: control menu expansion with alwaysopen parameter #49 [feature] include: new shortcode to include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highlighter: switch to standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sorting ignores ordersectionsby #63 [bug][change] children: default sorting ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden pages #61 [bug] theme: remove superfluous singular taxonomy from taxonomy title #46 [bug][change] theme: missing –MENU-HOME-LINK-HOVER-color in documentation #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog in exampleSite #33",
"description": "2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigation respect ordersectionsby configuration #170",
"tags": [],
"title": "Version 2",
"uri": "/hugo-theme-relearn/introduction/changelog/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "2.9.0 (2021-11-19) Breaking Breaking This release removes the themes implementation of ref/relref in favor for Hugo’s standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.\nIn a standard compliant form you must not link to the *.md file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:\nType Non-Standard Standard Branch bundle configuration/reference/_index.md configuration/reference Leaf bundle configuration/reference/index.md configuration/reference Page configuration/reference.md configuration/reference If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but Hugo got you covered as well.\nAlso, the old themes implementation allowed refs to non-existing content. This will cause Hugo’s implementation to show the error below and abort the generation. If your project relies on this old behavior, you can reconfigure the error handling of Hugo’s implementation.\nIn the best case your usage of the old implementation is already standard compliant and you don’t need to change anything. You’ll notice this very easily once you’ve started hugo server after an upgrade and no errors are written to the console.\nYou may see errors on the console after the update in the form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"configuration/reference/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": page not found In this case, you must apply one of two options:\nStart up a text editor with regular expression support for search and replace. Search for (ref\\s+\"[^\"]*?)(?:/_index|/index)?(?:\\.md)?(#[^\"]*?)?\" and replace it by $1$2\" in all *.md files. This is the recommended choice.\nCopy the old implementation files theme/hugo-theme-relearn/layouts/shortcode/ref.html and theme/hugo-theme-relearn/layouts/shortcode/relref.html to your own projects layouts/shortcode/ref.html and layouts/shortcode/relref.html respectively. This is not recommended as your project will still rely on non-standard behavior afterwards. 2.8.0 (2021-11-03) Change Change Although never officially documented, this release removes the font Novacento/Novecento. If you use it in an overwritten CSS please replace it with Work Sans. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for Czech. New New The theme now supports favicons served from static/images/ named as favicon or logo in SVG, PNG or ICO format out of the box. An overridden partial layouts/partials/favicon.html may not be necessary anymore in most cases.\nNew You can hide the table of contents menu for the whole site by setting the disableToc option in your hugo.toml. For an example see the example configuration. 2.7.0 (2021-10-24) New New Optional second parameter for notice shortcode to set title in box header. 2.6.0 (2021-10-21) New New Your site can now be served from a subdirectory if you set baseURL in your hugo.toml. See the documentation for a detailed example. 2.5.0 (2021-10-08) Change Change New colors --CODE-BLOCK-color and --CODE-BLOCK-BG-color were added to provide a fallback for Hugo’s syntax highlighting in case no language was given or the language is unsupported. Ideally the colors are set to the same values as the ones from your chosen chroma style. 2.4.0 (2021-10-07) Change Change Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included. New New Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your hugo.toml.\nNew You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your hugo.toml. Please see further documentation for possible values and default behavior.\nNew New front matter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.\nNew Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation. 2.3.0 (2021-09-13) Hugo 0.81.0 0.81.0 This release requires a newer Hugo version. New New Showcase multilanguage features by providing a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Piratish one due to maintenance constraints. 2.2.0 (2021-09-09) New New Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting disableSeoHiddenPages=true in your hugo.toml. 2.1.0 (2021-09-07) Hugo 0.69.0 0.69.0 This release requires a newer Hugo version. Change Change In case the site’s structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in the exampleSite), they will now be ignored by the search. New New Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your hugo.toml.\nNew If a search term is found in an expand shortcode, the expand will be opened.\nNew The menu will scroll the active item into view on load. 2.0.0 (2021-08-28) Change Change Syntax highlighting was switched to the built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation\nChange In the predefined stylesheets there was a typo and --MENU-HOME-LINK-HOVERED-color must be changed to --MENU-HOME-LINK-HOVER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange --MENU-HOME-LINK-color and --MENU-HOME-LINK-HOVER-color were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.\nChange Arrow navigation and children shortcode were ignoring setting for ordersectionsby. This is now changed and may result in different sorting order of your sub pages.\nChange If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.\nChange A page without a title will be treated as hidden=true.\nNew New You can define the expansion state of your menus in the front matter. Please see further documentation for possible values and default behavior.\nNew New partials for defining pre/post content for menu items and the content. See documentation for further reading.\nNew Shortcode children with new parameter containerstyle.\nNew New shortcode include to include arbitrary file content into a page.",
"description": "2.9.0 (2021-11-19) Breaking Breaking This release removes the themes implementation of ref/relref in favor for Hugo’s standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.",
"tags": [],
"title": "Version 2",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.2.0 (2021-09-09) Enhancements [feature] sitemap: hide hidden pages from sitemap and SEO indexing #85 Fixes [bug] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary to schema #84",
"description": "2.2.0 (2021-09-09) Enhancements [feature] sitemap: hide hidden pages from sitemap and SEO indexing #85 Fixes [bug] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary to schema #84",
"tags": [],
"title": "Version 2.2",
"uri": "/hugo-theme-relearn/introduction/changelog/2/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.2.0 (2021-09-09) New New Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting disableSeoHiddenPages=true in your hugo.toml.",
"description": "2.2.0 (2021-09-09) New New Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting disableSeoHiddenPages=true in your hugo.toml.",
"tags": [],
"title": "Version 2.2",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.2.1 (2022-03-25) Fixes [bug] print: fix minor inconsistencies #225 [bug] print: show more than just the title page #224 [bug] theme: align content scrollbar to the right on big screens #223 3.2.0 (2022-03-19) Enhancements [feature][change] mermaid: support differing themes for color variant switch #219 [feature] mermaid: load javascript on demand #218 Maintenance [task] mermaid: update to 8.14.0 #220",
"description": "3.2.1 (2022-03-25) Fixes [bug] print: fix minor inconsistencies #225 [bug] print: show more than just the title page #224 [bug] theme: align content scrollbar to the right on big screens #223",
"tags": [],
"title": "Version 3.2",
"uri": "/hugo-theme-relearn/introduction/changelog/3/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "3.2.0 (2022-03-19) Hugo 0.93.0 0.93.0 This release requires a newer Hugo version. Change Change In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Markdown codefences. This changes the behavior of disableMermaid config option as follows: If a Mermaid shortcode or Markdown codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.\nThe option is still useful in case you are using scripting to set up your graph. In this case no shortcode or Markdown codefence is involved and the library is not loaded by default. In this case you can set disableMermaid=false in your front matter to force the library to be loaded. See the theme variant generator of the exampleSite for an example.\nNew New Additional color variant variable --MERMAID-theme to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant.",
"description": "3.2.0 (2022-03-19) Hugo 0.93.0 0.93.0 This release requires a newer Hugo version. Change Change In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Markdown codefences. This changes the behavior of disableMermaid config option as follows: If a Mermaid shortcode or Markdown codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.",
"tags": [],
"title": "Version 3.2",
"uri": "/hugo-theme-relearn/introduction/releasenotes/3/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 4",
"content": "4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not load in documentation #285 [bug] children: descriptions not working #284 [bug] print: fix empty page for shortcut links #283 4.2.4 (2022-06-23) Fixes [bug] theme: fix url for logo and home button #282 4.2.3 (2022-06-23) Fixes [bug][breaking] include: second parameter is ignored #281 4.2.2 (2022-06-23) No changelog for this release. 4.2.1 (2022-06-23) No changelog for this release. 4.2.0 (2022-06-23) Enhancements [feature][change] tabs: don’t change tab selection if panel does not contain item #279 [feature] shortcodes: convert to partials #277 Fixes [bug] swagger: avoid builtin syntaxhighlighting #280 [bug] search: fix console message for missing lunr translations #278 [bug] tabs: fix wrapping when having many tabs #272",
"description": "4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not load in documentation #285 [bug] children: descriptions not working #284 [bug] print: fix empty page for shortcut links #283",
"tags": [],
"title": "Version 4.2",
"uri": "/hugo-theme-relearn/introduction/changelog/4/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 4",
"content": "4.2.0 (2022-06-23) Breaking Breaking The second parameter for the include shortcode was switched in meaning and was renamed from showfirstheading to hidefirstheading. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.\nIf you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.\nChange Change Previously, if the tabs shortcode could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.\nChange The landingPageURL was removed from hugo.toml. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically and will point to the project’s home page. If you want to support a different link, overwrite the logo.html partial.\nNew New All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.",
"description": "4.2.0 (2022-06-23) Breaking Breaking The second parameter for the include shortcode was switched in meaning and was renamed from showfirstheading to hidefirstheading. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.",
"tags": [],
"title": "Version 4.2",
"uri": "/hugo-theme-relearn/introduction/releasenotes/4/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter pages overwrite font-size #328 5.2.2 (2022-08-23) Fixes [bug] print: fix urls for uglyURLs=true #322 5.2.1 (2022-08-05) Enhancements [feature] i18n: improve Japanese translation #318 Fixes [bug] nav: prev/next ignores ordersectionby #320 Maintenance [task] task: bump Hugo minimum requirement to 0.95 #319 5.2.0 (2022-08-03) Enhancements [feature][change] menu: expand collapsed menus if search term is found in submenus #312 Fixes [bug] print: switch mermaid and swagger style before print #316 [bug] theme: fix chapter margins on big screens #315",
"description": "5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter pages overwrite font-size #328",
"tags": [],
"title": "Version 5.2",
"uri": "/hugo-theme-relearn/introduction/changelog/5/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.2.0 (2022-08-03) Change Change If you’ve set collapsibleMenu = true in your hugo.toml, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus.",
"description": "5.2.0 (2022-08-03) Change Change If you’ve set collapsibleMenu = true in your hugo.toml, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus.",
"tags": [],
"title": "Version 5.2",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "6.2.0 (2024-08-26) Enhancements [feature][change] anchor: add option to scroll into view #886 [feature] theme: support for GitHub styled alerts #885 Fixes [bug] arrownav: avoid rude event handling for form elements #887 Maintenance [task] 404: move styles to separate file #889",
"description": "6.2.0 (2024-08-26) Enhancements [feature][change] anchor: add option to scroll into view #886 [feature] theme: support for GitHub styled alerts #885 Fixes [bug] arrownav: avoid rude event handling for form elements #887 Maintenance [task] 404: move styles to separate file #889",
"tags": [],
"title": "Version 6.2",
"uri": "/hugo-theme-relearn/introduction/changelog/6/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "6.2.0 (2024-08-26) Change Change The heading anchor links are extended in functionality.\nIf you now click on it, not only is the link copied to the clipboard (previous behavior) but also the heading scrolls to the top of the page.\nIf you dislike the new behavior, you can deactivate it by setting disableAnchorScrolling=true in your hugo.toml. See the docs for further options.\nNew New If you are running Hugo 0.132.0 or later, the theme is now capable to print GitHub alerts.\nNew To support new severity levels for GitHub alerts, all shortcodes that support severity levels with their style parameter were expanded with the new severities caution and important and the color parameter was expanded with cyan and magenta. Please note, that coloring and icons of severities may defer from the display you see on GitHub.\nNew To support new severity levels for GitHub alerts, the new severities and their according colors are also available as CSS variables BOX-MAGENTA-color, BOX-MAGENTA-TEXT-color, BOX-CAUTION-color, BOX-CAUTION-TEXT-color, BOX-CYAN-color, BOX-CYAN-TEXT-color, BOX-IMPORTANT-color, BOX-IMPORTANT-TEXT-color. You don’t need to change anything in your custom color stylesheet as appropriate default colors will be used.",
"description": "6.2.0 (2024-08-26) Change Change The heading anchor links are extended in functionality.",
"tags": [],
"title": "Version 6.2",
"uri": "/hugo-theme-relearn/introduction/releasenotes/6/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes and attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add option to open on page load #25 [feature] expand: rework styling #24 [feature] attachments: sort output #23 [feature] notice: make restyling of notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors to common standards #18 [feature] notice: use distinct icons for notice box type #17 Fixes [bug] attachments: support i18n for attachment size #21 [bug] notice: support i18n for box labels #16 [bug] notice: support multiple blocks in one box #15 Maintenance [task] dependency: upgrade jquery to 3.6.0 #30 1.1.1 (2021-07-04) Maintenance [task] theme: prepare for new hugo theme registration #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose options in config.toml #4 Fixes [bug] mermaid: config option for CDN url not used #12 [bug] mermaid: only highlight text in HTML elements #10 [bug] mermaid: support pan \u0026 zoom for graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on load may bomb chart #5 Maintenance [task] mermaid: update to 8.10.2 #7 1.0.1 (2021-07-01) Maintenance [task] Prepare for hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1",
"description": "1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes and attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add option to open on page load #25 [feature] expand: rework styling #24 [feature] attachments: sort output #23 [feature] notice: make restyling of notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors to common standards #18 [feature] notice: use distinct icons for notice box type #17 Fixes [bug] attachments: support i18n for attachment size #21 [bug] notice: support i18n for box labels #16 [bug] notice: support multiple blocks in one box #15 Maintenance [task] dependency: upgrade jquery to 3.6.0 #30",
"tags": [],
"title": "Version 1",
"uri": "/hugo-theme-relearn/introduction/changelog/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "1.2.0 (2021-07-26) New New Shortcode expand with new parameter to open on page load. 1.1.0 (2021-07-02) Breaking Breaking Mermaid diagrams can now be panned and zoomed. This isn’t configurable yet. New New Mermaid config options can be set in hugo.toml. 1.0.0 (2021-07-01) Hugo 0.65.0 0.65.0 The requirement for the Hugo version of this theme is the same as for the Learn theme version 2.5.0 on 2021-07-01. New New Initial fork of the Learn theme based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to Relearn and a new logo. For the reasons behind forking the Learn theme, see this comment in the Learn issues.",
"description": "1.2.0 (2021-07-26) New New Shortcode expand with new parameter to open on page load.",
"tags": [],
"title": "Version 1",
"uri": "/hugo-theme-relearn/introduction/releasenotes/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 1",
"content": "1.1.1 (2021-07-04) Maintenance [task] theme: prepare for new hugo theme registration #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose options in config.toml #4 Fixes [bug] mermaid: config option for CDN url not used #12 [bug] mermaid: only highlight text in HTML elements #10 [bug] mermaid: support pan \u0026 zoom for graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on load may bomb chart #5 Maintenance [task] mermaid: update to 8.10.2 #7",
"description": "1.1.1 (2021-07-04) Maintenance [task] theme: prepare for new hugo theme registration #13",
"tags": [],
"title": "Version 1.1",
"uri": "/hugo-theme-relearn/introduction/changelog/1/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 1",
"content": "1.1.0 (2021-07-02) Breaking Breaking Mermaid diagrams can now be panned and zoomed. This isn’t configurable yet. New New Mermaid config options can be set in hugo.toml.",
"description": "1.1.0 (2021-07-02) Breaking Breaking Mermaid diagrams can now be panned and zoomed. This isn’t configurable yet. New New Mermaid config options can be set in hugo.toml.",
"tags": [],
"title": "Version 1.1",
"uri": "/hugo-theme-relearn/introduction/releasenotes/1/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.1.0 (2021-09-07) Enhancements [feature] search: open expand if it contains search term #80 [feature] menu: scroll active item into view #79 [feature] search: disable search in hidden pages #76 [feature] search: improve readability of index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site content #81 [bug] menu: always hide hidden sub pages #77",
"description": "2.1.0 (2021-09-07) Enhancements [feature] search: open expand if it contains search term #80 [feature] menu: scroll active item into view #79 [feature] search: disable search in hidden pages #76 [feature] search: improve readability of index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site content #81 [bug] menu: always hide hidden sub pages #77",
"tags": [],
"title": "Version 2.1",
"uri": "/hugo-theme-relearn/introduction/changelog/2/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.1.0 (2021-09-07) Hugo 0.69.0 0.69.0 This release requires a newer Hugo version. Change Change In case the site’s structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in the exampleSite), they will now be ignored by the search. New New Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your hugo.toml.\nNew If a search term is found in an expand shortcode, the expand will be opened.\nNew The menu will scroll the active item into view on load.",
"description": "2.1.0 (2021-09-07) Hugo 0.69.0 0.69.0 This release requires a newer Hugo version. Change Change In case the site’s structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in the exampleSite), they will now be ignored by the search. New New Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your hugo.toml.",
"tags": [],
"title": "Version 2.1",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.1.1 (2022-03-16) Enhancements [feature] i18n: add Korean translation #217 3.1.0 (2022-03-15) Enhancements [feature] notice: add icon parameter #212 [feature] mobile: remove breadcrumb ellipsis #211 Fixes [bug] theme: make storage of multiple Hugo sites on same server distinct #214 [bug] variant: switch breadcrumb color in Chrome #213 [bug] mobile: improve behavior of sidebar menu #210",
"description": "3.1.1 (2022-03-16) Enhancements [feature] i18n: add Korean translation #217 3.1.0 (2022-03-15) Enhancements [feature] notice: add icon parameter #212 [feature] mobile: remove breadcrumb ellipsis #211 Fixes [bug] theme: make storage of multiple Hugo sites on same server distinct #214 [bug] variant: switch breadcrumb color in Chrome #213 [bug] mobile: improve behavior of sidebar menu #210",
"tags": [],
"title": "Version 3.1",
"uri": "/hugo-theme-relearn/introduction/changelog/3/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "3.1.0 (2022-03-15) New New attachment and notice shortcodes have a new parameter to override the default icon. Allowed values are all Font Awesome 5 Free icons.",
"description": "3.1.0 (2022-03-15) New New attachment and notice shortcodes have a new parameter to override the default icon. Allowed values are all Font Awesome 5 Free icons.",
"tags": [],
"title": "Version 3.1",
"uri": "/hugo-theme-relearn/introduction/releasenotes/3/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 4",
"content": "4.1.1 (2022-06-18) Fixes [bug] notice: fix layout when content starts with heading #275 4.1.0 (2022-06-12) Enhancements [feature] i18n: support multilang content #271",
"description": "4.1.1 (2022-06-18) Fixes [bug] notice: fix layout when content starts with heading #275",
"tags": [],
"title": "Version 4.1",
"uri": "/hugo-theme-relearn/introduction/changelog/4/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 4",
"content": "4.1.0 (2022-06-12) New New While fixing issues with the search functionality for non Latin languages, you can now configure to have multiple languages on a single page.",
"description": "4.1.0 (2022-06-12) New New While fixing issues with the search functionality for non Latin languages, you can now configure to have multiple languages on a single page.",
"tags": [],
"title": "Version 4.1",
"uri": "/hugo-theme-relearn/introduction/releasenotes/4/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme to light #313 [bug] mermaid: header is showing up in FF #311 5.1.1 (2022-07-15) Fixes [bug] tags: don’t count tags if page is hidden #310 5.1.0 (2022-07-15) Enhancements [feature][change] print: make print url deterministic #309 [feature] theme: allow overriding partials for output formats #308",
"description": "5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme to light #313 [bug] mermaid: header is showing up in FF #311",
"tags": [],
"title": "Version 5.1",
"uri": "/hugo-theme-relearn/introduction/changelog/5/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.1.0 (2022-07-15) Hugo 0.95.0 0.95.0 This release requires a newer Hugo version. Change Change Because the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a index.print.html to the default URL.\nYou can revert this behavior by overwriting the print output format setting in your hugo.tomlto:\nhugo. toml yaml json [outputFormats] [outputFormats.print] baseName = 'index' isHTML = true mediaType = 'text/html' name = 'print' path = '_print' permalinkable = false outputFormats: print: baseName: index isHTML: true mediaType: text/html name: print path: _print permalinkable: false { \"outputFormats\": { \"print\": { \"baseName\": \"index\", \"isHTML\": true, \"mediaType\": \"text/html\", \"name\": \"print\", \"path\": \"_print\", \"permalinkable\": false } } }",
"description": "5.1.0 (2022-07-15) Hugo 0.95.0 0.95.0 This release requires a newer Hugo version. Change Change Because the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a index.print.html to the default URL.",
"tags": [],
"title": "Version 5.1",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "6.1.1 (2024-08-02) Fixes [bug] link: link resolving stopped working in certain configurations #882 6.1.0 (2024-08-02) Enhancements [feature][change] assetbuster: use asset buster for all resources #875 [feature] theme: sync to Hugo changes for PublishDate #872 [feature] theme: allow errorlevel override on page level #870 [feature] relref: provide shortcodes to lift certain restrictions #864 [feature] openapi: adjust to Hugo’s build-in link render hook #860 [feature][change] include: adjust to Hugo’s build-in link render hook #859 Fixes [bug] variant: auto variant references potentially wrong chroma style #873 [bug] schema: sync to Hugo changes for LanguageCode #866 [bug] taxonomy: simplify code #852 [bug] alias: index.html has displays error in content #851 Maintenance [task] icon: update Font Awesome to 6.6.0 #881 [task] math: update MathJax to 3.2.2 #880 [task] openapi: update swagger-ui to 5.17.14 #879 [task] mermaid: update to 10.9.1 #878 [task] theme: remove special cases for LanguageCode #861 [task] link: adjust to Hugo’s build-in code #858 [task] image: adjust to Hugo’s build-in code #857 [task] opengraph: sync to Hugo’s implementation #856 [task] i18n: improve file naming #848",
"description": "6.1.1 (2024-08-02) Fixes [bug] link: link resolving stopped working in certain configurations #882",
"tags": [],
"title": "Version 6.1",
"uri": "/hugo-theme-relearn/introduction/changelog/6/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "6.1.0 (2024-08-02) Change Change The include shortcode is now able to resolve links to pages as well as resources or files in the file system (the old behavior).\nChange To make the asset buster mechanism more robust, some internally used stylesheets where restructured. This generally should not affect your page in any negative way.\nNew New The openapi shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting openapi.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.\nNew Shortcodes supporting an errorlevel configuration can now have overridden values in the front matter section of each individual page.\nNew The theme now comes with its own overridden version of the relref shortcode.\nWhile the usage of relref is obsolete and discouraged by Hugo for a while, existing installations may use it. In configurations using a baseURL with a subdirectory, and having relativeURLs=false (the default) Hugo’s standard relref implementation was failing.\nThe shortcode is deactivated by default and can be activated by setting\nhugo. toml yaml json [params] disableDefaultRelref = true params: disableDefaultRelref: true { \"params\": { \"disableDefaultRelref\": true } } in your hugo.toml. Only do this if your site fulfills all of the above assumptions.",
"description": "6.1.0 (2024-08-02) Change Change The include shortcode is now able to resolve links to pages as well as resources or files in the file system (the old behavior).",
"tags": [],
"title": "Version 6.1",
"uri": "/hugo-theme-relearn/introduction/releasenotes/6/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 7",
"content": "7.1.0 (2024-10-24) Enhancements [feature][change] children: use LinkTitle instead of Title #939 [feature][change] menu: support nested Hugo menus #423 [feature] menu: support for external links #148 Fixes [bug] search: wrong searchindex URL with multilang per server config #940",
"description": "7.1.0 (2024-10-24) Enhancements [feature][change] children: use LinkTitle instead of Title #939 [feature][change] menu: support nested Hugo menus #423 [feature] menu: support for external links #148 Fixes [bug] search: wrong searchindex URL with multilang per server config #940",
"tags": [],
"title": "Version 7.1",
"uri": "/hugo-theme-relearn/introduction/changelog/7/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 7",
"content": "7.1.0 (2024-10-24) Change Change The sidebar menus are now completely configurable.\nThis is provided by the new parameter sidebarmenus. With the new system, you can\nshow arbitrary amounts of menus set headings for each menu base it on your page structure or use Hugo’s menu feature configure a starting page if a menu is based on page structure display unlimited nesting for both menu types reconfigure the menus in a page’s front matter apply the usual parameter alwaysopen, collapsibleMenu, etc. for all menu types You don’t need to change anything in your existing installation as the old configuration is used as a default.\nChange The children shortcode was changed to output a page’s LinkTitle instead of previously using the Title.\nAs the shortcode always outputs subpages in context of the parent page, it functions similar to the sidebar menu. The sidebar menu itself uses the LinkTitle for naming the menu entries and so should the shortcode do.\nThe parameter value sort=linktitle was deprecated for the easier sort=title. You can still use the old value but both behave the same way in sorting by LinkTitle.\nNew New Menus created by your page structure are now able to contain arbitrary links inserted into the structure using the menuUrl or menuPageRef front matter.",
"description": "7.1.0 (2024-10-24) Change Change The sidebar menus are now completely configurable.",
"tags": [],
"title": "Version 7.1",
"uri": "/hugo-theme-relearn/introduction/releasenotes/7/1/index.html"
},
{
"breadcrumb": "Authoring",
"content": "In Hugo, pages are the core of your site.\nThe theme generates the navigation menu out of the given directory structure.\nOrganize your site like any other Hugo project. Typically, you will have a content directory with all your pages.\ncontent ├── first-chapter │ ├── first-page | | |── _index.md | │ ├── first-sub-page | | | |── _index.md | | | |── picture1.png | | | └── plain.txt │ ├── second-page | | |── index.md | | |── picture1.png | | └── picture2.png │ └── third-page.md └── _index.md Note While you can also go different, _index.md (with an underscore) is recommended for each directory, it’s your directory’s home page.\nSee Hugo’s guide for content to learn more.",
"description": "Your content's directory structure",
"tags": [],
"title": "Directory Structure",
"uri": "/hugo-theme-relearn/authoring/structure/index.html"
},
{
"breadcrumb": "Configuration \u003e Site Management",
"content": "If you’ve followed the Getting Started guide, your directory layout will look similar to this:\n├── content │ ├── first-chapter │ │ ├── first-page | | | └── _index.md │ │ ├── second-page | | | └── index.md │ │ └── third-page.md │ └── _index.md ├── themes │ └── hugo-theme-relearn │ └── ... └── hugo.toml Hugo uses a union file system, which lets you combine multiple directories.\nBy default, it puts your root directory on top of the Relearn theme directory. Files in your root directory will replace theme files in the same location.\nFor example, if you create a file at layouts/partials/heading.html, it will override the theme’s themes/hugo-theme-relearn/layouts/partials/heading.html.\nSee this list, to learn which files are allowed to be modified by you.\nThis makes it easy to customize the theme without changing files in the themes directory, making future theme updates simpler.\nWarning Don’t edit files inside the themes/hugo-theme-relearn directory. That’s not the recommended way to customize! Refer to the explanation above.\nDon’t clone the theme repository and edit files there for your site. That’s not the recommended way to customize! Instead, follow the Getting Started guide.",
"description": "Your site's directory structure",
"tags": [],
"title": "Directory Structure",
"uri": "/hugo-theme-relearn/configuration/sitemanagement/structure/index.html"
},
{
"breadcrumb": "Introduction",
"content": "Here’s how to start your new website. If you’re new to Hugo, we recommend learning more about it in its excellent starter’s guide.\nInstall Hugo Download and install Hugo 0.126.0 or newer for your operating system following the instructions.\nThe standard edition of Hugo is sufficient but you can also use the extended edition.\nCreate your Project Use Hugo’s new site command to make a new website\nhugo new site my-new-site Then move into the new directory\ncd my-new-site Run all future commands from this directory.\nInstall the Theme Download as a Zip File You can download the theme as a .zip file and unzip it into the themes/hugo-theme-relearn directory.\nThen add this at the top of your hugo.toml\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Use Hugo’s Module System Install the Relearn theme using Hugo’s module system\nhugo mod init example.com Then add this at the end of your hugo.toml\nhugo. toml yaml json [module] [[module.imports]] path = 'github.com/McShelby/hugo-theme-relearn' module: imports: - path: github.com/McShelby/hugo-theme-relearn { \"module\": { \"imports\": [ { \"path\": \"github.com/McShelby/hugo-theme-relearn\" } ] } } Use as a Git Submodule If you’re using Git for your project, you can create a repository now\ngit init Add the theme as a Git submodule\ngit submodule add --depth 1 https://github.com/McShelby/hugo-theme-relearn.git themes/hugo-theme-relearn Then add this at the top of your hugo.toml\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Create your Home Page Start by making a home page\nhugo new --kind home _index.md The new home page file content/_index.md has two parts: the page info (like title) at the top, called front matter, and the page content below.\nCreate your First Chapter Page Chapters are top-level pages that contain other pages. They have a special layout.\nMake your first chapter page\nhugo new --kind chapter first-chapter/_index.md The new file content/first-chapter/_index.md has a weight number in the front matter. This sets the chapter’s subtitle and its order in the menu.\nCreate your First Content Pages Now make content pages inside the chapter. Here are three ways to do this\nhugo new first-chapter/first-page/_index.md hugo new first-chapter/second-page/index.md hugo new first-chapter/third-page.md Hugo treats these files differently based on their file names. Learn more in Hugo’s guide.\nFeel free to edit these files. Change the title, add a weight if you want, and write your content.\nTest your Website Locally Start your new website on your computer with this command\nhugo serve Open http://localhost:1313 in your web browser.\nYou can keep the server running while you edit. The browser will update automatically when you save changes.\nIt’s a kind of magic\nBuild and Deploy your Website When your site is ready to go live, run this command\nhugo This creates a public directory with all your website files.\nYou can upload this directory to any web server, or use one of Hugo’s many other ways to publish.\nNext Steps Your site is now fully functional.\nYou can continue configuring your site to your needs.\nOr just start authoring content and discover what’s possible.",
"description": "Initialize your website in a few simple steps",
"tags": [],
"title": "Getting Started",
"uri": "/hugo-theme-relearn/introduction/quickstart/index.html"
},
{
"breadcrumb": "",
"content": "Discover what this Hugo theme is all about.\nGetting StartedInitialize your website in a few simple steps\nTool IntegrationAll about supported 3rd party tools\nWhat's NewWhat's new in this version\nChangelogThe detailed changelog",
"description": "Discover what this Hugo theme is all about.\nGetting StartedInitialize your website in a few simple steps",
"tags": [],
"title": "Introduction",
"uri": "/hugo-theme-relearn/introduction/index.html"
},
{
"breadcrumb": "Configuration \u003e Branding",
"content": "Change the Favicon If your favicon is an SVG, PNG, or ICO, just drop your image in your site’s static/images/ directory and name it favicon.svg, favicon.png, or favicon.ico respectively.\nIf you want to adjust your favicon according to your OS settings for light/dark mode, add the image files static/images/favicon-light.svg and static/images/favicon-dark.svg to your site’s directory, respectively, corresponding to your file format. In case some of the files are missing, the theme falls back to favicon.svg for each missing file. All supplied favicons must be of the same file format.\nIf no favicon file is found, the theme will look up the alternative filename logo in the same location and will repeat the search for the list of supported file types.\nIf you need to change this default behavior, create a new file layouts/partials/favicon.html in your site’s directory and write something like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change the Logo By default, only your site title will be shown at the top of the menu. You can configure this, or override the logo partial.\nCreate a new file in layouts/partials/logo.html of your site. Then write any HTML you want. You could use an img HTML tag and reference an image, or you could paste an SVG definition!\nThe size of the logo will adapt automatically.",
"description": "Provide your own logo and favicon",
"tags": [],
"title": "Logo",
"uri": "/hugo-theme-relearn/configuration/branding/logo/index.html"
},
{
"breadcrumb": "Authoring \u003e Front Matter",
"content": "A page is displayed by exactly one page design and represented by Hugo’s reserved type front matter.\nThe Relearn theme offers the page designs home, chapter, and default but you can define further custom page designs.\nRegardless of shipped or custom page design, you are using them in the same way.\nIf you have an archetype file, you can just do\nhugo new --kind chapter chapter1/_index.md If you are creating your Markdown files manually, you can achieve the same by just setting type='chapter' in the front matter.\nYour resulting Markdown file needs to have at least the type front matter set to the value of the page design\n​ _index.md +++ title = \"Chapter 1\" type = \"chapter\" +++ Predefined Designs Home A Home page is the starting page of your project. It’s best to have only one page of this kind in your project.\nTo create a home page, run the following command\nhugo new --kind home _index.md Chapter A Chapter displays a page meant to be used as introduction for a set of child pages.\nCommonly, it contains a title front matter and a short description in the content.\nTo create a chapter page, run the following command\nhugo new --kind chapter chapter1/_index.md If a numerical weight front matter is set, it will be used to generate the subtitle of the chapter page. Set the number to a consecutive value starting at 1 for each new chapter on the same directory level.\nDefault A Default page is any other content page.\nTo create a default page, run either one of the following commands\nhugo new chapter1/page1/_index.md or\nhugo new chapter1/page1.md",
"description": "How to vary layouts by using page designs",
"tags": [],
"title": "Page Designs",
"uri": "/hugo-theme-relearn/authoring/frontmatter/designs/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children",
"content": "This is a plain demo child page X.",
"description": "This is a plain page test, and the beginning of a YAML multiline description...",
"tags": [
"Children"
],
"title": "page X",
"uri": "/hugo-theme-relearn/shortcodes/children/test/index.html"
},
{
"breadcrumb": "Configuration \u003e Customization",
"content": "Usable Partials You can call other partials from themes/hugo-relearn-themes/ besides those in themes/hugo-relearn-themes/layouts/partials/_relearn. However, using partials not mentioned as customizable below might make future updates more challenging.\nCustomizable Partials The Relearn theme allows you to customize various parts of the theme by overriding partials. This makes the theme highly configurable.\nA good rule to follow: The less code a partial contains, the easier it will be to update the theme in the future.\nHere’s a list of partials you can safely override:\nlayouts/partials/content.html: The main content of a page. Override this to display additonal page metadata.\nlayouts/partials/content-header.html: The header above the title. By default, it shows tags, but you can change this.\nlayouts/partials/content-footer.html: The footer below the content. By default, it shows author info, modification dates, and categories. You can customize this.\nlayouts/partials/custom-header.html: For adding custom CSS. Remember to include the style HTML tag.\nlayouts/partials/custom-footer.html: For adding custom JavaScript. Remember to include the script HTML tag.\nlayouts/partials/favicon.html: The favicon. You should definitely customize this.\nlayouts/partials/heading.html: the page’s title headings\nlayouts/partials/heading-pre.html: Add content before the page’s title headings. Remember to consider the headingPre front matter.\nlayouts/partials/heading-post.html: Add content after the page’s title headings. Remember to consider the headingPost front matter.\nlayouts/partials/logo.html: The logo in the top left corner. You should customize this.\nlayouts/partials/menu-pre.html: Add content before menu items. Remember to consider the menuPre front matter.\nlayouts/partials/menu-post.html: Add content after menu items. Remember to consider the menuPost front matter.\nlayouts/partials/menu-footer.html: The footer of the left menu.\nYou can override other partials from themes/hugo-relearn-themes/, but be careful as this might make future updates more difficult.",
"description": "Modifying partials to your needs",
"tags": [],
"title": "Partials",
"uri": "/hugo-theme-relearn/configuration/customization/partials/index.html"
},
{
"breadcrumb": "Configuration",
"content": "Directory StructureYour site's directory structure\nMultilingualHow to set up a multilingual site\nMeta InformationWhat site-wide meta information can be set\nDeployment ScenariosOptions for specific deployment needs\nAvailable Output FormatsWhat other formats can a page be displayed in\nStable OutputHow to make your generated HTML output stable",
"description": "Get yourself familiar with the general structure of your website",
"tags": [],
"title": "Site Management",
"uri": "/hugo-theme-relearn/configuration/sitemanagement/index.html"
},
{
"breadcrumb": "Configuration \u003e Content",
"content": "The theme adjusts the content width when you resize your browser.\nIf you want to change the chosen default width, you can add CSS variables to layouts/partials/custom-header.html.\nChanging the Main Area’s Maximum Width The main area has a default maximum width of 80.25rem for better readability. If you want to change this, you can set a CSS variable\nFor full width, use a large value like 1000rem.\n​ layouts/partials/custom-header.html \u003cstyle\u003e :root { --MAIN-WIDTH-MAX: 1000rem; } \u003c/style\u003e",
"description": "Changing the content area width",
"tags": [],
"title": "Width",
"uri": "/hugo-theme-relearn/configuration/content/width/index.html"
},
{
"breadcrumb": "Configuration \u003e Sidebar",
"content": "The theme adjusts the menu width based on browser size.\nIf you want to change the chosen default width, you can add CSS variables to layouts/partials/custom-header.html.\nChanging Menu Width The menu width changes for different screen sizes:\nScreen Size Screen Width Menu Width Small \u003c 48rem 14.375rem Medium 48rem - 60rem 14.375rem Large \u003e= 60rem 18.75rem You can change the menu width but not the screen width breakpoints.\nTo adjust the menu width, use these CSS variables. Note that --MENU-WIDTH-S is for the mobile menu flyout on small screens.\n​ layouts/partials/custom-header.html \u003cstyle\u003e :root { --MENU-WIDTH-S: 14.375rem; --MENU-WIDTH-M: 14.375rem; --MENU-WIDTH-L: 18.75rem; } \u003c/style\u003e",
"description": "Changing the width of the sidebar",
"tags": [],
"title": "Width",
"uri": "/hugo-theme-relearn/configuration/sidebar/width/index.html"
},
{
"breadcrumb": "Configuration",
"content": "LogoProvide your own logo and favicon\nColorsLearn how to customize your site's colors\nModule ThemingColors of syntax highlighting and 3rd-party modules\nStylesheet GeneratorAn interactive tool to generate color variant stylesheets",
"description": "Change colors and logos of your site",
"tags": [],
"title": "Branding",
"uri": "/hugo-theme-relearn/configuration/branding/index.html"
},
{
"breadcrumb": "Configuration \u003e Branding",
"content": "The Relearn theme offers color variants to change your site’s appearance. Each color variant contains of a CSS file and optional settings in your hugo.toml.\nYou can use the shipped variants, customize them, or create your own. The interactive variant generator can help you with this.\nOnce set up in hugo.toml, you can switch variants using the selector at the bottom of the menu.\nShipped Variants The theme ships with the following set of variants\nRelearn Light: the classic Relearn default, coming with signature green, dark sidebar and light content area Dark: dark variant of Light, coming with signature green, dark sidebar and dark content area Bright: alternative of Light, coming with signature green, green sidebar and light content area Zen Light: a more relaxed white/grey variant, coming with blue accents, light sidebar and light content area Dark: dark variant of Light, coming with blue accents, dark sidebar and dark content area Experimental Neon: a variant that glows in the dark, gradient sidebar and dark content area Retro Learn: the default of the old Learn theme, coming with signature light purple, dark sidebar and light content area Blue: a blue variant of the old Learn theme, coming tinted in blue, dark sidebar and light content area Green: a green variant of the old Learn theme, coming tinted in green, dark sidebar and light content area Red: a red variant of the old Learn theme, coming tinted in red, dark sidebar and light content area Changing the Variant Option Set the themeVariant option to change the variant.\nThe theme offers the recommended advanced configuration mode that combines the functionality for multiple variants, OS setting adjustments, and more.\nSimple Setup Single Variant Set themeVariant to your theme CSS file name:\nhugo. toml yaml json [params] themeVariant = 'relearn-light' params: themeVariant: relearn-light { \"params\": { \"themeVariant\": \"relearn-light\" } } Place your theme file in assets/css or themes/hugo-theme-relearn/assets/css. Name it theme-*.css.\nIn the above example, the path of your theme file must be assets/css/theme-relearn-light.css or themes/hugo-theme-relearn/assets/css/theme-relearn-light.css.\nMultiple Variants To let the reader choose between multiple variants, set themeVariant like this:\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } The first variant is the default, and a selector will appear if there’s more than one.\nAdjust to OS Settings Use the auto value to match OS light/dark settings. Usually it makes sense to set it in the first position and make it the default.\nhugo. toml yaml json [params] themeVariant = ['auto', 'red'] params: themeVariant: - auto - red { \"params\": { \"themeVariant\": [ \"auto\", \"red\" ] } } If you don’t configure anything else, the theme will default to use relearn-light for light mode and relearn-dark for dark mode.\nDefault is relearn-light for light and relearn-dark for dark mode. These defaults are overwritten by the first two non-auto options of your themeVariant array.\nYou can override the default with themeVariantAuto:\nhugo. toml yaml json [params] themeVariantAuto = ['learn', 'neon'] params: themeVariantAuto: - learn - neon { \"params\": { \"themeVariantAuto\": [ \"learn\", \"neon\" ] } } Advanced The theme offers an advanced way to configure theme variants and all of the aspects above inside of a single configuration item. This comes with some features previously unsupported.\nLike with the multiple variants option, you are defining your theme variants in an array but now in a table with suboptions.\nAgain, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } you now write it that way:\nhugo. toml yaml json [params] [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' params: themeVariant: - identifier: relearn-light - identifier: relearn-dark { \"params\": { \"themeVariant\": [ { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" } ] } } The identifier option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond to the name of a color variant either in your site’s or the theme’s directory in the form assets/css/theme-\u003cIDENTIFIER\u003e.css. name see notes The name to be displayed in the variant selector. If not set, the identifier is used in a human readable form. auto \u003cempty\u003e If set, the variant is treated as an auto mode variant. It has the same behavior as the themeVariantAuto option. The first entry in the array is the color variant for light mode, the second for dark mode. Defining auto mode variants with the advanced options has the benefit that you can now have multiple auto mode variants instead of just one with the simple options. Example Configuration hugo. toml yaml json [params] [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] identifier = 'relearn-bright' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] auto = ['learn', 'neon'] identifier = 'retro-auto' name = 'Retro Learn/Neon' [[params.themeVariant]] identifier = 'neon' [[params.themeVariant]] identifier = 'learn' params: themeVariant: - auto: [] identifier: relearn-auto name: Relearn Light/Dark - identifier: relearn-light - identifier: relearn-dark - identifier: relearn-bright - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - auto: - learn - neon identifier: retro-auto name: Retro Learn/Neon - identifier: neon - identifier: learn { \"params\": { \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"identifier\": \"relearn-bright\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"auto\": [ \"learn\", \"neon\" ], \"identifier\": \"retro-auto\", \"name\": \"Retro Learn/Neon\" }, { \"identifier\": \"neon\" }, { \"identifier\": \"learn\" } ] } } Advanced Topics Modifying Variants In case you like a shipped variant but only want to tweak some aspects, you have some choices. Don’t edit the file in the theme’s directory! You will lose the ability to later easily upgrade your theme to a newer version.\nCopy and change\nYou can copy the shipped variant file from the theme’s themes/hugo-theme-relearn/assets/css directory to the site’s assets/css directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards, you can use it in your hugo.toml by the chosen name.\nCreate and import\nYou can create a new variant file in the site’s assets/css directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards, you can use it in your hugo.toml by the chosen name.\nFor example, you want to use the relearn-light variant but want to change the syntax highlighting schema to the one used in the neon variant. For that, create a new assets/css/theme-my-branding.css in your site’s directory and add the following lines:\n​ assets/css/theme-my-branding.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: neon; /* name of the chroma stylesheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */ } Afterwards, put this in your hugo.toml to use your new variant:\nhugo. toml yaml json [params] themeVariant = 'my-branding' params: themeVariant: my-branding { \"params\": { \"themeVariant\": \"my-branding\" } } In comparison to copy and change, this has the advantage that you profit from any adjustments to the relearn-light variant while keeping your modifications.\nReact to Variant Switches in JavaScript Once a color variant is fully loaded, either initially or by switching the color variant manually with the variant selector, the custom event themeVariantLoaded on the document will be dispatched. You can add an event listener and react to changes.\n​ JavaScript document.addEventListener( 'themeVariantLoaded', function( e ){ console.log( e.detail.variant ); // `relearn-light` });",
"description": "Learn how to customize your site's colors",
"tags": [],
"title": "Colors",
"uri": "/hugo-theme-relearn/configuration/branding/colors/index.html"
},
{
"breadcrumb": "",
"content": "Find out how to configure and customize your site.\nSite ManagementGet yourself familiar with the general structure of your website\nBrandingChange colors and logos of your site\nSidebarConfigure all things sidebar\nContentConfigure the content area of your site\nCustomizationCustomize files for advanced usage\nOptions ReferenceAll configuration options for the Relearn theme",
"description": "Find out how to configure and customize your site.\nSite ManagementGet yourself familiar with the general structure of your website",
"tags": [],
"title": "Configuration",
"uri": "/hugo-theme-relearn/configuration/index.html"
},
{
"breadcrumb": "Configuration \u003e Customization",
"content": "A common question is how to add extra CSS styles or JavaScript to your site. This depends on what you need.\nAdding JavaScript or Stylesheets to All Pages To add JavaScript files or CSS stylesheets to every page, you can include them in layouts/partials/custom-header.html or layouts/partials/custom-footer.html.\nHowever, this can make your site larger than necessary if these files are only needed on a few pages. The next section explains how to add dependencies only when needed.\nCustom Shortcodes with Dependencies Some shortcodes need extra JavaScript and CSS files. The theme only loads these when the shortcode is used. You can use this for your own shortcodes too.\nFor example, to create a shortcode called myshortcode that needs the jquery library:\nCreate the shortcode file layouts/shortcodes/myshortcode.html and add the folloging line somewhere:\n​ layouts/shortcodes/myshortcode.html ... {{- .Page.Store.Set \"hasMyShortcode\" true }} ... Option Add this to your hugo.toml:\nhugo. toml yaml json [params] [params.relearn] [params.relearn.dependencies] [params.relearn.dependencies.myshortcode] name = 'MyShortcode' params: relearn: dependencies: myshortcode: name: MyShortcode { \"params\": { \"relearn\": { \"dependencies\": { \"myshortcode\": { \"name\": \"MyShortcode\" } } } } } Create loader file layouts/partials/dependencies/myshortcode.html:\n​ layouts/partials/dependencies/myshortcode.html {{- if eq .location \"footer\" }} \u003cscript src=\"https://www.unpkg.com/jquery/dist/jquery.js\"\u003e\u003c/script\u003e {{- end }} Important notes:\nCharacter casing is relevant! The name in hugo.toml must match the Store key used in the shortcode file, prefixed with a has. The key of relearn.dependencies must match the loader file name. See the math, mermaid, and openapi shortcodes for examples.\nNote For advanced customization, you can use the dependency loader in your own partials:\n{{- partial \"dependencies.gotmpl\" (dict \"page\" . \"location\" \"mylocation\") }} Give a unique name for the location parameter when you call it, so you can distinguish your loaders behavior depending on the location it was called from.",
"description": "Add further code to your site",
"tags": [],
"title": "Extending Scripts",
"uri": "/hugo-theme-relearn/configuration/customization/dependencies/index.html"
},
{
"breadcrumb": "Authoring",
"content": "Page DesignsHow to vary layouts by using page designs\nMenusSetting the behavior of the menus\nLinkingWhat options are available for links and images\nTopbarConfigure the topbar\nReferenceAll front matter for the Relearn theme",
"description": "All things front matter",
"tags": [],
"title": "Front Matter",
"uri": "/hugo-theme-relearn/authoring/frontmatter/index.html"
},
{
"breadcrumb": "Configuration \u003e Sidebar",
"content": "Title Option With the default partials for the logo, The site title will also be used for the text at the top of the sidebar. If you want to show a different text in the sidebar, you can overwrite linkTitle.\nhugo. toml yaml json [params] linkTitle = 'Relearn' params: linkTitle: Relearn { \"params\": { \"linkTitle\": \"Relearn\" } } Home Button Configuration By default, the theme displays a home button between search form and navigation menu. The Home button serves as an alternative to clicking the logo.\nOption To hide the Home button on the left menu, set disableLandingPageButton=true.\nhugo. toml yaml json [params] disableLandingPageButton = true params: disableLandingPageButton: true { \"params\": { \"disableLandingPageButton\": true } } Option To change its icon or text, configure the landingPageName for your defined languages.\nhugo. toml yaml json [languages] [languages.en] [languages.en.params] landingPageName = '\u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Home' [languages.pir] [languages.pir.params] landingPageName = '\u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Arrr! Homme' languages: en: params: landingPageName: \u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Home pir: params: landingPageName: \u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Arrr! Homme { \"languages\": { \"en\": { \"params\": { \"landingPageName\": \"\\u003ci class=\\\"fa-fw fas fa-home\\\"\\u003e\\u003c/i\\u003e Home\" } }, \"pir\": { \"params\": { \"landingPageName\": \"\\u003ci class=\\\"fa-fw fas fa-home\\\"\\u003e\\u003c/i\\u003e Arrr! Homme\" } } } } If this option isn’t set for a specific language, it will use these default values\nhugo. toml yaml json [params] landingPageName = '\u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Home' params: landingPageName: \u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Home { \"params\": { \"landingPageName\": \"\\u003ci class=\\\"fa-fw fas fa-home\\\"\\u003e\\u003c/i\\u003e Home\" } } History Option Turn on showVisitedLinks=true to see checkmarks next to visited pages in the main menu. This also adds a Clear History option at the bottom of the menu to remove all checkmarks. Note that checkmarks will disappear if you rebuild your site, as the page IDs may change.\nhugo. toml yaml json [params] showVisitedLinks = true params: showVisitedLinks: true { \"params\": { \"showVisitedLinks\": true } } Footer To change the menu footer, edit the layouts/partials/menu-footer.html file. Check out the Partials section for more ways to customize your site.",
"description": "Configure the header and footer",
"tags": [],
"title": "Header \u0026 Footer",
"uri": "/hugo-theme-relearn/configuration/sidebar/headerfooter/index.html"
},
{
"breadcrumb": "Authoring \u003e Front Matter",
"content": "",
"description": "Setting the behavior of the menus",
"tags": [],
"title": "Menus",
"uri": "/hugo-theme-relearn/authoring/frontmatter/menus/index.html"
},
{
"breadcrumb": "Configuration \u003e Site Management",
"content": "The Relearn theme works with Hugo’s multilingual mode.\nIt supports many languages, including right-to-left languages.\nSupported languages Arabic Simplified Chinese Traditional Chinese Czech Dutch English Finnish French German Hindi Hungarian Indonesian Italian Japanese Korean Polish Portuguese Romanian Russian Spanish Swahili Turkish Vietnamese Translation by File Name Here’s how to make your site multilingual using translations by file name:\nSet up languages in your hugo.toml file:\nhugo. toml yaml json defaultContentLanguage = 'en' [languages] [languages.en] languageCode = 'en' languageName = 'English' title = 'My Website' weight = 1 [languages.pir] languageCode = 'art-x-pir' languageDirection = 'rtl' languageName = 'Pirrratish' title = 'Arrr, my Website' weight = 2 defaultContentLanguage: en languages: en: languageCode: en languageName: English title: My Website weight: 1 pir: languageCode: art-x-pir languageDirection: rtl languageName: Pirrratish title: Arrr, my Website weight: 2 { \"defaultContentLanguage\": \"en\", \"languages\": { \"en\": { \"languageCode\": \"en\", \"languageName\": \"English\", \"title\": \"My Website\", \"weight\": 1 }, \"pir\": { \"languageCode\": \"art-x-pir\", \"languageDirection\": \"rtl\", \"languageName\": \"Pirrratish\", \"title\": \"Arrr, my Website\", \"weight\": 2 } } } Duplicate your content files and add language codes to their file names:\n├── content │ ├── first-chapter │ │ ├── first-page | | | ├── _index.en.md | | | └── _index.pir.md │ │ ├── second-page | | | ├── index.en.md | | | └── index.pir.md │ │ ├── third-page.en.md │ │ └── third-page.pir.md │ ├── _index.en.md │ └── _index.pir.md ├── themes │ └── hugo-theme-relearn │ └── ... └── hugo.toml Translation by Content Directory The theme also support translations by content directory which can be configured in a similar way. This is not used in further examples of this documentation.\nSearch Settings Check the search configuration for multilingual options.\nTurn Off Language Switching Option By default the theme shows a language switcher in the lower part of the menu.\nTo disable the language switcher set disableLanguageSwitchingButton=true\nhugo. toml yaml json [params] disableLanguageSwitchingButton = true params: disableLanguageSwitchingButton: true { \"params\": { \"disableLanguageSwitchingButton\": true } }",
"description": "How to set up a multilingual site",
"tags": [],
"title": "Multilingual",
"uri": "/hugo-theme-relearn/configuration/sitemanagement/multilingual/index.html"
},
{
"breadcrumb": "Configuration \u003e Content",
"content": "Breadcrumbs Learn how to turn off the breadcrumbs completely and further configure the topbar.\nOption Set disableRootBreadcrumb=true to remove the root breadcrumb which often feels redundant. This will also apply to the breadcrumbs of the search results and taxonomy pages.\nOption You can override the default breadcrumb separator by using breadcrumbSeparator='/'. This separator will also be used in the breadcrumbs of the search results and taxonomy pages.\nOption By default the term pages of a taxonomy will display the breadcrumb for each page. Set disableTermBreadcrumbs=true to remove the breadcrumb if the term pages look to cluttered.\nhugo. toml yaml json [params] breadcrumbSeparator = '/' disableRootBreadcrumb = true disableTermBreadcrumbs = true params: breadcrumbSeparator: / disableRootBreadcrumb: true disableTermBreadcrumbs: true { \"params\": { \"breadcrumbSeparator\": \"/\", \"disableRootBreadcrumb\": true, \"disableTermBreadcrumbs\": true } } Titles Option You can override the default title separator by using titleSeparator='|'.\nhugo. toml yaml json [params] titleSeparator = '|' params: titleSeparator: '|' { \"params\": { \"titleSeparator\": \"|\" } }",
"description": "Configuring titles and breadcrumbs to your needs",
"tags": [],
"title": "Titles \u0026 Breadcrumbs",
"uri": "/hugo-theme-relearn/configuration/content/titles/index.html"
},
{
"breadcrumb": "Introduction",
"content": "Front Matter CMS The theme supports the great VSCode Front Matter CMS extension which provides on-premise CMS capabilties to Hugo.\nFor that, the theme provides a snippets file so you can use shortcodes from inside the Front Matter CMS.\nCurrently only English and German is supported.\nTo use them in your Front Matter CMS, put a reference into your frontmatter.json like this\n​ frontmatter.json { \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] }",
"description": "All about supported 3rd party tools",
"tags": [],
"title": "Tool Integration",
"uri": "/hugo-theme-relearn/introduction/tools/index.html"
},
{
"breadcrumb": "",
"content": "Learn how to create and organize your content pages.\nDirectory StructureYour content's directory structure\nFront MatterAll things front matter\nMeta InformationWhat page meta information are available\nMarkdown SyntaxReference of CommonMark and Markdown extensions\nImage EffectsHow to apply graphical effects to your images",
"description": "Learn how to create and organize your content pages.\nDirectory StructureYour content's directory structure",
"tags": [],
"title": "Authoring",
"uri": "/hugo-theme-relearn/authoring/index.html"
},
{
"breadcrumb": "Configuration \u003e Content",
"content": "Headings can have anchor links that appear when you hover over them.\nYou can change what happens when you click the anchor icon in your hugo.toml file. By default, all options are turned on. If you turn off all options, no anchor icon will show up when you hover.\nCopy Anchor Links Option Set disableAnchorCopy=true to prevent copying the anchor link when you click the icon.\nhugo. toml yaml json [params] disableAnchorCopy = true params: disableAnchorCopy: true { \"params\": { \"disableAnchorCopy\": true } } Scroll to Heading Option Set disableAnchorScrolling=true to stop the page from scrolling to the heading when you click the anchor icon.\nhugo. toml yaml json [params] disableAnchorScrolling = true params: disableAnchorScrolling: true { \"params\": { \"disableAnchorScrolling\": true } }",
"description": "Configuring heading anchors",
"tags": [],
"title": "Headings",
"uri": "/hugo-theme-relearn/configuration/content/headings/index.html"
},
{
"breadcrumb": "Configuration \u003e Customization",
"content": "This page shows you, how to configure custom image effects on top of existing ones.\nThis setting can also be overridden by your front matter.\nIf you don’t configure anything in your hugo.toml, the image effects default to\nDefault Values ​ toml yaml json [imageEffects] border = false lazy = true lightbox = true shadow = false imageEffects: border: false lazy: true lightbox: true shadow: false { \"imageEffects\": { \"border\": false, \"lazy\": true, \"lightbox\": true, \"shadow\": false } } Configuration Option You can change these settings in your hugo.toml and add arbitrary custom effects as boolean values (like bg-white in the below snippet).\nhugo. toml yaml json [params] [params.imageEffects] bg-white = true border = true lazy = false params: imageEffects: bg-white: true border: true lazy: false { \"params\": { \"imageEffects\": { \"bg-white\": true, \"border\": true, \"lazy\": false } } } This would result in\n​ toml yaml json [imageEffects] bg-white = true border = true lazy = false lightbox = true shadow = false imageEffects: bg-white: true border: true lazy: false lightbox: true shadow: false { \"imageEffects\": { \"bg-white\": true, \"border\": true, \"lazy\": false, \"lightbox\": true, \"shadow\": false } } Example With this configuration in effect, the following URL\n​ Markdown ![Minion](https://octodex.github.com/images/minion.png) would result in\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png\" loading=\"lazy\" alt=\"Minion\" class=\"bg-white border nolazy lightbox noshadow\"\u003e Styling Effects If the resulting effect value is\ntrue: add a class with the effect’s name false: add a class with the effect’s name and a “no” prefix Styles for default effects are contained in the theme. Add styles for your custom effects to layouts/partials/content-header.html.\nFor the above example you could add styles for both boolean cases:\n​ layouts/partials/content-header.html \u003cstyle\u003e img.bg-white { background-color: white; } img.nobg-white { background-color: transparent; } \u003c/style\u003e",
"description": "How to extend image effects",
"tags": [],
"title": "Image Effects",
"uri": "/hugo-theme-relearn/configuration/customization/imageeffects/index.html"
},
{
"breadcrumb": "Authoring \u003e Front Matter",
"content": "Opening Links Option Front Matter By default, external links open in a new tab. To change this, use the externalLinkTarget setting with a proper link target.\nFor example, this will open links in the same tab\n​ toml yaml json externalLinkTarget = '_self' externalLinkTarget: _self { \"externalLinkTarget\": \"_self\" } Enabling Link and Image Link Warnings Option Front Matter You can use link.errorlevel and image.errorlevel to control what should happen if a local link can not be resolved to a resource.\nIf not set or empty, any unresolved link is written as given into the resulting output. If set to warning the same happens and an additional warning is printed in the built console. If set to error an error message is printed and the build is aborted.\nPlease note that this can not resolve files inside of your static directory. The file must be a resource of the page or the site.\nLink warnings are also available for the include and openapi shortcodes.\n​ toml yaml json [image] errorlevel = 'warning' [link] errorlevel = 'warning' image: errorlevel: warning link: errorlevel: warning { \"image\": { \"errorlevel\": \"warning\" }, \"link\": { \"errorlevel\": \"warning\" } }",
"description": "What options are available for links and images",
"tags": [],
"title": "Linking",
"uri": "/hugo-theme-relearn/authoring/frontmatter/linking/index.html"
},
{
"breadcrumb": "Authoring",
"content": "Page Title The title will be used in the heading and meta information of your HTML.\nA page without a title is treated as if hidden=true has been set.\n​ toml yaml json +++ title = 'Example Title' +++ --- title: Example Title --- { \"title\": \"Example Title\" } Page Description The description is used for generating HTML meta information, in the children shortcode and in social media meta information.\nIf not set, the set value of your site’s hugo.toml is used for the HTML meta information and social media meta information. It appears empty for the children shortcode.\n​ toml yaml json +++ description = 'Some lenghty example description' +++ --- description: Some lenghty example description --- { \"description\": \"Some lenghty example description\" } Social Media Images The theme adds social media meta tags including feature images for the Open Graph protocol and Twitter Cards to your site. These are configured as mentioned in the linked Hugo docs.\n​ toml yaml json +++ images = ['images/hero.png'] +++ --- images: - images/hero.png --- { \"images\": [ \"images/hero.png\" ] } Hidden Front Matter You can hide your pages from the menu by setting hidden=true.\nMenu For Hugo menus, you have to set params.hidden=true instead.\nSee how you can further configure visibility throughout your site.\n​ toml yaml json +++ hidden = true +++ --- hidden: true --- { \"hidden\": true } Add Icon to the Title Heading Front Matter In the page front matter, add a headingPre to insert any HTML code before the title heading. You can also set headingPost to insert HTML code after the title heading.\nYou also may want to apply further CSS in this case.\n​ toml yaml json +++ headingPre = '\u003ci class=\"fab fa-github\"\u003e\u003c/i\u003e ' +++ --- headingPre: '\u003ci class=\"fab fa-github\"\u003e\u003c/i\u003e ' --- { \"headingPre\": \"\\u003ci class=\\\"fab fa-github\\\"\\u003e\\u003c/i\\u003e \" } Footer Information Front Matter If you use the default layouts/partials/content-footer.html is not overridden by you, it will display authoring information, namely\nAuthorName if GitInfo is active, otherwise LastModifierDisplayName front matter AuthorEmail if GitInfo is active, otherwise LastModifierEmail front matter AuthorDate if GitInfo is active, otherwise Hugo’s date front matter ​ toml yaml json +++ LastModifierDisplayName = 'Santa Claus' LastModifierEmail = 'santa@example.com' date = 2000-12-24T00:00:00-12:00 +++ --- LastModifierDisplayName: Santa Claus LastModifierEmail: santa@example.com date: 2000-12-24T00:00:00-12:00 --- { \"LastModifierDisplayName\": \"Santa Claus\", \"LastModifierEmail\": \"santa@example.com\", \"date\": \"2000-12-24T00:00:00-12:00\" }",
"description": "What page meta information are available",
"tags": [],
"title": "Meta Information",
"uri": "/hugo-theme-relearn/authoring/meta/index.html"
},
{
"breadcrumb": "Configuration \u003e Site Management",
"content": "Site Author Information Option The theme uses author details in various parts of your site, like RSS feeds and meta tags.\nhugo. toml yaml json [params] [params.author] email = 'santa@example.com' name = 'Santa Claus' params: author: email: santa@example.com name: Santa Claus { \"params\": { \"author\": { \"email\": \"santa@example.com\", \"name\": \"Santa Claus\" } } } Site Title The title will be used in meta information of your HTML.\nhugo. toml yaml json title = 'Hugo Relearn Theme' title: Hugo Relearn Theme { \"title\": \"Hugo Relearn Theme\" } Site Description Front Matter The theme shows a site description in various places, such as RSS feeds and meta tags. For this, it uses the description field from your home page’s front matter.\nSocial Media Images When your page is shared on social media, you can set a site-wide image to display with the link\nhugo. toml yaml json images = ['images/hero.png'] images: - images/hero.png { \"images\": [ \"images/hero.png\" ] } More Social Media Options The theme adheres to Hugo’s official documentation for Open Graph and Twitter Cards configuration.",
"description": "What site-wide meta information can be set",
"tags": [],
"title": "Meta Information",
"uri": "/hugo-theme-relearn/configuration/sitemanagement/meta/index.html"
},
{
"breadcrumb": "Configuration \u003e Branding",
"content": "Change Syntax Highlighting If you want to switch the syntax highlighting theme together with your color variant, first you need to configure your installation according to Hugo’s documentation to provide a syntax highlighting stylesheet file.\nhugo. toml yaml json [markup] [markup.highlight] noClasses = false markup: highlight: noClasses: false { \"markup\": { \"highlight\": { \"noClasses\": false } } } You can use one of the shipped stylesheet files or use Hugo to generate a file for you.\nhugo gen chromastyles --style=monokai \u003e chroma-mycode.css The file must be written to assets/css/chroma-\u003cNAME\u003e.css. To use it with your color variant, you have to modify --CODE-theme: \u003cNAME\u003e in the color variant stylesheet file.\n​ assets/css/theme-my-branding.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: mycode; /* name of the chroma stylesheet file */ } Change 3rd-Party Libraries Theming Some of the shipped shortcodes are using 3rd-party libraries. See the individual shortcode documentation on how to change their theming.\nmermaid shortcode openapi shortcode",
"description": "Colors of syntax highlighting and 3rd-party modules",
"tags": [],
"title": "Module Theming",
"uri": "/hugo-theme-relearn/configuration/branding/modules/index.html"
},
{
"breadcrumb": "Configuration \u003e Sidebar",
"content": "Configure Search The theme offers three levels of search through the menu’s search form:\nIn-page search: Highlights search terms on the current page Search popup: Opens a popup with results from other pages Dedicated search page: Accessible by clicking the magnifier glass or pressing ENTER Each level requires the previous one to be enabled. If no search is configured, the search form won’t appear.\nOption All levels are enabled by default. Disable them in hugo.toml:\nIn-page search: disableSearch=true Search popup: disableSearchIndex=true Dedicated search page: disableSearchPage=true hugo. toml yaml json [params] disableSearch = true disableSearchIndex = true disableSearchPage = true params: disableSearch: true disableSearchIndex: true disableSearchPage: true { \"params\": { \"disableSearch\": true, \"disableSearchIndex\": true, \"disableSearchPage\": true } } Option Default URLs can be changed with the following parameter\nSearch popup: searchindex.js set by searchIndexURL Dedicated search page: search/index.html set by searchPageURL hugo. toml yaml json [params] searchIndexURL = 'omnisearchindex.js' searchPageURL = 'omnisearch' params: searchIndexURL: omnisearchindex.js searchPageURL: omnisearch { \"params\": { \"searchIndexURL\": \"omnisearchindex.js\", \"searchPageURL\": \"omnisearch\" } } Note Only change these if you have content at those URLs. This can happen with uglyURLs=true in hugo.toml and having a content file at content/search.md.\nCheck for duplicate URLs by running hugo --printPathWarnings.\nSupported Languages The Lunr search library doesn’t support all languages of the theme. Unsupported languages will show errors in the browser console. Currently unsupported are\nCzech Indonesian Polish Swahili Mixed Language Support Option In case your page’s content contains text in multiple languages (for example, you are writing a Piratish documentation for your English API), you can set those languages in additionalContentLanguage to broaden the search.\nhugo. toml yaml json [params] additionalContentLanguage = ['en'] params: additionalContentLanguage: - en { \"params\": { \"additionalContentLanguage\": [ \"en\" ] } } You can add multiple languages to this array.\nNote Use the base language code. For example, if your page is using zh-CN, add zh to this parameter.",
"description": "Configure search and the search form",
"tags": [],
"title": "Search",
"uri": "/hugo-theme-relearn/configuration/sidebar/search/index.html"
},
{
"breadcrumb": "Configuration",
"content": "WidthChanging the width of the sidebar\nHeader \u0026 FooterConfigure the header and footer\nSearchConfigure search and the search form\nMenusConfigure all things menus",
"description": "Configure all things sidebar",
"tags": [],
"title": "Sidebar",
"uri": "/hugo-theme-relearn/configuration/sidebar/index.html"
},
{
"breadcrumb": "Introduction",
"content": "Version 7 7.1.0 (2024-10-24) Change Change The sidebar menus are now completely configurable.\nThis is provided by the new parameter sidebarmenus. With the new system, you can\nshow arbitrary amounts of menus set headings for each menu base it on your page structure or use Hugo’s menu feature configure a starting page if a menu is based on page structure display unlimited nesting for both menu types reconfigure the menus in a page’s front matter apply the usual parameter alwaysopen, collapsibleMenu, etc. for all menu types You don’t need to change anything in your existing installation as the old configuration is used as a default.\nChange The children shortcode was changed to output a page’s LinkTitle instead of previously using the Title.\nAs the shortcode always outputs subpages in context of the parent page, it functions similar to the sidebar menu. The sidebar menu itself uses the LinkTitle for naming the menu entries and so should the shortcode do.\nThe parameter value sort=linktitle was deprecated for the easier sort=title. You can still use the old value but both behave the same way in sorting by LinkTitle.\nNew New Menus created by your page structure are now able to contain arbitrary links inserted into the structure using the menuUrl or menuPageRef front matter. 7.0.0 (2024-10-15) Hugo 0.126.0 0.126.0 This release requires a newer Hugo version. Breaking Breaking This release comes with significant changes in file naming of partials and how the theme works internally. This was done because the theme\nsuffered from poor build performance for sites with 1000 or more pages reinvented the wheel instead of using available Hugo mechanisms What do I gain, you may ask. A significant performance boost during build! Usually, the build time has been cut at least in half for bigger sites. It is now possible to build even larger sites with 5000 or more pages. This was previously almost impossible due to rapidly increasing build time with the more pages you’ve introduced. For even bigger sites, the theme now has configurable performance optimizations - at the price of feature limitations.\nIf you haven’t done customizations to any partials, you can update right away.\nIf you have customized your templates, in the best cases, you will get build warnings or even errors. In the worst cases, your build succeeds but the site will not work as intended by you.\nSpecifically, you will have to adapt your site if you have\noverwritten the header.html, menu.html or footer.html partials self-defined output formats self-defined archetype partials in layouts/partials/archetypes - now becoming page designs overwritten prev/next topbar buttons - needs sync with implementation changes Breaking This release changes the way the search index and the dedicated search page are generated. This may require reconfiguration by you to still work as you have intended.\nYou need to remove the now obsolete search and searchpage output format from [outputs.home] in your hugo.toml, resulting in something similar to\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'print'] outputs: home: - html - rss - print { \"outputs\": { \"home\": [ \"html\", \"rss\", \"print\" ] } } After that, your build will succeed but will most likely cause new defaults to be applied. With no further settings, in-page search, search popup and dedicated search page are all active by default. This can be reconfigured.\nIn addition, you are now able to overwrite the default file name of the search index and the default page name of the dedicated search page by changing searchIndexURL and searchPageURL respectively in your hugo.toml.\nSee the updated documentation for reference.\nChange Change Once again, the theme changed the font. We switched to the excellent Roboto Flex font.\nCare was taken to configure the font to look similar to the previously used Work Sans. Nevertheless, in direct comparison, you will see slight differences in appearance.\nThis change was necessary as the previously used font had display issues with marked text, contrast, and some other minor stuff. As an aftermath, the number of requests and the download size were decreased when loading a page.\nThe font was created by Google, is licensed under OFL 1.1 and is delivered from your theme’s installation. As always, no third-party server calls are involved.\nIf you have changed the font-family in your installation, you most likely have to adjust the variables --MAIN-font-weight, --MAIN-BOLD-font-weight and --MAIN-letter-spacing.\nAdditionally, if you have changed the font to a variable font in your installation, you may have to adjust the variable --MAIN-font-variation-settings. As this only applies to variable fonts, this should rarely be necessary.\nChange While switching the font, it was discovered that certain CSS variables were falsely named. You don’t need to change anything in your custom variant stylesheet as the old names will be used as a fallback.\n--MAIN-TITLES-TEXT-font was renamed to --MAIN-TITLES-font, --MAIN-TITLES-H\u003cn\u003e-color was renamed to --MAIN-TITLES-H\u003cn\u003e-TEXT-color.\nChange The options and front matter to force loading a math, mermaid or openapi library has been changed.\nPreviously, you had to set the unintuitive disableMathJax=false to force load the math library in case of a passthrough configuration. This is replaced by the simpler math=true or math.force=true and is now in line with Hugo’s official documentation.\nYou don’t need to change anything yet but will receive warnings if the old settings are used.\nChange The default logo is not contained inside of the theme’s logo partial anymore.\nThis is to avoid usage of the theme’s branding throughout the web in non-modified installations.\nIn addition, the default text for the logo partial is now taken from the linkTitle setting of your hugo.toml.\nNew New The docs received a much-needed overhaul for all chapters.\nBasically, the structure was reorganized, giving each topic its own page while keeping the amount of items for each menu level comprehensible by adding sub-pages.\nThe docs now clearly differentiate between configuration of your site, all things writing page content and the shortcodes docs that cover both topics, configuration and usage.\nTo give you a better overview of what’s possible with the theme, we introduced reference pages for all theme configuration options and front matter and mark each occurrence of such on all pages with the badges Option and Front Matter.\nAlso, a lot of previously undocumented features are now included, namely\nthe hidden pages feature options of the menus configuring breadcrumb, titles and headings of your content options for using links adding custom output formats Version 6 6.4.0 (2024-10-11) Change Change If you now display a single code block in a notice box, its margin and border will be removed so only the colored notice border is visible. New New It is now possible to have user-defined styles for all shortcodes that accept the style parameter. See the notice shortcode for configuration.\nNew The resources shortcode has a new parameter expanded to make the resource list collapsible. 6.3.0 (2024-09-03) Change Change The expand shortcode changed the naming of the open parameter to expanded. You don’t need to change anything yet but may get deprecation warnings.\nChange If the content for the notice shortcode is empty, now only the title bar will be displayed. Previously an empty content box was displayed.\nNew New The notice shortcode has a new parameter expanded to make the content collapsible.\nNew If you are running Hugo 0.134.0 or later, the theme now supports Obsidian callouts.\nNew The theme has updated its Mermaid dependency to 11.1.0. This adds support for packet and architecture diagrams. 6.2.0 (2024-08-26) Change Change The heading anchor links are extended in functionality.\nIf you now click on it, not only is the link copied to the clipboard (previous behavior) but also the heading scrolls to the top of the page.\nIf you dislike the new behavior, you can deactivate it by setting disableAnchorScrolling=true in your hugo.toml. See the docs for further options.\nNew New If you are running Hugo 0.132.0 or later, the theme is now capable to print GitHub alerts.\nNew To support new severity levels for GitHub alerts, all shortcodes that support severity levels with their style parameter were expanded with the new severities caution and important and the color parameter was expanded with cyan and magenta. Please note, that coloring and icons of severities may defer from the display you see on GitHub.\nNew To support new severity levels for GitHub alerts, the new severities and their according colors are also available as CSS variables BOX-MAGENTA-color, BOX-MAGENTA-TEXT-color, BOX-CAUTION-color, BOX-CAUTION-TEXT-color, BOX-CYAN-color, BOX-CYAN-TEXT-color, BOX-IMPORTANT-color, BOX-IMPORTANT-TEXT-color. You don’t need to change anything in your custom color stylesheet as appropriate default colors will be used. 6.1.0 (2024-08-02) Change Change The include shortcode is now able to resolve links to pages as well as resources or files in the file system (the old behavior).\nChange To make the asset buster mechanism more robust, some internally used stylesheets where restructured. This generally should not affect your page in any negative way.\nNew New The openapi shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting openapi.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.\nNew Shortcodes supporting an errorlevel configuration can now have overridden values in the front matter section of each individual page.\nNew The theme now comes with its own overridden version of the relref shortcode.\nWhile the usage of relref is obsolete and discouraged by Hugo for a while, existing installations may use it. In configurations using a baseURL with a subdirectory, and having relativeURLs=false (the default) Hugo’s standard relref implementation was failing.\nThe shortcode is deactivated by default and can be activated by setting\nhugo. toml yaml json [params] disableDefaultRelref = true params: disableDefaultRelref: true { \"params\": { \"disableDefaultRelref\": true } } in your hugo.toml. Only do this if your site fulfills all of the above assumptions. 6.0.0 (2024-04-27) Breaking Breaking This release requires you to move your self-defined variant (theme-*.css) and chroma stylesheets (chroma-*.css) from static/css to assets/css.\nThis was necessary to avoid permission errors on build if running in certain Unix configurations.\nIn addition it is not allowed anymore to @import your chroma stylesheet from inside of your variant stylesheet.\nSay, your chroma stylesheet is named chroma-monokai.css, you have to add the following inside your variant stylesheet:\n--CODE-theme: monokai; Breaking The parameter description in your hugo.toml will now be ignored.\nWith the newly introduced unified handling of descriptions throughout the theme, the only place the old parameter would have been used was your home page.\nFor migration, move the description parameter of your hugo.toml into the front matter section of your home page.\nBreaking Search support for the json outputformat deprecated in 5.4.0 was removed.\nChange it to search for the homepage in your hugo.toml. See the docs for detailed configuration.\nBreaking The front matter option menuTitle deprecated in 5.24.0 was removed in favor for Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead of title to generate the breadcrumb.\nBreaking The swagger shortcode deprecated in 5.13.0 was removed in favor for the openapi shortcode with the same set of parameter.\nBreaking Support for Internet Explorer 11 was finally dropped.\nChange Change With the removal of support for Internet Explorer 11, Font Awesome was upgraded to version 6.5.2.\nYou may experience slight changes for some icons. In addition you have additional ~1700 icons to chose from.\nChange The children shortcode was fixed to adhere to its documentation, generating the description based on this rule: When no description or summary exists for the page, the first 70 words of the content is taken.\nPreviously, the summary erroneously was ignored which now can lead to different output if you set description=true as a parameter.\nNew New The include shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting include.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.\nNew Math is now usable without enclosing it in a shortcode or Markdown codefence by using Hugo’s passthrough configuration.\nNew Translation into Romanian. Older Versions Version 5 Version 4 Version 3 Version 2 Version 1",
"description": "What's new in this version",
"tags": [],
"title": "What's New",
"uri": "/hugo-theme-relearn/introduction/releasenotes/index.html"
},
{
"breadcrumb": "Introduction",
"content": "Version 7 7.1.0 (2024-10-24) Enhancements [feature][change] children: use LinkTitle instead of Title #939 [feature][change] menu: support nested Hugo menus #423 [feature] menu: support for external links #148 Fixes [bug] search: wrong searchindex URL with multilang per server config #940 7.0.1 (2024-10-15) Fixes [bug] search: search page not generated with renderer.unsafe #929 7.0.0 (2024-10-13) Enhancements [feature][change] logo: move Relearn logo to exampleSite #924 [feature][change] math: adhere to Hugo’s default config params #923 [feature][change] theme: replace font #922 [feature][breaking] theme: reduce build time #685 Fixes [bug] theme: remove duplicate path warning #926 Maintenance [task] theme: remove author deprecation warning #919 [task] theme: remove deprecation waring for usage of .Sites.First #912 [task][breaking] theme: restructure code #891 [task][breaking] search: improve generation of dedicated search page #888 [task] theme: remove warning for usage of .Site.IsMultiLingual #877 [task][breaking] roadmap: upcoming major changes for 7.0.0 #715 Version 6 6.4.1 (2024-10-11) Fixes [bug] highlight: remove additional newlines from code if copied from cursor selection #925 6.4.0 (2024-09-12) Enhancements [feature] notice: support user defined box styles #913 [feature] frontmatter: add expanded parameter for shortcodes #911 [feature] resources: add expanded parameter #908 [feature][change] notice: collapse borders if single code block is displayed #906 Fixes [bug] include: don’t erroneously remove headings if hidefirstheading=true #914 Maintenance [task] build: add link for migration into changelog #915 [task] shortcodes: fix whitespace issues #907 6.3.0 (2024-09-03) Enhancements [feature] theme: support Obsidian styled alerts #903 [feature] notice: add expander to box title #901 Fixes [bug] children: fix sort parameter #898 [bug] mermaid: classDiagram breaks when using «interface» #895 [bug] toc: don’t show toc button if empty #893 Maintenance [task] mermaid: update to 11.1.0 #904 [task][change] expand: rename open parameter to expanded #902 [task] i18n: update Arabic translation #900 6.2.0 (2024-08-26) Enhancements [feature][change] anchor: add option to scroll into view #886 [feature] theme: support for GitHub styled alerts #885 Fixes [bug] arrownav: avoid rude event handling for form elements #887 Maintenance [task] 404: move styles to separate file #889 6.1.1 (2024-08-02) Fixes [bug] link: link resolving stopped working in certain configurations #882 6.1.0 (2024-08-02) Enhancements [feature][change] assetbuster: use asset buster for all resources #875 [feature] theme: sync to Hugo changes for PublishDate #872 [feature] theme: allow errorlevel override on page level #870 [feature] relref: provide shortcodes to lift certain restrictions #864 [feature] openapi: adjust to Hugo’s build-in link render hook #860 [feature][change] include: adjust to Hugo’s build-in link render hook #859 Fixes [bug] variant: auto variant references potentially wrong chroma style #873 [bug] schema: sync to Hugo changes for LanguageCode #866 [bug] taxonomy: simplify code #852 [bug] alias: index.html has displays error in content #851 Maintenance [task] icon: update Font Awesome to 6.6.0 #881 [task] math: update MathJax to 3.2.2 #880 [task] openapi: update swagger-ui to 5.17.14 #879 [task] mermaid: update to 10.9.1 #878 [task] theme: remove special cases for LanguageCode #861 [task] link: adjust to Hugo’s build-in code #858 [task] image: adjust to Hugo’s build-in code #857 [task] opengraph: sync to Hugo’s implementation #856 [task] i18n: improve file naming #848 6.0.0 (2024-04-27) Enhancements [feature][breaking] theme: unify description #845 [feature] schema: add schema support in meta data #844 [feature] include: use Hugo’s resources #835 [feature] math: allow to work with Hugo’s passthrough configuration #832 [feature] i18n: add Romanian translation #828 [feature][breaking] menu: remove menuTitle frontmatter #714 [feature][breaking] theme: end support for Internet Explorer 11 #584 Fixes [bug] frontmatter: move frontmatter config for exampleSite out of root #843 [bug] images: color outline using primary color #838 [bug][breaking] variant: avoid Hugo permission errors on build #831 [bug] theme: unwanted paragraph break with AsciiDoc #829 Maintenance [task][breaking] swagger: remove shortcode #847 [task][breaking] search: remove JSON outputformat for search index #846 [task] theme: sync to Hugo’s implementation #841 [task][change] fontawesome: update to 6.5.2 #834 Older Versions Version 5 Version 4 Version 3 Version 2 Version 1",
"description": "The detailed changelog",
"tags": [],
"title": "Changelog",
"uri": "/hugo-theme-relearn/introduction/changelog/index.html"
},
{
"breadcrumb": "Configuration",
"content": "WidthChanging the content area width\nTitles \u0026 BreadcrumbsConfiguring titles and breadcrumbs to your needs\nHeadingsConfiguring heading anchors\nLinkingWhat options are available for links and images\nHidden PagesLearn about the hidden pages feature",
"description": "Configure the content area of your site",
"tags": [],
"title": "Content",
"uri": "/hugo-theme-relearn/configuration/content/index.html"
},
{
"breadcrumb": "Configuration \u003e Site Management",
"content": "Offline Usage The theme is usable offline. No internet connection is required to load your page. This is achieved by storing all dependencies within the theme.\nNo calls to 3rd party servers, no calling home, no tracking. Privacy friendly.\nServer Deployment If your server deployment has no special requirements, you can skip this section and use the standard Hugo options.\nFor special requirements, the theme is capable of different scenarios, requiring the following mandatory settings in your hugo.toml. All settings not mentioned in the examples below can be set to your liking.\nPublic Web Server from Root hugo. toml yaml json baseURL = 'https://example.com/' baseURL: https://example.com/ { \"baseURL\": \"https://example.com/\" } Public Web Server 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 } If you are still using Hugo’s relref shortcode (which you shouldn’t), you will need further configuration.\nWarning Don’t use a baseURL with a subdirectory and relativeURLs=true together. Hugo doesn’t apply the baseURL correctly in this case. If you need both, generate your site twice with different settings into separate directories.\nPrivate Web Server (LAN) The same settings as with any of the public web server scenarios or\nhugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } File System Your generated site can be used headless without a HTTP server.\nThis can be achieved by using the file:// protocol in your browser’s address bar or by double click on a generated *.html file in your file navigation tool.\nUse the following settings\nhugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } Note Pages like sitemap.xml and rss.xml, and social media links will always use absolute URLs. They won’t work with relativeURLs=true.",
"description": "Options for specific deployment needs",
"tags": [],
"title": "Deployment Scenarios",
"uri": "/hugo-theme-relearn/configuration/sitemanagement/deployment/index.html"
},
{
"breadcrumb": "Configuration \u003e Content",
"content": "Further settings are available to be used in your configuration or front matter.\nURL Management Option By default, the theme adds index.html to page links when uglyURLs=false (Hugo’s default).\nIf you’re only using a web server scenario and dislike this, you can reset to Hugo’s default behavior by settings disableExplicitIndexURLs=true.\nFor the file system scenario, you are not allowed to change this value.\nhugo. toml yaml json [params] disableExplicitIndexURLs = true params: disableExplicitIndexURLs: true { \"params\": { \"disableExplicitIndexURLs\": true } } Patching the relref Shortcode Option While the usage of relref is obsolete and discouraged by Hugo for a while, existing installations may still use it.\nIn configurations using a baseURL with a subdirectory and having relativeURLs=false (the default), Hugo’s standard relref implementation is failing.\nTo work around this, you can activate a patched version of the shortcode by setting disableDefaultRelref=true.\nhugo. toml yaml json [params] disableDefaultRelref = true params: disableDefaultRelref: true { \"params\": { \"disableDefaultRelref\": true } }",
"description": "What options are available for links and images",
"tags": [],
"title": "Linking",
"uri": "/hugo-theme-relearn/configuration/content/linking/index.html"
},
{
"breadcrumb": "Authoring",
"content": "Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.\nMarkdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it.\nSome of the key benefits are:\nMarkdown is simple to learn, with minimal extra characters so it’s also quicker to write content. Less chance of errors when writing in Markdown. Produces valid HTML output. Keeps the content and the visual display separate, so you cannot mess up the look of your site. Write in any text editor or Markdown application you like. Markdown is a joy to use! John Gruber, the author of Markdown, puts it like this:\nThe overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email. John Gruber\nTip Bookmark this page for easy future reference!\nStandard and Extensions If not otherwise noted, the shown examples adhere to the CommonMark standard. In addition the theme supports the following extensions that can be activated in your hugo.toml or are built into the theme:\nGFM Extension on top of standard Markdown adhering to GitHub Flavored Markdown.\nPHP Extension on top of standard Markdown adhering to PHP Markdown.\nPants Extension by John Gruber adhering to SmartyPants.\nHugo Hugo Extra Extension supported by Hugo.\nObsidian Extension implemented by Obsidian.\nHTML If the usage of HTML is allowed, the theme supports styling for further HTML elements.\nRelearn Extension specific to this theme.\nParagraphs In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.\nAny text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHeadings A good idea is to structure your content using headings and subheadings. HTML-headings from h1 through h6 are constructed with a # for each level.\nIn Hugo you usually don’t use h1 as this is generated by your theme and you should only have one such element in a document.\n# h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading Result h1 Heading h2 Heading h3 Heading h4 Heading h5 Heading h6 Heading Horizontal Rules To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nBlockquotes Quotations For quoting blocks of content from another source within your document add \u003e before any text you want to quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.\nSed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nGitHub Alerts GFM Since Hugo 0.132.0 GitHub alerts are also supported. Please note, that coloring and icons of severities may defer between GitHub and this theme.\nIf you are in need of more advanced options to style your alerts, like icons, use the notice shortcode.\n\u003e [!CAUTION] \u003e Advises about risks or negative outcomes of certain actions. \u003e [!IMPORTANT] \u003e Key information users need to know to achieve their goal. \u003e [!INFO] \u003e Information that users \u003cins\u003e_might_\u003c/ins\u003e find interesting. \u003e [!NOTE] \u003e Useful information that users should know, even when skimming content. \u003e [!TIP] \u003e Helpful advice for doing things better or more easily. \u003e [!WARNING] \u003e Urgent info that needs immediate user attention to avoid problems. Result Caution Advises about risks or negative outcomes of certain actions.\nImportant Key information users need to know to achieve their goal.\nInfo Information that users might find interesting.\nNote Useful information that users should know, even when skimming content.\nTip Helpful advice for doing things better or more easily.\nWarning Urgent info that needs immediate user attention to avoid problems.\nObsidian Callouts Obsidian Since Hugo 0.134.0 Obsidian callouts are also supported. Which enables configurable title text and expand/collapse.\nIf you are in need of more advanced options to style your alerts, like icons, use the notice shortcode.\n\u003e [!tip] Callouts can have custom titles \u003e Like this one. \u003e [!tip] Title-only callout \u003e [!note]- Are callouts foldable? \u003e Yes! In a foldable callout, the contents are hidden when the callout is collapsed \u003e [!note]+ Are callouts foldable? \u003e Yes! In a foldable callout, the contents are hidden when the callout is collapsed Result Callouts can have custom titles Like this one.\nTitle-only callout Are callouts foldable? Yes! In a foldable callout, the contents are hidden when the callout is collapsed\nAre callouts foldable? Yes! In a foldable callout, the contents are hidden when the callout is collapsed\nText Markers Bold You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks **.\nI am rendered with **bold text** Result I am rendered with bold text\nItalics You can emphasize a snippet of text with italics by enclosing it with underscores _.\nI am rendered with _italicized text_ Result I am rendered with italicized text\nMarked Text You can mark text in the predefined accent color of your stylesheet.\nHugo Since Hugo 0.126.0, you can activate this through the Hugo Extra Extension in your hugo.toml\n==Parts== of this text ==are marked!== HTML You can also use it by configuring Hugo for usage of HTML.\n\u003cmark\u003eParts\u003c/mark\u003e of this text \u003cmark\u003eare marked!\u003c/mark\u003e Result Parts of this text are marked!\nInserted Text You can mark text additions to existing text.\nHugo Since Hugo 0.126.0, you can activate this through the Hugo Extra Extension in your hugo.toml\nThe ++hot, new++ stuff HTML You can also use it by configuring Hugo for usage of HTML.\nThe \u003cins\u003ehot, new\u003c/ins\u003e stuff Result The hot, new stuff\nDeleted Text GFM You can do strikethroughs by enclosing text with two tildes ~~. See Hugo’s documentation remarks if you want to use this together with the subscript syntax.\n~~Strike through~~ this text Result Strike through this text\nSpecial Typesetting Text Substitution Pants You can combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.\nDouble quotes `\"` and single quotes `'` of enclosed text are replaced by **\"double curly quotes\"** and **'single curly quotes'**. Double dashes `--` and triple dashes `---` are replaced by en-dash **--** and em-dash **---** entities. Double arrows pointing left `\u003c\u003c` or right `\u003e\u003e` are replaced by arrow **\u003c\u003c** and **\u003e\u003e** entities. Three consecutive dots `...` are replaced by an ellipsis **...** entity. Result Double quotes \" and single quotes ' of enclosed text are replaced by “double curly quotes” and ‘single curly quotes’.\nDouble dashes -- and triple dashes --- are replaced by en-dash – and em-dash — entities.\nDouble arrows pointing left \u003c\u003c or right \u003e\u003e are replaced by arrow « and » entities.\nThree consecutive dots ... are replaced by an ellipsis … entity.\nSubscript and Superscript You can also use subscript and superscript text. For more complex stuff, you can use the math shortcode.\nHugo Since Hugo 0.126.0, you can activate this through the Hugo Extra Extension in your hugo.toml\nHow many liters H~2~O fit into 1dm^3^? HTML You can also use it by configuring Hugo for usage of HTML.\nHow many liters H\u003csub\u003e2\u003c/sub\u003eO fit into 1dm\u003csup\u003e3\u003c/sup\u003e? Result How many liters H2O fit into 1dm3?\nKeyboard Shortcuts HTML You can use the \u003ckbd\u003e element to style keyboard shortcuts.\nPress \u003ckbd\u003eSTRG\u003c/kbd\u003e \u003ckbd\u003eALT\u003c/kbd\u003e \u003ckbd\u003eDEL\u003c/kbd\u003e to end your shift early. Result Press STRG ALT DEL to end your shift early.\nLists Unordered You can write a list of items in which the order of the items does not explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nYou may use any of -, * or + to denote bullets for each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipiscing elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipiscing elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered You can create a list of items in which the order of items does explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nMarkdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipiscing elit 1. Integer molestie lorem at massa 7. Facilisis in pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks GFM You can add task lists resulting in checked or unchecked non-clickable items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definitions PHP Definition lists are made of terms and definitions of these terms, much like in a dictionary.\nA definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.\nIf you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible\nApple : Pomaceous fruit of plants of the genus Malus in the family Rosaceae. : An American computer company. Orange : The fruit of an evergreen tree of the genus Citrus. You can make juice out of it. : A telecommunication company. You can't make juice out of it. Result Apple Pomaceous fruit of plants of the genus Malus in the family Rosaceae. An American computer company. Orange The fruit of an evergreen tree of the genus Citrus. You can make juice out of it.\nA telecommunication company. You can’t make juice out of it.\nCode Inline Code Inline snippets of code can be wrapped with backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` is marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e is marked as code.\nIndented Code Block A simple code block can be generated by indenting several lines of code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 of code line 2 of code line 3 of code Result Be impressed by my advanced code:\n// Some comments line 1 of code line 2 of code line 3 of code Fenced Code Block If you want to gain more control of your code block you can enclose your code by at least three backticks ``` a so called fence.\nGFM You can also add a language specifier directly after the opening fence, ```js, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.\nSee Code Highlighting for additional documentation.\n```js { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; ``` Result { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; Tables GFM You can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.\n| Option | Description | |--------|-------------| | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | Result Option Description data path to data files to supply the data that will be passed into templates. engine engine to be used for processing templates. Handlebars is the default. ext extension to be used for dest files. Aligned Columns Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.\n| Option | Number | Description | |-------:|:------:|:------------| | data | 1 | path to data files to supply the data that will be passed into templates. | | engine | 2 | engine to be used for processing templates. Handlebars is the default. | | ext | 3 | extension to be used for dest files. | Result Option Number Description data 1 path to data files to supply the data that will be passed into templates. engine 2 engine to be used for processing templates. Handlebars is the default. ext 3 extension to be used for dest files. Links Autolink GFM Absolute URLs will automatically be converted into a link.\nThis is a link to https://example.com. Result This is a link to https://example.com.\nBasic Link You can explicitly define links in case you want to use non-absolute URLs or want to give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink with Tooltip For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go to example domain\" Result Example\nFootnotes PHP Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.\nUsually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.\nFootnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.\nThat's some text with a footnote[^1] [^1]: And that's the footnote. That's some more text with a footnote.[^someid] [^someid]: Anything of interest goes here. Blue light glows blue. Result That’s some text with a footnote1\nThat’s some more text with a footnote.2\nAnd that’s the footnote. ↩︎\nAnything of interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar syntax to links but include a preceding exclamation mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image with Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects Relearn This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. See the image effects docs for a detailed example and how to configure it.\nResizing Add query parameter width and/or height to the link image to resize the image. Values are CSS values (default is auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combination ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add the query parameter lightbox=false to the image link to disable the lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Note If you want to wrap an image in a link and lightbox=true is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)",
"description": "Reference of CommonMark and Markdown extensions",
"tags": [],
"title": "Markdown Syntax",
"uri": "/hugo-theme-relearn/authoring/markdown/index.html"
},
{
"breadcrumb": "Configuration \u003e Sidebar",
"content": "The theme can build menu trees from the structure of your page files or from Hugo’s build in menu feature.\nOption All configuration options in your hugo.toml apply to all menus but can be changed individually.\nFront Matter In case of page structure menus, individual configuration is done via a page’s front matter.\nMenu. In case of Hugo menus, individual configuration is done via a menu entry’s configuration.\nExpand State of Submenus Option Front Matter You can change how submenus appear with alwaysopen.\nMenu For Hugo menus, you have to set params.alwaysopen instead.\nIf alwaysopen=false for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.\nThe theme generates the expand state based on the following rules:\nall parent entries of the active page including their visible siblings are shown regardless of any settings immediate child entries of the active entry are shown regardless of any settings if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries of levels besides the first behave like they would have been given alwaysopen=true all visible entries show their immediate child entries if alwaysopen=true; this proceeds recursively all remaining entries are not shown ​ toml yaml json alwaysopen = false alwaysopen: false { \"alwaysopen\": false } Expander for Submenus Option Front Matter Set collapsibleMenu=true to show submenus as collapsible trees with a clickable expander.\nMenu For Hugo menus, you have to set params.collapsibleMenu=true instead.\n​ toml yaml json collapsibleMenu = true collapsibleMenu: true { \"collapsibleMenu\": true } Warning Using this option may cause degraded build performance by slowing down your build process.\nThis is usually the case for menus with many entries and happens for page menus as well as for Hugo menus.\nWe’ve seen builds taking 2 minutes with 1000+ pages, and over 30 minutes with 5000+ pages when using a page menu.\nThis happens because each new page affects all other pages, leading to exponentially longer build times.\nOrdering Menu Entries By Weight Front Matter Menu Hugo provides a simple way to handle order of your entries by setting the weight front matter to a number.\nHugo menus can only be sorted using the weight method.\n​ toml yaml json weight = 5 weight: 5 { \"weight\": 5 } By Other Using the weight for sorting can get cumbersome if you, for example, just want to sort alphabetically. Each time you add a new page in the set of pages, you may have to renumber some or all of them to make space for the new page.\nOption Front Matter Use ordersectionsby to sort by other aspects. See the children shortcode for a complete list.\n​ toml yaml json ordersectionsby = 'linktitle' ordersectionsby: linktitle { \"ordersectionsby\": \"linktitle\" } Title for Menu Entries Front Matter A page’s linkTitle or title front matter will be used for naming a menu entry of a page menu, in that order if both are defined. Using linkTitle helps to shorten the text for menu entries if the page’s title is too descriptive.\nMenu A menu entry’s title or name will be used for naming a menu entry of a Hugo menu, in that order if both are defined.\nFor example for a page named install/linux.md\n​ toml yaml json +++ linkTitle = 'Linux' title = 'Install on Linux' +++ --- linkTitle: Linux title: Install on Linux --- { \"linkTitle\": \"Linux\", \"title\": \"Install on Linux\" } Icons for Menu Entries Front Matter For page menus, add a menuPre to insert any HTML code before the menu label. You can also set menuPost to insert HTML code after the menu label.\nMenu For Hugo menus, add a pre to insert any HTML code before the menu label. You can also set post to insert HTML code after the menu label.\nIf pageRef is set for the menu entry and no pre or post was configured, menuPre and menuPost of the referenced page will be taken.\nThe example below uses the GitHub icon for an entry of a page menu.\n​ toml yaml json +++ menuPre = '\u003ci class=\"fab fa-github\"\u003e\u003c/i\u003e ' title = 'GitHub Repo' +++ --- menuPre: '\u003ci class=\"fab fa-github\"\u003e\u003c/i\u003e ' title: GitHub Repo --- { \"menuPre\": \"\\u003ci class=\\\"fab fa-github\\\"\\u003e\\u003c/i\\u003e \", \"title\": \"GitHub Repo\" } Disable Menu Entries You may want to structure your entries in a hierarchical way but don’t want to generate clickable parent entries? The theme got you covered.\nFor Page Menus To stay with the initial example: Suppose you want first-chapter/first-page appear in the sidebar but don’t want to generate a page for it. So the entry in the sidebar should not be clickable but should be expandable.\nFor this, open content/first-chapter/first-page/_index.md and add the following front matter\n​ toml yaml json +++ [_build] render = 'never' +++ --- _build: render: never --- { \"_build\": { \"render\": \"never\" } } For Hugo Menus Just don’t give your parent menu entry configuration a url or pageRef. See the next section for a special case.\nIf you want to learn how to configure different Hugo menus for each language, see the official docs.\n​ toml yaml json +++ [menu] [[menu.addendum]] name = 'Parent 1' weight = 1 [[menu.addendum]] name = 'Child 1' parent = 'Parent 1' url = 'https://example.com/1' [[menu.addendum]] name = 'Parent 2' weight = 2 [[menu.addendum]] name = 'Child 2' parent = 'Parent 2' url = 'https://example.com/2' +++ --- menu: addendum: - name: Parent 1 weight: 1 - name: Child 1 parent: Parent 1 url: https://example.com/1 - name: Parent 2 weight: 2 - name: Child 2 parent: Parent 2 url: https://example.com/2 --- { \"menu\": { \"addendum\": [ { \"name\": \"Parent 1\", \"weight\": 1 }, { \"name\": \"Child 1\", \"parent\": \"Parent 1\", \"url\": \"https://example.com/1\" }, { \"name\": \"Parent 2\", \"weight\": 2 }, { \"name\": \"Child 2\", \"parent\": \"Parent 2\", \"url\": \"https://example.com/2\" } ] } } Title for Menus Each menu may have an optional title above its tree. This must be activated for each menu by setting disableMenuTitle=false for each sidebar menu configuration.\nFront Matter For page menus, set the menuTitle front matter for the root page of the menu. For example in the home page for the default sidebar menu. If no menuTitle was set, the title will be taken from your translation files by the key \u003cidentifier\u003e-menuTitle, where \u003cidentifier\u003e is the identifier of your sidebar menu configuration.\nMenu For Hugo menus, the title will be taken from your translation files by the key \u003cidentifier\u003e-menuTitle, where \u003cidentifier\u003e is the identifier of your sidebar menu configuration.\nIf you don’t want to fiddle around with your translation files, you also have the possibility to let the title be taken from the menu definition. For that, define a nested menu that only has one top-level entry without url or pageRef.\nIn this case, the title or name is taken for the menu heading.\nIf you want to learn how to configure different Hugo menus for each language, see the official docs.\n​ toml yaml json +++ [menu] [[menu.addendum]] name = 'A Menu Title for the Whole Menu' [[menu.addendum]] name = 'A Menu Entry Title for Child 1' parent = 'Parent' url = 'https://example.com/1' weight = 1 [[menu.addendum]] name = 'A Menu Entry Title for Child 2' parent = 'Parent' url = 'https://example.com/2' weight = 2 +++ --- menu: addendum: - name: A Menu Title for the Whole Menu - name: A Menu Entry Title for Child 1 parent: Parent url: https://example.com/1 weight: 1 - name: A Menu Entry Title for Child 2 parent: Parent url: https://example.com/2 weight: 2 --- { \"menu\": { \"addendum\": [ { \"name\": \"A Menu Title for the Whole Menu\" }, { \"name\": \"A Menu Entry Title for Child 1\", \"parent\": \"Parent\", \"url\": \"https://example.com/1\", \"weight\": 1 }, { \"name\": \"A Menu Entry Title for Child 2\", \"parent\": \"Parent\", \"url\": \"https://example.com/2\", \"weight\": 2 } ] } } Title for the Predefined Shortcut Menu Option By default, the predefined shortcut menu has a the title More (in the English translation).\nYou can disable this title with disableShortcutsTitle=true.\nhugo. toml yaml json [params] disableShortcutsTitle = true params: disableShortcutsTitle: true { \"params\": { \"disableShortcutsTitle\": true } } To change the title, override your translation file.\n​ i18n/en.toml [shortcuts-menuTitle] other = \"Other Great Stuff\" Defining Sidebar Menus Option Front Matter Menus are defined using the sidebarmenus option.\nYou can define as many menus, as you like. If you don’t overwrite this option, the theme defaults to\n​ toml yaml json [[sidebarmenus]] disableTitle = true identifier = 'home' main = true pageRef = '' type = 'page' [[sidebarmenus]] disableTitle = false identifier = 'shortcuts' main = false type = 'menu' sidebarmenus: - disableTitle: true identifier: home main: true pageRef: \"\" type: page - disableTitle: false identifier: shortcuts main: false type: menu { \"sidebarmenus\": [ { \"disableTitle\": true, \"identifier\": \"home\", \"main\": true, \"pageRef\": \"\", \"type\": \"page\" }, { \"disableTitle\": false, \"identifier\": \"shortcuts\", \"main\": false, \"type\": \"menu\" } ] } Parameter Name Default Notes type \u003cempty\u003e The type of menu.\n- page for a page menu\n- menu for a Hugo menu identifier \u003cempty\u003e A unique identifier for this entry\n- for type=page an arbitrary name\n- for page=menu the identifier of the menu definition in your hugo.toml main see notes Whether to add additional spacing and larger text to the menu\n- for type=page defaults to true\n- for page=menu defaults to false disableTitle see notes Whether to print a title above the menu\n- for type=page defaults to true\n- for page=menu defaults to false pageRef \u003cempty\u003e Only for type=page, the page path to start the menu tree. If not set, defaults to the home page. Redefining Sidebar Menus for Certain Pages Suppose you are building a site that contains a topmost blog and documentation section.\nWhen the user is on one of the blog pages he should only see a menu containing all blog pages, while on a documentation page he should only see a menu containing all doc pages.\nDirectory structure:\ncontent ├── blog │ ├── post-1.md │ ├── post-2.md │ ├── post-3.md │ └── _index_.md ├── docs │ ├── topic-1.md │ ├── topic-2.md │ ├── topic-3.md │ └── _index_.md └── _index.md Option Front Matter Using Hugo’s cascade feature, we can redefine the menus once in blog/_index.md and docs/_index.md setting sidebarmenus so they will be used in all children pages.\nblog/_index.md toml yaml json +++ title = 'Blog' [[cascade]] [cascade.params] [[cascade.params.sidebarmenus]] identifier = 'blog' pageRef = '/blog' type = 'page' +++ --- cascade: - params: sidebarmenus: - identifier: blog pageRef: /blog type: page title: Blog --- { \"cascade\": [ { \"params\": { \"sidebarmenus\": [ { \"identifier\": \"blog\", \"pageRef\": \"/blog\", \"type\": \"page\" } ] } } ], \"title\": \"Blog\" } docs/_index.md toml yaml json +++ title = 'Documentation' [[cascade]] [cascade.params] [[cascade.params.sidebarmenus]] identifier = 'docs' pageRef = '/docs' type = 'page' +++ --- cascade: - params: sidebarmenus: - identifier: docs pageRef: /docs type: page title: Documentation --- { \"cascade\": [ { \"params\": { \"sidebarmenus\": [ { \"identifier\": \"docs\", \"pageRef\": \"/docs\", \"type\": \"page\" } ] } } ], \"title\": \"Documentation\" } Displaying Arbitrary Links in a Page Menu You may have the need to add arbitrary links at some point in your menu that are initially not backed by a page. These are called crosslinks.\nAssume the following structure\ncontent ├── reference │ ├── ref-a.md │ ├── ref-b.md │ ├── ref-c.md │ └── _index_.md ├── topic-blue.md ├── topic-red.md ├── topic-yellow.md └── _index_.md You now want to include ref-b as separate entry after topic-green in your menu.\nFor that create a new page with the following front matter\ncontent/topic-green.md toml yaml json +++ menuPageRef = '/reference/ref-b' title = 'Topic Green' +++ --- menuPageRef: /reference/ref-b title: Topic Green --- { \"menuPageRef\": \"/reference/ref-b\", \"title\": \"Topic Green\" } Front Matter If you want to link to an external page instead, you can use menuUrl instead of menuPageRef.\nPages defining a crosslink are never part of the arrow navigation and are skipped instead.\nSo with the above example and alphabetical sorting of the menu entries, pressing on topic-blue will skip the newly added topic-green and instead will load topic-red.\nHaving sub pages below a page that defines a crosslink is undefined.\nDisplaying Pages Exclusively in a Hugo Menu Sometimes you want to hide pages from the page menu but instead want to show them in a Hugo menu. For that you have two choices\nCreate a headless branch bundle, _index.md in its own folder with the below front matter. The branch bundle will not be contained in the sitemap.\ncontent/showcase/_index.en.md toml yaml json +++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++ --- _build: list: never publishResources: true render: always title: Showcase --- { \"_build\": { \"list\": \"never\", \"publishResources\": true, \"render\": \"always\" }, \"title\": \"Showcase\" } Or, put a child page inside a headless branch bundle with the following front matter in the bundle. This causes the child but not the branch bundle to be contained in the sitemap.\ncontent/more/_index.en.md toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } The child page can be any type of content.\ncontent/more/credits_index.en.md toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" }",
"description": "Configure all things menus",
"tags": [],
"title": "Menus",
"uri": "/hugo-theme-relearn/configuration/sidebar/menus/index.html"
},
{
"breadcrumb": "",
"content": "Hugo uses Markdown as its content format. However, there are a lot of things that Markdown doesn’t support well.\nYou could use pure HTML to expand your possibilities. But this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read. You should avoid HTML to keep it as simple and portable as possible.\nTo avoid Markdown’s limitations, Hugo created shortcodes. A shortcode is a simple snippet inside of a page.\nThe Relearn theme provides many shortcodes on top of Hugo’s existing ones.\nBadgeMarker badges to display in your text\nButtonClickable buttons\nChildrenList the child pages of a page\nExpandExpandable/collapsible sections of text\nHighlightRender code with a syntax highlighter\nIconNice icons for your page\nIncludeDisplays content from other files\nMathBeautiful math and chemical formulae\nMermaidGenerate diagrams and flowcharts from text\nNoticeDisclaimers to help you structure your page\nOpenAPIUI for your OpenAPI / Swagger specifications\nResourcesList resources contained in a page bundle\nSiteParamGet value of site params\nTabShow content in a single tab\nTabsShow content in tabbed views",
"description": "Hugo uses Markdown as its content format. However, there are a lot of things that Markdown doesn’t support well.",
"tags": [],
"title": "Shortcodes",
"uri": "/hugo-theme-relearn/shortcodes/index.html"
},
{
"breadcrumb": "Configuration \u003e Branding",
"content": "This interactive tool may help you to generate your own color variant stylesheet.\nShow 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.\nThe graph is interactive and reflects 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.\nThe arrowed lines reflect how colors are inherited through different parts of the theme if the descendant isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.\nTo better understand this, select the neon variant and modify the different heading colors. There, colors for the headings h2, h3 and h4 are explicitly set. h5 is not set and inherits its value from h4. h6 is also not set and inherits its value from h5.\nOnce you’ve changed a color, the variant selector will show a “My custom variant” entry and your changes are stored in the browser. You can browse to other pages and even close the browser without losing your changes.\nOnce you are satisfied, you can download the new variants file and copy it into your site’s assets/css directory.\nOption Afterwards, you have to adjust the themeVariant option in your hugo.toml to your chosen file name. For example, if your new variants file is named theme-my-custom-variant.css, you have to set themeVariant='my-custom-variant' to use it.\nSee the docs for further configuration options.\nDownload variant Reset variant\nGraph Download variant Reset variant",
"description": "An interactive tool to generate color variant stylesheets",
"tags": [],
"title": "Stylesheet Generator",
"uri": "/hugo-theme-relearn/configuration/branding/generator/index.html"
},
{
"breadcrumb": "Authoring \u003e Front Matter",
"content": "This page is about how to configure the topbar using configuration options. If you want to add further buttons or functionality, see this section.\nYour topbar contains the following elements. Some of them are configuarable:\nsidebar: opens the sidebar flyout if in mobile layout toc: opens the table of contents in an overlay breadcrumb: shows the clickable breadcrumbs edit: browses to the editable page if the editURL parameter is set print: browses to the chapters printable page if print support was activated prev: browses to the previous page if there is one next: browses to the next page if there is one more: opens the overlay if screen space is limited Table of Contents Option Front Matter Set disableToc=true to hide the TOC button on all pages. If the button is hidden, also the keyboard shortcut is disabled. This can be overridden in a page’s front matter.\n​ toml yaml json disableToc = true disableToc: true { \"disableToc\": true } Breadcrumbs Option Front Matter Set disableBreadcrumb=true to hide the breadcrumb in the topbar.\nFurther breadcrumbs settings can be found in the content configuration section.\n​ toml yaml json disableBreadcrumb = true disableBreadcrumb: true { \"disableBreadcrumb\": true } Edit Button Option Front Matter If editURL is set to a URL, an edit button will be shown in the topbar. If the button is hidden, also the keyboard shortcut is disabled.\nThe value can contain the macro ${FilePath} which will be replaced by the file path of your displayed page. If no ${FilePath} is given in the value, the value is treated as if the ${FilePath} was appended at the end of the value. This can be overridden in the pages front matter.\n​ toml yaml json editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' editURL: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath} { \"editURL\": \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\" } Arrow Navigation Option Front Matter You can hide the previous/next buttons by setting disableNextPrev=true. If the buttons are hidden, also the keyboard shortcuts are disabled.\n​ toml yaml json disableNextPrev = true disableNextPrev: true { \"disableNextPrev\": true }",
"description": "Configure the topbar",
"tags": [],
"title": "Topbar",
"uri": "/hugo-theme-relearn/authoring/frontmatter/topbar/index.html"
},
{
"breadcrumb": "Configuration \u003e Customization",
"content": "The theme comes with a reasonably configured topbar. You can learn how to configure the defaults in this section.\nNevertheless, your requirements may differ from this configuration. Luckily, the theme has you covered as the topbar, its buttons, and the functionality behind these buttons are fully configurable by you.\nTip All mentioned file names below can be clicked and show you the implementation for a better understanding.\nAreas The default configuration comes with three predefined areas that may contain an arbitrary set of buttons.\nstart: shown between menu and breadcrumb end: shown on the opposite breadcrumb side in comparison to the start area more: shown when pressing the more button in the topbar While you cannot add additional areas in the topbar, you are free to configure additional buttons that behave like the more button, providing further user-defined areas.\nButtons The theme ships with the following predefined buttons (from left to right in the screenshot):\nsidebar: opens the sidebar flyout if in mobile layout toc: opens the table of contents in an overlay edit: browses to the editable page if the editURL parameter is set print: browses to the chapter’s printable page if print support was activated prev: browses to the previous page if there is one next: browses to the [next page]authoring/frontmatter/topbar(#arrow-navigation) if there is one more: opens the overlay for the more area Not all buttons are displayed at every given time. This is configurable (see below if interested).\nRedefining Areas Each predefined area and button comes in its own file. By that, it is easy for you to overwrite an area file in your installation, reusing only the buttons you like.\nE.g., you can redefine the predefined end area by adding the file layouts/partials/topbar/area/end.html in your installation (not in the theme itself) to remove all but the more button.\nThe below example sets an explicit value for the onempty parameter, overriding the specific default value for this button (these defaults vary depending on the button). The parameter causes the more button to always be displayed instead of hiding once its content is empty.\n{{ partial \"topbar/button/more.html\" (dict \"page\" . \"onempty\" \"disable\" )}} Defining Own Buttons Button Types The theme distinguishes between two types of buttons:\nbutton: a clickable button that either browses to another site, triggers a user-defined script or opens an overlay containing user-defined content area-button: the template for the more button, to define your own area overlay buttons Button Parameter Screen Widths and Actions Depending on the screen width, you can configure how the button should behave. Screen width is divided into three classes:\ns: (controlled by the onwidths parameter) mobile layout where the menu sidebar is hidden m: (controlled by the onwidthm parameter) desktop layout with visible sidebar while the content area width still resizes l: (controlled by the onwidthl parameter) desktop layout with visible sidebar once the content area reached its maximum width For each width class, you can configure one of the following actions:\nshow: the button is displayed in its given area hide: the button is removed area-XXX: the button is moved from its given area into the area XXX; for example, this is used to move buttons to the more area overlay in the mobile layout Hiding and Disabling Stuff While hiding a button depending on the screen size can be configured with the above-described hide action, you may want to hide the button on certain other conditions as well.\nFor example, the print button in its default configuration should only be displayed if print support was configured. This is done in your button template by checking the conditions first before displaying the button (see layouts/partials/topbar/button/print.html).\nAnother preferred condition for hiding a button is if the displayed overlay is empty. This is the case for the toc (see layouts/partials/topbar/button/toc.html) as well as the more button (see layouts/partials/topbar/button/more.html) and controlled by the parameter onempty.\nThis parameter can have one of the following values:\ndisable: the button is displayed in a disabled state if the overlay is empty hide: the button is removed if the overlay is empty If you want to disable a button containing no overlay, this can be achieved by an empty href parameter. An example can be seen in the prev button (see layouts/partials/topbar/button/prev.html) where the URL for the previous site may be empty.\nReference Button Contains the basic button functionality and is used as a base implementation for all other buttons (layouts/partials/topbar/func/button.html).\nCall this from your own button templates if you want to implement a button without an overlay like the print button (layouts/partials/topbar/button/print.html) or with an overlay containing arbitrary content like the toc button (layouts/partials/topbar/button/toc.html).\nFor displaying an area in the button’s overlay, see Area-Button.\nParameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. class \u003cempty\u003e Mandatory unique class name for this button. Displaying two buttons with the same value for class is undefined. href \u003cempty\u003e Either the destination URL for the button or JavaScript code to be executed on click.\n- If starting with javascript: all following text will be executed in your browser\n- Every other string will be interpreted as URL\n- If empty, the button will be displayed in a disabled state regardless of its content icon \u003cempty\u003e Font Awesome icon name. onempty disable Defines what to do with the button if the content parameter was set but ends up empty:\n- disable: The button is displayed in a disabled state.\n- hide: The button is removed. onwidths show The action that should be executed if the site is displayed in the given width:\n- show: The button is displayed in its given area\n- hide: The button is removed.\n- area-XXX: The button is moved from its given area into the area XXX. onwidthm show See above. onwidthl show See above. hint \u003cempty\u003e Arbitrary text displayed in the tooltip. title \u003cempty\u003e Arbitrary text for the button. content \u003cempty\u003e Arbitrary HTML to put into the content overlay. This parameter may be empty. In this case, no overlay will be generated. Area-Button Contains the basic functionality to display area overlay buttons (layouts/partials/topbar/func/area-button.html).\nCall this from your own button templates if you want to implement a button with an area overlay like the more button (layouts/partials/topbar/button/more.html).\nParameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. area \u003cempty\u003e Mandatory unique area name for this area. Displaying two areas with the same value for area is undefined. icon \u003cempty\u003e Font Awesome icon name. onempty disable Defines what to do with the button if the content overlay is empty:\n- disable: The button is displayed in a disabled state.\n- hide: The button is removed. onwidths show The action that should be executed if the site is displayed in the given width:\n- show: The button is displayed in its given area\n- hide: The button is removed.\n- area-XXX: The button is moved from its given area into the area XXX. onwidthm show See above. onwidthl show See above. hint \u003cempty\u003e Arbitrary text displayed in the tooltip. title \u003cempty\u003e Arbitrary text for the button. Predefined Buttons The predefined buttons by the theme (all other buttons besides the more and toc button in layouts/partials/topbar/button).\nCall these from your own redefined area templates if you want to use default button behavior.\nThe \u003cvarying\u003e parameter values are different for each button and configured for standard behavior as seen on this page.\nParameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. onwidths \u003cvarying\u003e The action that should be executed if the site is displayed in the given width:\n- show: The button is displayed in its given area\n- hide: The button is removed.\n- area-XXX: The button is moved from its given area into the area XXX. onwidthm \u003cvarying\u003e See above. onwidthl \u003cvarying\u003e See above. Predefined Overlay-Buttons The predefined buttons by the theme that open an overlay (the more and toc button in layouts/partials/topbar/button).\nCall these from your own redefined area templates if you want to use default button behavior utilizing overlay functionality.\nThe \u003cvarying\u003e parameter values are different for each button and configured for standard behavior as seen on this page.\nParameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. onempty disable Defines what to do with the button if the content overlay is empty:\n- disable: The button is displayed in a disabled state.\n- hide: The button is removed. onwidths \u003cvarying\u003e The action that should be executed if the site is displayed in the given width:\n- show: The button is displayed in its given area\n- hide: The button is removed.\n- area-XXX: The button is moved from its given area into the area XXX. onwidthm \u003cvarying\u003e See above. onwidthl \u003cvarying\u003e See above.",
"description": "How to extend the topbar",
"tags": [],
"title": "Topbar",
"uri": "/hugo-theme-relearn/configuration/customization/topbar/index.html"
},
{
"breadcrumb": "Configuration \u003e Site Management",
"content": "Print Support Enable print support to print entire chapters or the whole site. Add the print output format to your home, section, and page in hugo.toml:\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'print'] page = ['html', 'rss', 'print'] section = ['html', 'rss', 'print'] outputs: home: - html - rss - print page: - html - rss - print section: - html - rss - print { \"outputs\": { \"home\": [ \"html\", \"rss\", \"print\" ], \"page\": [ \"html\", \"rss\", \"print\" ], \"section\": [ \"html\", \"rss\", \"print\" ] } } This adds a printer icon in the topbar. Clicking it switches to print preview, showing the page and its visible subpages in a printer-friendly format. Use your browser’s print function to print or save as PDF.\nThe URL won’t be configured ugly for Hugo’s URL handling, even with uglyURLs=true in hugo.toml. This is because each mime type can only have one suffix.\nIf you don’t like the URLs, you can reconfigure outputFormats.print in your hugo.toml to something other than the default of:\nhugo. toml yaml json [outputFormats] [outputFormats.print] baseName = 'index.print' isHTML = true mediaType = 'text/html' name = 'print' noUgly = true permalinkable = false outputFormats: print: baseName: index.print isHTML: true mediaType: text/html name: print noUgly: true permalinkable: false { \"outputFormats\": { \"print\": { \"baseName\": \"index.print\", \"isHTML\": true, \"mediaType\": \"text/html\", \"name\": \"print\", \"noUgly\": true, \"permalinkable\": false } } }",
"description": "What other formats can a page be displayed in",
"tags": [],
"title": "Available Output Formats",
"uri": "/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html"
},
{
"breadcrumb": "Configuration",
"content": "PartialsModifying partials to your needs\nExtending ScriptsAdd further code to your site\nImage EffectsHow to extend image effects\nTopbarHow to extend the topbar\nPage DesignsExtending page designs\nOutput FormatsAdding Custom Output Formats\nTaxonomiesHow to display custom taxonomies on your pages",
"description": "Customize files for advanced usage",
"tags": [],
"title": "Customization",
"uri": "/hugo-theme-relearn/configuration/customization/index.html"
},
{
"breadcrumb": "",
"content": "This chapter contains information only needed for development and maintaining the theme.\nContributingWhat to know if you want to contribute\nMaintainingWhat to know as a maintainer\nScreenshotsRecipe to create various documentation screenshots",
"description": "This chapter contains information only needed for development and maintaining the theme.",
"tags": [],
"title": "Development",
"uri": "/hugo-theme-relearn/development/index.html"
},
{
"breadcrumb": "Configuration \u003e Content",
"content": "This theme allows you to create hidden pages.\nHidden pages are created but not shown in the navigation. This is useful for pages you only want to access via a direct link.\nWhen you visit a hidden page’s URL, it will appear in the navigation menu.\nHidden pages can also have hidden subpages, creating multiple levels of hiding.\nBy default, hidden pages are only hidden from human visitors. Search engines can still find them by crawling your site and the pages are linked in your taxonomies and site search. You can prevent this with these options.\nHide from Search Option To remove hidden pages from search results, use disableSearchHiddenPages=true.\nhugo. toml yaml json [params] disableSearchHiddenPages = true params: disableSearchHiddenPages: true { \"params\": { \"disableSearchHiddenPages\": true } } Hide from Search Engines Option To hide pages from search engines by removing them from the sitemap, RSS feed and make them nofollow, use disableSeoHiddenPages=true.\nhugo. toml yaml json [params] disableSeoHiddenPages = true params: disableSeoHiddenPages: true { \"params\": { \"disableSeoHiddenPages\": true } } Hide from Taxonomies Option To prevent hidden pages from appearing on taxonomy and term pages, use disableTagHiddenPages=true. If this makes a term’s count zero, an empty term page will still be created but not linked.\nhugo. toml yaml json [params] disableTagHiddenPages = true params: disableTagHiddenPages: true { \"params\": { \"disableTagHiddenPages\": true } }",
"description": "Learn about the hidden pages feature",
"tags": [],
"title": "Hidden Pages",
"uri": "/hugo-theme-relearn/configuration/content/hidden/index.html"
},
{
"breadcrumb": "Authoring",
"content": "The theme offers graphical effects for your linked images.\nYou can define additional custom image effects and set defaults in your configuration.\nThe default image effects shipped with the theme are\nName Description border Draws a light thin border around the image lazy Lets the image be lazy loaded lightbox The image will be clickable to show it enlarged shadow Draws a shadow around the image to make it appear hovered/glowing One way to use them is to add them as URL query parameter to each individually linked image.\nThis can become cumbersome to be done consistently for the whole site. Instead, you can configure the defaults in your hugo.toml as well as overriding these defaults in a page’s front matter.\nExplicitly set URL query parameter will override the defaults set for a page or your site.\nWithout any settings in your hugo.toml imageEffects defaults to\n​ toml yaml json [imageEffects] border = false lazy = true lightbox = true shadow = false imageEffects: border: false lazy: true lightbox: true shadow: false { \"imageEffects\": { \"border\": false, \"lazy\": true, \"lightbox\": true, \"shadow\": false } } Front Matter This can be overridden in a pages front matter for example by\n​ toml yaml json +++ [imageEffects] lazy = false +++ --- imageEffects: lazy: false --- { \"imageEffects\": { \"lazy\": false } } Or by explicitly override settings by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lazy=true\u0026lightbox=false) The settings applied to the above image would be\n​ toml yaml json border = true lazy = true lightbox = false shadow = false border: true lazy: true lightbox: false shadow: false { \"border\": true, \"lazy\": true, \"lightbox\": false, \"shadow\": false }",
"description": "How to apply graphical effects to your images",
"tags": [],
"title": "Image Effects",
"uri": "/hugo-theme-relearn/authoring/imageeffects/index.html"
},
{
"breadcrumb": "Configuration \u003e Customization",
"content": "A page is displayed by exactly one page design. The Relearn theme offers the page designs home, chapter, and default.\nA page design usually consists of\nan archetype file: a template for creating new Markdown files with this design content view files: represented by Hugo’s reserved type front matter and backed by matching partials CSS styles If no type is set in your front matter, the page is treated as if type='default' was set.\nWarning Don’t use the type option in your modifications for other functionality!\nAll shipped designs use the theme’s framework from themes/hugo-theme-learn/layouts/_default/baseof.html, containing of the same topbar and sidebar but can change how content appears in the center of the page.\nUsing a Page Design Regardless of shipped or custom page design, you are using them in the same way.\nCreating a Page Designs To make a custom page design:\nChoose a name (for example, mydesign)\nCreate a content view file at layouts/mydesign/views/article.html\n​ layouts/mydesign/views/article.html \u003carticle class=\"mydesign\"\u003e \u003cheader class=\"headline\"\u003e {{ partial \"content-header.html\" . }} \u003c/header\u003e \u003cdiv class=\"article-subheading\"\u003eAWESOME\u003c/div\u003e {{ partial \"heading-pre.html\" . }}{{ partial \"heading.html\" . }}{{ partial \"heading-post.html\" . }} {{ partial \"article-content.html\" . }} \u003cfooter class=\"footline\"\u003e {{ partial \"content-footer.html\" . }} \u003c/footer\u003e \u003c/article\u003e In this file, you can customize the page design as needed. Typically, you’ll want to:\nSet a class at the article element for custom CSS styles Use {{ partial \"article-content.html\" . }} to show your page content Create an archetype file at archetypes/mydesign.md (optional)\n​ archetypes/mydesign.md +++ title = \"{{ replace .Name \"-\" \" \" | title }}\" type = \"mydesign\" +++ This is my new design. Add CSS in file layouts/partials/custom-header.html (optional)\n​ layouts/partials/custom-header.html \u003cstyle\u003e .mydesign .article-subheading { font-size: 72rem; } .mydesign a { background-color: pink; } \u003c/style\u003e Partials The above example uses layouts/mydesign/views/article.html but you have some others\nlayouts/mydesign/baseof.html: Completely redefine the whole HTML structure, none of the other listed partials will be used layouts/mydesign/views/menu.html: Defines the sidebar menu layout layouts/mydesign/views/body.html: Determines what to contain in the content area (for example a single page, a list of pages, a tree of sub pages) layouts/mydesign/views/article.html: Controls how one page’s content and title are displayed",
"description": "Extending page designs",
"tags": [],
"title": "Page Designs",
"uri": "/hugo-theme-relearn/configuration/customization/designs/index.html"
},
{
"breadcrumb": "Authoring \u003e Front Matter",
"content": "Every Hugo page must have front matter.\nIn addition to Hugo’s standard front matter, the Relearn theme offers extras settings listed here.\nThroughout the documentation, theme-specific front matter is marked with a Front Matter badge.\nAdd theme front matter directly to the root of your page’s front matter. For example:\n​ toml yaml json +++ math = true +++ --- math: true --- { \"math\": true } Index A Alwaysopen (1) C CollapsibleMenu (1) CustomMathJaxURL (1) CustomMermaidURL (1) CustomOpenapiURL (1) D Description (1) DisableBreadcrumb (1) DisableNextPrev (1) DisableToc (1) E EditURL (1) ExternalLinkTarget (1) H HeadingPost (1) HeadingPre (1) Hidden (1) HighlightWrap (1) I Image.errorlevel (1) ImageEffects (1) Include.errorlevel (1) L LastModifierDisplayName (1) LastModifierEmail (1) Link.errorlevel (1) LinkTitle (1) M Math (1) Math.force (1) MathJaxInitialize (1) MenuPageRef (1) MenuPost (1) MenuPre (1) MenuUrl (1) Mermaid.force (1) MermaidInitialize (1) MermaidZoom (1) O Openapi.errorlevel (1) Openapi.force (1) Ordersectionsby (2) S Sidebarmenus (1) All Front Matter Here’s a list of all available front matter with example values. Default values are described in the annotated example below or in each front matter’s documentation.\n​ toml yaml json +++ LastModifierDisplayName = '' LastModifierEmail = '' alwaysopen = '' collapsibleMenu = true customMathJaxURL = '' customMermaidURL = '' customOpenapiURL = '' description = '' disableBreadcrumb = false disableNextPrev = false disableToc = false editURL = '' externalLinkTarget = '_self' headingPost = '' headingPre = '' hidden = false highlightWrap = true images = ['images/hero.png'] linkTitle = '' math = false mathJaxInitialize = '{}' menuPageRef = '' menuPost = '' menuPre = '' menuUrl = '' mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidZoom = true ordersectionsby = 'weight' title = 'Example Page' type = '' [image] errorlevel = '' [imageEffects] border = true lazy = true lightbox = true shadow = false [include] errorlevel = '' [link] errorlevel = '' [mermaid] force = false [openapi] errorlevel = '' [oppenapi] force = false [[sidebarmenus]] disableTitle = true identifier = 'home' main = true pageRef = '' type = 'page' [[sidebarmenus]] disableTitle = false identifier = 'shortcuts' main = false type = 'menu' +++ --- LastModifierDisplayName: \"\" LastModifierEmail: \"\" alwaysopen: \"\" collapsibleMenu: true customMathJaxURL: \"\" customMermaidURL: \"\" customOpenapiURL: \"\" description: \"\" disableBreadcrumb: false disableNextPrev: false disableToc: false editURL: \"\" externalLinkTarget: _self headingPost: \"\" headingPre: \"\" hidden: false highlightWrap: true image: errorlevel: \"\" imageEffects: border: true lazy: true lightbox: true shadow: false images: - images/hero.png include: errorlevel: \"\" link: errorlevel: \"\" linkTitle: \"\" math: false mathJaxInitialize: '{}' menuPageRef: \"\" menuPost: \"\" menuPre: \"\" menuUrl: \"\" mermaid: force: false mermaidInitialize: '{ \"securityLevel\": \"loose\" }' mermaidZoom: true openapi: errorlevel: \"\" oppenapi: force: false ordersectionsby: weight sidebarmenus: - disableTitle: true identifier: home main: true pageRef: \"\" type: page - disableTitle: false identifier: shortcuts main: false type: menu title: Example Page type: \"\" --- { \"LastModifierDisplayName\": \"\", \"LastModifierEmail\": \"\", \"alwaysopen\": \"\", \"collapsibleMenu\": true, \"customMathJaxURL\": \"\", \"customMermaidURL\": \"\", \"customOpenapiURL\": \"\", \"description\": \"\", \"disableBreadcrumb\": false, \"disableNextPrev\": false, \"disableToc\": false, \"editURL\": \"\", \"externalLinkTarget\": \"_self\", \"headingPost\": \"\", \"headingPre\": \"\", \"hidden\": false, \"highlightWrap\": true, \"image\": { \"errorlevel\": \"\" }, \"imageEffects\": { \"border\": true, \"lazy\": true, \"lightbox\": true, \"shadow\": false }, \"images\": [ \"images/hero.png\" ], \"include\": { \"errorlevel\": \"\" }, \"link\": { \"errorlevel\": \"\" }, \"linkTitle\": \"\", \"math\": false, \"mathJaxInitialize\": \"{}\", \"menuPageRef\": \"\", \"menuPost\": \"\", \"menuPre\": \"\", \"menuUrl\": \"\", \"mermaid\": { \"force\": false }, \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\", \"mermaidZoom\": true, \"openapi\": { \"errorlevel\": \"\" }, \"oppenapi\": { \"force\": false }, \"ordersectionsby\": \"weight\", \"sidebarmenus\": [ { \"disableTitle\": true, \"identifier\": \"home\", \"main\": true, \"pageRef\": \"\", \"type\": \"page\" }, { \"disableTitle\": false, \"identifier\": \"shortcuts\", \"main\": false, \"type\": \"menu\" } ], \"title\": \"Example Page\", \"type\": \"\" } Annotated Front Matter ​ toml +++ # If an option value is said to be not set, you can achieve the same behavior # by giving it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes as well. # The social media image of your page. # Default: not set # This is used for generating social media meta information for the opengraph # protocol and twitter cards. # If not set, the set value of your site's hugo.toml is used. images = [ 'images/hero.png' ] # The title of your page. # Default: not set # A page without a title is treated as a hidden page. title = 'Example Page' # The description of your page. # Default: not set # This is used for generating HTML meta tags, social media meta information # for the opengraph protocol and twitter cards. # If not set, the set value of your site's hugo.toml is used for the html # meta tag, social media meta information for the opengraph protocol and # twitter cards. description = '' # The page design to be used # Default: not set # This decides the layout of your page. The theme ships 'home', 'chapter' and # 'default'. If not set, 'default' is taken. type = '' ############################################################################### # Relearn Theme # These options are specific to the Relearn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These options modify the topbar appearance. # Hide the table of contents button. # Default: false # If the TOC button is hidden, also the keyboard shortcut is disabled. # If not set, the set value of your site's hugo.toml is used. disableToc = false # Hide the breadcrumbs. # Default: false # If the breadcrumbs are hidden, the title of the displayed page will still be # shown in the topbar. disableBreadcrumb = false # Hide Next and Previous navigation buttons. # Default: false # If the navigation buttons are hidden, also the keyboard shortcuts are # disabled. disableNextPrev = false # The URL prefix to edit a page. # Default: not set # If set, an edit button will be shown in the topbar. If the button is hidden, # also the keyboard shortcuts are disabled. The value can contain the macro # `${FilePath}` which will be replaced by the file path of your displayed page. # If not set, the set value of your site's hugo.toml is used. If the global # parameter is given but you want to hide the button for the displayed page, # you can set the value to an empty string. If instead of hiding you want to have # an disabled button, you can set the value to a string containing just spaces. # This is useful if you want to give the opportunity for people to create merge # request for your content. editURL = '' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu appearance. # Menu specific title # Default: not set # The title displayed in the menu. If not set the `title` front matter will # be used. linkTitle = '' # Prefix for the title in navigation menu. # Default: not set # The title of the page in the menu will be prefixed by this HTML content. menuPre = '' # Suffix for the title in navigation menu. # Default: not set # The title of the page in the menu will be suffixed by this HTML content. menuPost = '' # Link the menu entry to a different internal page instead. # Default: not set # This will effectivly hide the page and its content from the viewer by # linking to the given URL instead. menuPageRef = '' # Link the menu entry to an external URL instead of a page. # Default: not set # This will effectivly hide the page and its content from the viewer by # linking to the given URL instead. menuUrl = '' # The order of navigation menu submenus. # Default: 'weight' # Submenus can be ordered by 'weight', 'title', 'linktitle', 'modifieddate', # 'expirydate', 'publishdate', 'date', 'length' or 'default' (adhering to # Hugo's default sort order). # If not set, the value of the parent menu entry is used. ordersectionsby = 'weight' # The initial expand state of submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # in the menu. If not set, the first menu level is set to false, all others # levels are set to true. If not set, the value of the parent menu entry is used. # If the displayed page has submenus, they will always been displayed expanded # regardless of this option. alwaysopen = '' # Shows expander for submenus. # Default: false # If set to true, a submenu in the sidebar will be displayed in a collapsible # tree view and a clickable expander is set in front of the entry. # If not set, the set value of your site's hugo.toml is used. collapsibleMenu = true # Define your own sidebar menus. # Default: the value used below # The sidebar menus are built from this parameter. If not set, the set value # of your site's hugo.toml is used and contains the below default. # Menus are written from the sidebar's top to buttom in the order given in # this array. # Each entry can contain the following keys: # - `type` is mandatory. Either `page` in case it should generate a tre from # the page structure or `menu` in case it should generate a tree from a # defined menu. # - `identifier` is mandatory. In case of `type=page`, anything can be used, # in case of `type=menu` the `identifier` key must be identical to the # key of the menu definition. # - `main`, boolean. If `true`, the first tree level is spaced more generous # and the text is emphasized. Default: `true` for `type=page` and `false` # for `type=menu` # - `disableTitle`, boolean. If `true`, there is no title above the tree. # Default: `true` for `type=page` and `false` for `type=menu`. If a title # should be used, in case of `type=page` it will be taken from the page's # `menuTitle` front matter and if not set, from the translation files, using # the menu `identifier` as key. In case of `type=menu` it will be taken # from the menu `title` according to Hugo's documentation and if not set # from the menu `name` and if this is not set form the page's `linkTitle`. # - `pageRef`, optional. In case of `type=page` this is the starting page's # path. If not set, the home page will be used. sidebarmenus = [ { type = 'page', identifier = 'home', main = true, disableTitle = true, pageRef = '' }, { type = 'menu', identifier = 'shortcuts', main = false, disableTitle = false }, ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden pages # These options configure how hidden pages are treated. # A page flagged as hidden, is only removed from the navigation menu if you are # currently not on this page or the hidden page is not part of current page's # ancestors. For all other functionality in Hugo a hidden page behaves like any # other page if not otherwise configured. # Hide a page's menu entry. # Default: false # If this value is true, the page is hidden from the menu. hidden = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Content # These options modify how your content is displayed. # Prefix for the title in the content area. # Default: not set # The title of the page heading will be prefixed by this HTML content. headingPre = '' # Suffix for the title in the content area. # Default: not set # The title of the page heading will be suffixed by this HTML content. headingPost = '' # Display name of the page's last editor. # Default: not set # If set, it will be displayed in the default footer. LastModifierDisplayName = '' # Email address of the page's last editor. # Default: not set # If set together with LastModifierDisplayName, it will be displayed in the # default footer. LastModifierEmail = '' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These options configure how code is displayed. # Wrap for code blocks. # Default: true # By default lines of code blocks wrap around if the line is too long to be # displayed on screen. If you dislike this behavior, you can reconfigure it # here. # Note that lines always wrap in print mode regardless of this option. # If not set, the set value of your site's hugo.toml is used or given as a # parameter to individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Include # These options configure how the include shortcode works. # What to do when path is not resolved. # Default: '' # You can control what should happen if a path can not be resolved to as # a resource or via the file system. If not set, no output will be written # for the unresolved path. If set to `warning` the same happens and an additional # warning is printed. If set to `error` an error message is printed and the build # is aborted. # If not set, the set value of your site's hugo.toml is used. include.errorlevel = '' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These options configure how images are displayed. # What to do when local image link is not resolved. # Default: '' # You can control what should happen if a local image can not be resolved to as # a resource. If not set, the unresolved link is written as given into the resulting # output. If set to `warning` the same happens and an additional warning is # printed. If set to `error` an error message is printed and the build is # aborted. # Please note that this can not resolve files inside of your `static` directory. # If not set, the set value of your site's hugo.toml is used. image.errorlevel = '' # Image effects. # See the documentation for how you can even add your own arbitrary effects to # the list. # All effect values default to the values of your site's hugo.toml and can be # overridden through URL parameter given to the image. See the documentation for # details. # Default: false imageEffects.border = true # Default: true imageEffects.lazy = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These options configure how links are displayed. # What to do when local page link is not resolved. # Default: '' # You can control what should happen if a local link can not be resolved to a # page. If not set, the unresolved link is written as given into the resulting # output. If set to `warning` the same happens and an additional warning is # printed. If set to `error` an error message is printed and the build is # aborted. # Please note that with Hugo \u003c 0.123.0 + `uglyURLs=true` this can lead to false # negatives. # If not set, the set value of your site's hugo.toml is used. link.errorlevel = '' # How to open external links. # Default: '_blank' # For external links you can define how they are opened in your browser. All # values for the HTML `target` attribute of the `a` element are allowed. The # default value opens external links in a separate browser tab. If you want # to open those links in the same tab, use '_self'. # If not set, the set value of your site's hugo.toml is used. externalLinkTarget = '_self' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These options configure how math formulae are displayed. # Initialization options for MathJax. # Default: not set # A JSON value. See the MathJaxdocumentation for possible parameter. # If not set, the set value of your site's hugo.toml is used. mathJaxInitialize = '{}' # Force load Math on every page. # Default: false # If a, Math shortcode or codefence is found, the option will be ignored and # Math will be loaded regardlessly. This option is useful in case you # are using passthrough configuration to render your math. In this case no shortcode or # codefence is involved and the library is not loaded by default so you can # force loading it by setting `math=true`. # This option has an alias `math.force`. # If not set, the set value of your site's hugo.toml is used. math = false # URL for external MathJax library. # Default: not set # Specifies the remote location of the MathJax library. By default the shipped # version will be used. # If not set, the set value of your site's hugo.toml is used. customMathJaxURL = '' # 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Mermaid # These options configure how Mermaid graphs are displayed. # Make graphs panable and zoomable # Default: false # For huge graphs it can be helpful to make them zoomable. Zoomable graphs come # with a reset button for the zoom. # If not set, the set value of your site's hugo.toml is used or given as a # parameter to individual graphs. mermaidZoom = true # Initialization options for Mermaid. # Default: not set # A JSON value. See the Mermaid documentation for possible parameter. # If not set, the set value of your site's hugo.toml is used. mermaidInitialize = '{ \"securityLevel\": \"loose\" }' # Force load Mermaid on every page. # Default: false # If a Mermaid shortcode or codefence is found, the option will be ignored and # Mermaid will be loaded regardlessly. This option is useful in case you # are using scripting to render your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default so you can # force loading it by setting `mermaid.force=true`. # If not set, the set value of your site's hugo.toml is used. mermaid.force = false # URL for external Mermaid library. # Default: not set # Specifies the remote location of the Mermaid library. By default the shipped # version will be used. # If not set, the set value of your site's hugo.toml is used. customMermaidURL = '' # 'https://unpkg.com/mermaid/dist/mermaid.min.js' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These options configure how OpenAPI specifications are displayed. # Load OpenAPI on every page. # Default: false # If a, OpenAPI shortcode or codefence is found, the option will be ignored and # OpenAPI will be loaded regardlessly. This option is useful in case you # are using scripting to render your spec. In this case no shortcode or # codefence is involved and the library is not loaded by default so you can # force loading it by setting `openapi.force=true`. # If not set, the set value of your site's hugo.toml is used. oppenapi.force = false # URL for external OpenAPI library. # Default: not set # Specifies the remote location of the OpenAPI library. By default the shipped # version will be used. # If not set, the set value of your site's hugo.toml is used. customOpenapiURL = '' # 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js' # What to do when a local OpenAPI spec link is not resolved. # Default: '' # You can control what should happen if a local OpenAPI spec link can not be resolved # to a resource. If not set, the unresolved link is written as given into the resulting # output. If set to `warning` the same happens and an additional warning is # printed. If set to `error` an error message is printed and the build is # aborted. # Please note that this can not resolve files inside of your `static` directory. # If not set, the set value of your site's hugo.toml is used. openapi.errorlevel = '' +++",
"description": "All front matter for the Relearn theme",
"tags": [],
"title": "Front Matter Reference",
"uri": "/hugo-theme-relearn/authoring/frontmatter/reference/index.html"
},
{
"breadcrumb": "Configuration",
"content": "This page explains how to configure the Relearn theme in your hugo.toml file.\nIn addition to Hugo’s standard options, the Relearn theme offers extra settings listed here.\nThroughout the documentation, theme-specific options are marked with a Option badge.\nAdd theme options to the params section of your hugo.toml. For example:\nhugo. toml yaml json [params] math = true params: math: true { \"params\": { \"math\": true } } Index A AdditionalContentLanguage (1) Alwaysopen (1) Author.email (1) Author.name (1) B BoxStyle (1) BreadcrumbSeparator (1) C CollapsibleMenu (1) CustomMathJaxURL (1) CustomMermaidURL (1) CustomOpenapiURL (1) D DisableAnchorCopy (1) DisableAnchorScrolling (1) DisableAssetsBusting (1) DisableBreadcrumb (1) DisableDefaultRelref (1) DisableExplicitIndexURLs (1) DisableGeneratorVersion (1) DisableHoverBlockCopyToClipBoard (1) DisableInlineCopyToClipBoard (1) DisableLandingPageButton (1) DisableLanguageSwitchingButton (1) DisableNextPrev (1) DisableRandomIds (1) DisableRootBreadcrumb (1) DisableSearch (1) DisableSearchHiddenPages (1) DisableSearchIndex (1) DisableSearchPage (1) DisableSeoHiddenPages (1) DisableShortcutsTitle (1) DisableTagHiddenPages (1) DisableTermBreadcrumbs (1) DisableToc (1) E EditURL (2) ExternalLinkTarget (1) H HighlightWrap (1) I Image.errorlevel (1) ImageEffects (1) Include.errorlevel (1) L LandingPageName (1) Link.errorlevel (1) LinkTitle (1) M Math (1) Math.force (1) MathJaxInitialize (1) Mermaid.force (1) MermaidInitialize (1) MermaidZoom (1) O Openapi.errorlevel (1) Openapi.force (1) Ordersectionsby (2) R Relearn.dependencies (1) S SearchIndexURL (1) SearchPageURL (1) ShowVisitedLinks (1) Sidebarmenus (1) T ThemeVariant (2) TitleSeparator (1) All Configuration Options Here’s a list of all available options with example values. Default values are described in the annotated example below in each option’s documentation.\nhugo. toml yaml json [params] additionalContentLanguage = ['en'] alwaysopen = '' breadcrumbSeparator = '\u003e' collapsibleMenu = true customMathJaxURL = '' customMermaidURL = '' customOpenapiURL = '' disableAnchorCopy = false disableAnchorScrolling = false disableAssetsBusting = false disableBreadcrumb = false disableDefaultRelref = false disableExplicitIndexURLs = false disableGeneratorVersion = false disableHoverBlockCopyToClipBoard = false disableInlineCopyToClipBoard = true disableLandingPageButton = true disableLanguageSwitchingButton = false disableNextPrev = false disableRandomIds = false disableRootBreadcrumb = true disableSearch = false disableSearchHiddenPages = false disableSearchIndex = false disableSearchPage = false disableSeoHiddenPages = true disableShortcutsTitle = false disableTagHiddenPages = false disableTermBreadcrumbs = false disableToc = false editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' externalLinkTarget = '_self' highlightWrap = true images = ['images/hero.png'] linkTitle = 'Relearn' math = false mathJaxInitialize = '{}' mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidZoom = true ordersectionsby = 'weight' searchIndexURL = 'searchindex.js' searchPageURL = 'search' showVisitedLinks = true titleSeparator = '::' [params.author] name = 'Sören Weber' [[params.boxStyle]] color = 'gold' i18n = '' icon = 'rainbow' identifier = 'magic' title = 'Magic' [params.image] errorlevel = 'error' [params.imageEffects] border = true lazy = true lightbox = true shadow = false [params.include] errorlevel = 'error' [params.link] errorlevel = 'error' [params.mermaid] force = false [params.openapi] errorlevel = 'error' [params.oppenapi] force = false [[params.sidebarmenus]] disableTitle = true identifier = 'home' main = true pageRef = '' type = 'page' [[params.sidebarmenus]] disableTitle = false identifier = 'shortcuts' main = false type = 'menu' [params.social] facebook_admin = '' twitter = '' [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] identifier = 'relearn-bright' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] auto = ['learn', 'neon'] identifier = 'retro-auto' name = 'Retro Learn/Neon' [[params.themeVariant]] identifier = 'neon' [[params.themeVariant]] identifier = 'learn' [[params.themeVariant]] identifier = 'blue' [[params.themeVariant]] identifier = 'green' [[params.themeVariant]] identifier = 'red' params: additionalContentLanguage: - en alwaysopen: \"\" author: name: Sören Weber boxStyle: - color: gold i18n: \"\" icon: rainbow identifier: magic title: Magic breadcrumbSeparator: '\u003e' collapsibleMenu: true customMathJaxURL: \"\" customMermaidURL: \"\" customOpenapiURL: \"\" disableAnchorCopy: false disableAnchorScrolling: false disableAssetsBusting: false disableBreadcrumb: false disableDefaultRelref: false disableExplicitIndexURLs: false disableGeneratorVersion: false disableHoverBlockCopyToClipBoard: false disableInlineCopyToClipBoard: true disableLandingPageButton: true disableLanguageSwitchingButton: false disableNextPrev: false disableRandomIds: false disableRootBreadcrumb: true disableSearch: false disableSearchHiddenPages: false disableSearchIndex: false disableSearchPage: false disableSeoHiddenPages: true disableShortcutsTitle: false disableTagHiddenPages: false disableTermBreadcrumbs: false disableToc: false editURL: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath} externalLinkTarget: _self highlightWrap: true image: errorlevel: error imageEffects: border: true lazy: true lightbox: true shadow: false images: - images/hero.png include: errorlevel: error link: errorlevel: error linkTitle: Relearn math: false mathJaxInitialize: '{}' mermaid: force: false mermaidInitialize: '{ \"securityLevel\": \"loose\" }' mermaidZoom: true openapi: errorlevel: error oppenapi: force: false ordersectionsby: weight searchIndexURL: searchindex.js searchPageURL: search showVisitedLinks: true sidebarmenus: - disableTitle: true identifier: home main: true pageRef: \"\" type: page - disableTitle: false identifier: shortcuts main: false type: menu social: facebook_admin: \"\" twitter: \"\" themeVariant: - auto: [] identifier: relearn-auto name: Relearn Light/Dark - identifier: relearn-light - identifier: relearn-dark - identifier: relearn-bright - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - auto: - learn - neon identifier: retro-auto name: Retro Learn/Neon - identifier: neon - identifier: learn - identifier: blue - identifier: green - identifier: red titleSeparator: '::' { \"params\": { \"additionalContentLanguage\": [ \"en\" ], \"alwaysopen\": \"\", \"author\": { \"name\": \"Sören Weber\" }, \"boxStyle\": [ { \"color\": \"gold\", \"i18n\": \"\", \"icon\": \"rainbow\", \"identifier\": \"magic\", \"title\": \"Magic\" } ], \"breadcrumbSeparator\": \"\\u003e\", \"collapsibleMenu\": true, \"customMathJaxURL\": \"\", \"customMermaidURL\": \"\", \"customOpenapiURL\": \"\", \"disableAnchorCopy\": false, \"disableAnchorScrolling\": false, \"disableAssetsBusting\": false, \"disableBreadcrumb\": false, \"disableDefaultRelref\": false, \"disableExplicitIndexURLs\": false, \"disableGeneratorVersion\": false, \"disableHoverBlockCopyToClipBoard\": false, \"disableInlineCopyToClipBoard\": true, \"disableLandingPageButton\": true, \"disableLanguageSwitchingButton\": false, \"disableNextPrev\": false, \"disableRandomIds\": false, \"disableRootBreadcrumb\": true, \"disableSearch\": false, \"disableSearchHiddenPages\": false, \"disableSearchIndex\": false, \"disableSearchPage\": false, \"disableSeoHiddenPages\": true, \"disableShortcutsTitle\": false, \"disableTagHiddenPages\": false, \"disableTermBreadcrumbs\": false, \"disableToc\": false, \"editURL\": \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\", \"externalLinkTarget\": \"_self\", \"highlightWrap\": true, \"image\": { \"errorlevel\": \"error\" }, \"imageEffects\": { \"border\": true, \"lazy\": true, \"lightbox\": true, \"shadow\": false }, \"images\": [ \"images/hero.png\" ], \"include\": { \"errorlevel\": \"error\" }, \"link\": { \"errorlevel\": \"error\" }, \"linkTitle\": \"Relearn\", \"math\": false, \"mathJaxInitialize\": \"{}\", \"mermaid\": { \"force\": false }, \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\", \"mermaidZoom\": true, \"openapi\": { \"errorlevel\": \"error\" }, \"oppenapi\": { \"force\": false }, \"ordersectionsby\": \"weight\", \"searchIndexURL\": \"searchindex.js\", \"searchPageURL\": \"search\", \"showVisitedLinks\": true, \"sidebarmenus\": [ { \"disableTitle\": true, \"identifier\": \"home\", \"main\": true, \"pageRef\": \"\", \"type\": \"page\" }, { \"disableTitle\": false, \"identifier\": \"shortcuts\", \"main\": false, \"type\": \"menu\" } ], \"social\": { \"facebook_admin\": \"\", \"twitter\": \"\" }, \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"identifier\": \"relearn-bright\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"auto\": [ \"learn\", \"neon\" ], \"identifier\": \"retro-auto\", \"name\": \"Retro Learn/Neon\" }, { \"identifier\": \"neon\" }, { \"identifier\": \"learn\" }, { \"identifier\": \"blue\" }, { \"identifier\": \"green\" }, { \"identifier\": \"red\" } ], \"titleSeparator\": \"::\" } } Annotated Configuration Options ​ hugo.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by giving it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes as well. # The title to be used for links to the main page # Default: not set # This name will be used for the link to the main page in the upper section # of the menu. If not set, `title` from the Hugo settings will be used. linkTitle = 'Relearn' # The author of your site. # Default: not set # This will be used in HTML meta tags, the opengraph protocol and twitter # cards. # You can also set `author.email` if you want to publish this information. author.name = 'Sören Weber' # The social media image of your site. # Default: not set # This is used for generating social media meta information for the opengraph # protocol and twitter cards. # This can be overridden in the page's frontmatter. images = [ 'images/hero.png' ] # Admin options for social media. # Default: not set # Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo's # implementation. See the Hugo docs for possible values. social.facebook_admin = '' social.twitter = '' ############################################################################### # Relearn Theme # These options are specific to the Relearn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Branding # These options set your overall visual appearance. # Used color variants. # Default: 'auto' # This sets one or more color variants, available to your readers to choose # from. You can # - set a single value eg. 'zen-light' # - an array like [ 'neon', 'learn' ] # - an array with options like [ { identifier = 'neon' },{ identifier = 'learn' } ] # The last form allows to set further options for each variant. # The `identifier` is mandatory. You can also set `name` which overrides the # value displayed in the variant selector. # If the array has more than one entry, a variant selector # is shown in the lower part of the menu. The first entry in the array is the # default variant, used for first time visitors. # The theme ships with the following variants: 'relearn-bright', # 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn', # 'blue', 'green', 'red'. In addition you can use auto mode variants. See the # docs for a detailed explanation. # You can also define your own variants. See the docs how this works. Also, # the docs provide an interactive theme generator to help you with this task. themeVariant = [ { identifier = 'relearn-auto', name = 'Relearn Light/Dark', auto = [] }, { identifier = 'relearn-light' }, { identifier = 'relearn-dark' }, { identifier = 'relearn-bright' }, { identifier = 'zen-auto', name = 'Zen Light/Dark', auto = [ 'zen-light', 'zen-dark' ] }, { identifier = 'zen-light' }, { identifier = 'zen-dark' }, { identifier = 'retro-auto', name = 'Retro Learn/Neon', auto = [ 'learn', 'neon' ] }, { identifier = 'neon' }, { identifier = 'learn' }, { identifier = 'blue' }, { identifier = 'green' }, { identifier = 'red' } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These options are defining general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files and CSS-files get a unique ID on each rebuild. # This makes sure, the user always has the latest version and not some stale # copy of his browser cache. Anyways, it can be desireable to turn this # off in certain circumstances. For example if you have Hugo's dev server # running. Also some proxies dislike this optimization. disableAssetsBusting = false # Avoid generator meta tags. # Default: false # Set this to true if you want to disable generation for generator meta tags # of Hugo and the theme in your HTML head. In this case also don't forget to # set Hugo's disableHugoGeneratorInject=true. Otherwise Hugo will generate a # meta tag into your home page anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situations the theme generates non stable unique ids to be used # in HTML fragment links. This can be undesirable for example when testing # the output for changes. If you disable the random id generation, the theme # may not function correctly anymore. disableRandomIds = false # Additional code dependencies. # Default: See hugo.toml of the theme # The theme provides a mechanism to load further JavaScript and CSS # dependencies on demand only if they are needed. This comes in handy if you # want to add own shortcodes that depend on additional code to be loaded. # See the docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These options modify the topbar appearance. # Hide the table of contents button. # Default: false # If the TOC button is hidden, also the keyboard shortcut is disabled. # This can be overridden in the page's frontmatter. disableToc = false # Hide the breadcrumbs. # Default: false # If the breadcrumbs are hidden, the title of the displayed page will still be # shown in the topbar. disableBreadcrumb = false # Hide Next and Previous navigation buttons. # Default: false # If the navigation buttons are hidden, also the keyboard shortcuts are # disabled. disableNextPrev = false # The URL prefix to edit a page. # Default: not set # If set, an edit button will be shown in the topbar. If the button is hidden, # also the keyboard shortcuts are disabled. The value can contain the macro # `${FilePath}` which will be replaced by the file path of your displayed page. # If no `${FilePath}` is given in the value, the value is treated as if the # `${FilePath}` was appended at the end of the value. This can be overridden # in the pages frontmatter. This is useful if you want to give the opportunity # for people to create merge request for your content. editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Search # These options modify various aspects of the search functionality. # Disable the search. # Default: false # If the search is disabled, no search box will be displayed in the menu, # nor in-page search, search popup or dedicated search page will be available. # This will also cause the keyboard shortcut to be disabled. disableSearch = false # Disable the search index generation. # Default: false # `disableSearch=false` must be set to let the generation of the search index # file to be affected by this option. If the search index is disabled, no # search popup or dedicated search page will be available. disableSearchIndex = false # URL of the search index file relative to the language home. # Default: 'searchindex.js' # You have to set this option if your page already has a content file named # `searchindex.js` in the language home. searchIndexURL = 'searchindex.js' # Disable the dedicated search page. # Default: false # `disableSearch=false` and `disableSearchIndex=false` must be set to let the # generation of the dedicated search page to be affected by this option. disableSearchPage = false # URL of the dedicated search page relative to the language home. # Default: 'search' # In its basic form the search page URL is named the same for all languages # but you are free to override it in each language options to localised the # URL. You also need to set this option if your page already has a content # page named `search`. searchPageURL = 'search' # Multilanguage content. # Default: not set # If the search index is enabled and your pages contain further languages # besides the main one used, add all those auxiliary languages here. This # will create a search index with support for all used languages of your site. # This is handy for example if you are writing in Spanish but have lots of # source code on your page which typically uses English terminology. additionalContentLanguage = [ 'en' ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu appearance. # Hide the Home entry. # Default: false # If shown, a Home button will appear below the search bar and the main menu. # It links to your the home page of the current language. disableLandingPageButton = true # Hide the language switcher. # Default: false # If you have more than one language configured, a language switcher is # displayed in the lower part of the menu. This option lets you explicitly # turn this behavior off. disableLanguageSwitchingButton = false # Shows checkmarks for visited pages of the main menu. # Default: false # This also causes the display of the `Clear History` entry in the lower part # of the menu to remove all checkmarks. The checkmarks will also been removed # if you regenerate your site as the ids are not stable. showVisitedLinks = true # The order of main menu submenus. # Default: 'weight' # Submenus can be ordered by 'weight', 'title', 'linktitle', 'modifieddate', # 'expirydate', 'publishdate', 'date', 'length' or 'default' (adhering to # Hugo's default sort order). This can be overridden in the pages frontmatter. ordersectionsby = 'weight' # The initial expand state of submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # in the menu. If not set, the first menu level is set to false, all others # levels are set to true. This can be overridden in the page's frontmatter. # If the displayed page has submenus, they will always been displayed expanded # regardless of this option. alwaysopen = '' # Shows expander for submenus. # Default: false # If set to true, a submenu in the sidebar will be displayed in a collapsible # tree view and a clickable expander is set in front of the entry. # This can be overridden in the page's frontmatter. collapsibleMenu = true # Hide heading above the shortcuts menu. # Default: false # If a sidebar menu with identifier `shortcuts` is configured (see below), # this is the easy way to remove the heading; # The title for the heading can be overwritten in your i18n files. See Hugo's # documentation how to do this. disableShortcutsTitle = false # Define your own sidebar menus. # Default: the value used below # The sidebar menus are built from this parameter. If not set, it contains # the below default. # Menus are written from the sidebar's top to buttom in the order given in # this array. # This can be overridden in the page's frontmatter. # Each entry can contain the following keys: # - `type` is mandatory. Either `page` in case it should generate a tre from # the page structure or `menu` in case it should generate a tree from a # defined menu. # - `identifier` is mandatory. In case of `type=page`, anything can be used, # in case of `type=menu` the `identifier` key must be identical to the # key of the menu definition. # - `main`, boolean. If `true`, the first tree level is spaced more generous # and the text is emphasized. Default: `true` for `type=page` and `false` # for `type=menu` # - `disableTitle`, boolean. If `true`, there is no title above the tree. # Default: `true` for `type=page` and `false` for `type=menu`. If a title # should be used, in case of `type=page` it will be taken from the page's # `menuTitle` front matter and if not set, from the translation files, using # the menu `identifier` as key. In case of `type=menu` it will be taken # from the menu `title` according to Hugo's documentation and if not set # from the menu `name` and if this is not set form the page's `linkTitle`. # - `pageRef`, optional. In case of `type=page` this is the starting page's # path. If not set, the home page will be used. sidebarmenus = [ { type = 'page', identifier = 'home', main = true, disableTitle = true, pageRef = '' }, { type = 'menu', identifier = 'shortcuts', main = false, disableTitle = false }, ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden pages # These options configure how hidden pages are treated. # A page flagged as hidden, is only removed from the main menu if you are # currently not on this page or the hidden page is not part of current page's # ancestors. For all other functionality in Hugo a hidden page behaves like any # other page if not otherwise configured. # Hide hidden pages from search. # Default: false # Hides hidden pages from the suggestions of the search box and the dedicated # search page. disableSearchHiddenPages = false # Hide hidden pages for web crawlers. # Default: false # Avoids hidden pages from showing up in the sitemap and on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden pages for taxonomies. # Default: false # Hides hidden pages from showing up on the taxonomy and terms pages. If this # reduces term counters to zero, an empty but not linked term page will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Content # These options modify how your content is displayed. # Title separator. # Default: '::' # Changes the title separator used when concatenating the page title with the # site title. This is consistently used throughout the theme. titleSeparator = '::' # Breadcrumb separator. # Default: '\u003e' # Changes the breadcrumb separator used in the topbars breadcrumb area and for # search results and term pages. breadcrumbSeparator = '\u003e' # Hide the root breadcrumb. # Default: false # The root breadcrumb is usually the home page of your site. Because this is # always accessible by clicking on the logo, you may want to reduce clutter # by removing this from your breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term pages. # Default: false # If you have lots of taxonomy terms, the term pages may seem cluttered with # breadcrumbs to you, so this is the option to turn off breadcrumbs on term # pages. Only the page title will then be shown on the term pages. disableTermBreadcrumbs = false # Disable copying heading links to clipboard # Default: false # If set to true, this disables the copying of anchor links to the clipboard; # if also `disableAnchorScrolling=true` then no anchor link will be visible # when hovering a heading. disableAnchorCopy = false # Disable scrolling to heading link on click # Default: false # If set to true, this disables the scrolling to the beginning of the heading # when clicked; if also `disableAnchorCopy=true` then no anchor link will # be visible when hovering a heading. disableAnchorScrolling = false # User-defined styles for shortcodes # Default: not set # Besides the predefined `style` values, you are able to define your own. The # `style` parameter of the shortcode must match the `identifier` defined here. # The title for the style will be determined from the `title`. If no `title` # but a `i18n` is set, the title will be taken from the translation files by # that key. The `title` may be empty in which case, the box does not contain a # default title. `icon` and `color` are working similar. boxStyle = [ { identifier = 'magic', i18n = '', title = 'Magic', icon = 'rainbow', color = 'gold' } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These options configure how code is displayed. # Hide copy-to-clipboard for inline code. # Default: false # This removes the copy-to-clipboard button from your inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard for block code. # Default: false # The theme only shows the copy-to-clipboard button if you hover over the code # block. Set this to true to disable the hover effect and always show the # button. disableHoverBlockCopyToClipBoard = false # Wrap for code blocks. # Default: true # By default lines of code blocks wrap around if the line is too long to be # displayed on screen. If you dislike this behavior, you can reconfigure it # here. # Note that lines always wrap in print mode regardless of this option. # This can be overridden in the page's frontmatter or given as a parameter to # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Include # These options configure how the include shortcode works. # What to do when path is not resolved. # Default: '' # You can control what should happen if a path can not be resolved to as # a resource or via the file system. If not set, no output will be written # for the unresolved path. If set to `warning` the same happens and an additional # warning is printed. If set to `error` an error message is printed and the build # is aborted. # This can be overridden in the page's frontmatter. include.errorlevel = 'error' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These options configure how images are displayed. # What to do when local image link is not resolved. # Default: '' # You can control what should happen if a local image can not be resolved to as # a resource. If not set, the unresolved link is written as given into the resulting # output. If set to `warning` the same happens and an additional warning is # printed. If set to `error` an error message is printed and the build is # aborted. # Please note that this can not resolve files inside of your `static` directory. # This can be overridden in the page's frontmatter. image.errorlevel = 'error' # Image effects. # See the documentation for how you can even add your own arbitrary effects to # the list. # All effects can be overridden in the page's frontmatter or through URL parameter # given to the image. See the documentation for details. # Default: false imageEffects.border = true # Default: true imageEffects.lazy = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These options configure how links are displayed. # Wether to use Hugo's default relref shortcode implementation # Default: false # Since the theme provides a link render hook, the usage of the relref shortcode # is obsolete. If a site still uses that shortcode, it fails to generate a # correct links if the baseURL is configured with a subdirectory and relativeURLs=false. # The theme provides an overriden relref shortcode that also works in the # above setup but must manually be activated by setting this option to true. # See discussion in https://github.com/McShelby/hugo-theme-relearn/discussions/862 disableDefaultRelref = false # Generate link URLs the Hugo way. # Default: false # If set to true, the theme behaves like a standard Hugo installation and # appends no index.html to prettyURLs. As a trade off, your build project will # not be servable from the file system. disableExplicitIndexURLs = false # What to do when local page link is not resolved. # Default: '' # You can control what should happen if a local link can not be resolved to a # page. If not set, the unresolved link is written as given into the resulting # output. If set to `warning` the same happens and an additional warning is # printed. If set to `error` an error message is printed and the build is # aborted. # Please note that with Hugo \u003c 0.123.0 + `uglyURLs=true` this can lead to false # negatives. # This can be overridden in the page's frontmatter. link.errorlevel = 'error' # How to open external links. # Default: '_blank' # For external links you can define how they are opened in your browser. All # values for the HTML `target` attribute of the `a` element are allowed. The # default value opens external links in a separate browser tab. If you want # to open those links in the same tab, use '_self'. # This can be overridden in the page's frontmatter. externalLinkTarget = '_self' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These options configure how math formulae are displayed. # Initialization options for MathJax. # Default: not set # A JSON value. See the MathJaxdocumentation for possible parameter. # This can be overridden in the page's frontmatter. mathJaxInitialize = '{}' # Force load Math on every page. # Default: false # If a, Math shortcode or codefence is found, the option will be ignored and # Math will be loaded regardlessly. This option is useful in case you # are using passthrough configuration to render your math. In this case no shortcode or # codefence is involved and the library is not loaded by default so you can # force loading it by setting `math=true`. # This option has an alias `math.force`. # This can be overridden in the page's frontmatter. math = false # URL for external MathJax library. # Default: not set # Specifies the remote location of the MathJax library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customMathJaxURL = '' # 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Mermaid # These options configure how Mermaid graphs are displayed. # Make graphs panable and zoomable # Default: false # For huge graphs it can be helpful to make them zoomable. Zoomable graphs come # with a reset button for the zoom. # This can be overridden in the page's frontmatter or given as a parameter to # individual graphs. mermaidZoom = true # Initialization options for Mermaid. # Default: not set # A JSON value. See the Mermaid documentation for possible parameter. # This can be overridden in the page's frontmatter. mermaidInitialize = '{ \"securityLevel\": \"loose\" }' # Force load Mermaid on every page. # Default: false # If a Mermaid shortcode or codefence is found, the option will be ignored and # Mermaid will be loaded regardlessly. This option is useful in case you # are using scripting to render your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default so you can # force loading it by setting `mermaid.force=true`. # This can be overridden in the page's frontmatter. mermaid.force = false # URL for external Mermaid library. # Default: not set # Specifies the remote location of the Mermaid library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customMermaidURL = '' # 'https://unpkg.com/mermaid/dist/mermaid.min.js' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These options configure how OpenAPI specifications are displayed. # Force load OpenAPI on every page. # Default: false # If a, OpenAPI shortcode or codefence is found, the option will be ignored and # OpenAPI will be loaded regardlessly. This option is useful in case you # are using scripting to render your spec. In this case no shortcode or # codefence is involved and the library is not loaded by default so you can # force loading it by setting `openapi.force=true`. # This can be overridden in the page's frontmatter. oppenapi.force = false # URL for external OpenAPI library. # Default: not set # Specifies the remote location of the OpenAPI library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customOpenapiURL = '' # 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js' # What to do when a local OpenAPI spec link is not resolved. # Default: '' # You can control what should happen if a local OpenAPI spec link can not be resolved # to a resource. If not set, the unresolved link is written as given into the resulting # output. If set to `warning` the same happens and an additional warning is # printed. If set to `error` an error message is printed and the build is # aborted. # Please note that this can not resolve files inside of your `static` directory. # This can be overridden in the page's frontmatter. openapi.errorlevel = 'error'",
"description": "All configuration options for the Relearn theme",
"tags": [],
"title": "Options Reference",
"uri": "/hugo-theme-relearn/configuration/reference/index.html"
},
{
"breadcrumb": "Configuration \u003e Customization",
"content": "In addition to the output formats coming with the theme, you can create your own output formats.\nStarting from Scratch If you want to add a new output format called myformat that outputs HTML and you want to build everything yourself without using the theme’s components:\nCreate a file layouts/_default/baseof.myformat.html Implement all the necessary code in this file Using the Theme’s Structure If you want to keep the general framework and only change specific parts, you can override these files:\nlayouts/_default/views/article.html: Controls how a page’s content and title are displayed layouts/_default/views/body.html: Determines the page body structure layouts/_default/views/menu.html: Defines the sidebar menu layout layouts/_default/views/storeOutputFormat.html: Stores the output format name for use in the framework For a real-world example, check out the print output format implementations\nlayouts/_default/views/body.print.html layouts/_default/views/menu.print.html layouts/_default/views/storeOutputFormat.print.html",
"description": "Adding Custom Output Formats",
"tags": [],
"title": "Output Formats",
"uri": "/hugo-theme-relearn/configuration/customization/outputformats/index.html"
},
{
"breadcrumb": "Configuration \u003e Site Management",
"content": "Disabling the Generator Meta Option The theme adds a meta tag with its version number to each page.\nThis isn’t a security risk and helps us support you better.\nTo turn this off, set disableGeneratorVersion=true.\nhugo. toml yaml json [params] disableGeneratorVersion = true params: disableGeneratorVersion: true { \"params\": { \"disableGeneratorVersion\": true } } If you also want to turn off Hugo’s version meta tag, use disableHugoGeneratorInject=true.\nDisabling IDs for Referenced Assets Option The theme creates a unique ID for each build and adds it to each referenced asset’s URL to make browsers not keep outdated cached assets.\nThis is good for production sites but can be problematic during development. It makes comparing outputs difficult as each build has new IDs.\nTo disable this, set disableAssetsBusting=true.\nhugo. toml yaml json [params] disableAssetsBusting = true params: disableAssetsBusting: true { \"params\": { \"disableAssetsBusting\": true } } Disabling IDs for Interactive HTML Elements Option Features like expanders, callouts, and tabs use unique IDs to work. These IDs change with each build.\nThis is necessary for the theme to work properly, but it can make comparing outputs between builds difficult.\nTo turn this off, set disableRandomIds=true. Note, that this will result in a non-functional site!.\nhugo. toml yaml json [params] disableRandomIds = true params: disableRandomIds: true { \"params\": { \"disableRandomIds\": true } }",
"description": "How to make your generated HTML output stable",
"tags": [],
"title": "Stable Output",
"uri": "/hugo-theme-relearn/configuration/sitemanagement/stableoutput/index.html"
},
{
"breadcrumb": "Configuration \u003e Customization",
"content": "This page explains how to show custom taxonomies on your pages.\nFor more details, check the official docs on setting up custom taxonomies and using them in your content.\nDefault Behavior The Relearn theme automatically shows Hugo’s default taxonomies tags and categories out of the box.\nTags appear at the top of the page in alphabetical order in form of baggage tags. Categories appear at the bottom of the page in alphabetical order as a list prefixed with an icon. Each item links to a page showing all articles with that term.\nSetting Up Custom Taxonomies To add custom taxonomies, update your hugo.toml file. You also have to add the default taxonomies if you want to use them.\nhugo. toml yaml json [taxonomies] category = 'categories' mycustomtag = 'mycustomtags' tag = 'tags' taxonomies: category: categories mycustomtag: mycustomtags tag: tags { \"taxonomies\": { \"category\": \"categories\", \"mycustomtag\": \"mycustomtags\", \"tag\": \"tags\" } } Showing Custom Taxonomies To display your custom taxonomy terms, add this to your page (usually in layouts/partials/content-footer.html):\n{{ partial \"term-list.html\" (dict \"page\" . \"taxonomy\" \"mycustomtags\" \"icon\" \"layer-group\" ) }} Parameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. taxonomy \u003cempty\u003e The plural name of the taxonomy to display as used in your front matter. class \u003cempty\u003e Additional CSS classes set on the outermost generated HTML element.\nIf set to tags you will get the visuals for displaying the tags taxonomy, otherwise it will be a simple list of links as for the categories taxonomy. style primary The style scheme used if class is tags.\n- by severity: caution, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used if class is tags. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color icon \u003cempty\u003e An optional Font Awesome icon name set to the left of the list.",
"description": "How to display custom taxonomies on your pages",
"tags": [
"Taxonomy"
],
"title": "Taxonomies",
"uri": "/hugo-theme-relearn/configuration/customization/taxonomy/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children",
"content": "This is a demo child page.\nSubpages of this page page 1-1",
"description": "This is a demo child page",
"tags": [
"Children",
"Non-Hidden"
],
"title": "page 1",
"uri": "/hugo-theme-relearn/shortcodes/children/children-1/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children",
"content": "This is a demo child page with no description.\nSo its content is used as description.",
"description": "This is a demo child page with no description.\nSo its content is used as description.",
"tags": [
"Children",
"Non-Hidden"
],
"title": "page 2",
"uri": "/hugo-theme-relearn/shortcodes/children/children-2/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children",
"content": "This is a demo child page.\nSubpages of this page page 3-1",
"description": "This is a demo child page",
"tags": [
"Children",
"Non-Hidden"
],
"title": "page 3",
"uri": "/hugo-theme-relearn/shortcodes/children/children-3/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children",
"content": "This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.",
"description": "This is a hidden demo child page",
"tags": [
"Children",
"a secret"
],
"title": "page 4 (hidden)",
"uri": "/hugo-theme-relearn/shortcodes/children/children-4/index.html"
},
{
"breadcrumb": "Tags",
"content": "This lists all pages that are hidden from the home page. This includes pages that define hidden=true in their front matter as well as descendents of hidden pages.\nWhen giving term pages, you should give it a title. Otherwise it will print out a warning and will use the urlized title, which may looks weird.\nWhile internally this term is called hidden, it is referenced in the resulting english pages as a secret and as hush, matey in the piratish translation.\nJust an example heading The TOC will contain this heading and the index headings below.",
"description": "This lists all pages that are hidden from the home page. This includes pages that define hidden=true in their front matter as well as descendents of hidden pages.",
"tags": [],
"title": "Tag :: a secret",
"uri": "/hugo-theme-relearn/tags/the-hidden/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: AdditionalContentLanguage",
"uri": "/hugo-theme-relearn/options/additionalcontentlanguage/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Alwaysopen",
"uri": "/hugo-theme-relearn/options/alwaysopen/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Alwaysopen",
"uri": "/hugo-theme-relearn/frontmatter/alwaysopen/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "Warning This shortcode is deprecated in favor of the new resources shortcode. See migration instructions below.\nThe examples on this page were removed.\nThe attachments shortcode displays a list of files attached to a page with adjustable color, title and icon.\nMigration While this shortcode will still be available for some time, it does not receive support anymore. Start to migrate early, as it will be removed with the next major update of the theme.\nThe resources shortcode leverages Hugo’s resource feature for page bundles. It has all the same parameter as the attachments shortcode but applies the pattern directly on a resources Name attribute.\nTo migrate your pages apply the following steps:\nIf a page is not already a page bundle convert it Move your files to a valid destination inside of your page bundle (depending if you have a branch or a leaf bundle) Change the calls from the attachments shortcode to the resources shortcode and adjust the pattern parameter to the new directory layout and the resources Name attribute. Multilanguage features are not supported directly by the shortcode anymore but rely on Hugo’s handling for resource translations.\nUsage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% attachments sort=\"asc\" /%}} {{ partial \"shortcodes/attachments.html\" (dict \"page\" . \"sort\" \"asc\" )}} Parameter Name Default Notes style transparent The style scheme used for the box.\n- by severity: caution, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYou can also define your own styles. color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: Attachments\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: paperclip\nIf you want no icon, you have to set this parameter to \" \" (a non empty d with spaces) sort asc Sorting the output in ascending or descending order. pattern .* A regular expressions, used to filter the attachments by file name. For example:\n- to match a file suffix of ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- to match file names ending in jpg or png, use .*\\.(jpg|png) Setup Single language The shortcode lists files found in a specific directory. The name of the directory depends on your page type (either branch bundle, leaf bundle or page).\nIf your page is a leaf bundle, attachments must be placed in a nested index.files directory, accordingly.\ncontent _index.md page index.md index.files attachment.pdf If your page is a branch bundle, attachments must be placed in a nested _index.files directory, accordingly.\nWarning This is only available for Hugo \u003c 0.112.0\ncontent _index.md page _index.md _index.files attachment.pdf For simple pages, attachments must be placed in a directory named like your page and ending with .files.\nWarning This is only available for Hugo \u003c 0.112.0\ncontent _index.md page.files attachment.pdf page.md Multilingual Be aware that if you use a multilingual website, you will need to have as many directories as languages and the language code must be part of the directory name.\nEg. for a site in English and Piratish:\ncontent index.en.md index.pir.md page index.en.md index.pir.md index.en.files attachment.pdf index.pir.files attachment.pdf",
"description": "List of files attached to a page",
"tags": [],
"title": "Attachments",
"uri": "/hugo-theme-relearn/shortcodes/attachments/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Author.email",
"uri": "/hugo-theme-relearn/options/author.email/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Author.name",
"uri": "/hugo-theme-relearn/options/author.name/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The badge shortcode displays little markers in your text with adjustable color, title and icon.\nImportant Version6.6.6 Captain InfoNew Awesome\nUsage ​ shortcode partial {{% badge %}}Important{{% /badge %}} {{% badge style=\"primary\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"red\" icon=\"angle-double-up\" %}}Captain{{% /badge %}} {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" %}}Awesome{{% /badge %}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"content\" \"Important\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"Version\" \"content\" \"6.6.6\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"red\" \"icon\" \"angle-double-up\" \"content\" \"Captain\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"info\" \"content\" \"New\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"color\" \"fuchsia\" \"icon\" \"fab fa-hackerrank\" \"content\" \"Awesome\" )}} Parameter Name Default Notes style default The style scheme used for the badge.\n- by severity: caution, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYou can also define your own styles. color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary text for the badge title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text for the badge. Examples Style By Severity {{% badge style=\"caution\" %}}Magenta{{% /badge %}} {{% badge style=\"important\" %}}Cyan{{% /badge %}} {{% badge style=\"info\" %}}Blue{{% /badge %}} {{% badge style=\"note\" %}}Orange{{% /badge %}} {{% badge style=\"tip\" %}}Green{{% /badge %}} {{% badge style=\"warning\" %}}Red{{% /badge %}} CautionMagenta ImportantCyan InfoBlue NoteOrange TipGreen WarningRed\nBy Brand Colors {{% badge style=\"primary\" icon=\"bullhorn\" title=\"Announcement\" %}}Mandatory{{% /badge %}} {{% badge style=\"secondary\" icon=\"bullhorn\" title=\"Announcement\" %}}Optional{{% /badge %}} {{% badge style=\"accent\" icon=\"bullhorn\" title=\"Announcement\" %}}Special{{% /badge %}} AnnouncementMandatory AnnouncementOptional AnnouncementSpecial\nBy Color {{% badge style=\"blue\" icon=\"palette\" title=\"Color\" %}}Blue{{% /badge %}} {{% badge style=\"cyan\" icon=\"palette\" title=\"Color\" %}}Cyan{{% /badge %}} {{% badge style=\"green\" icon=\"palette\" title=\"Color\" %}}Green{{% /badge %}} {{% badge style=\"grey\" icon=\"palette\" title=\"Color\" %}}Grey{{% /badge %}} {{% badge style=\"magenta\" icon=\"palette\" title=\"Color\" %}}Magenta{{% /badge %}} {{% badge style=\"orange\" icon=\"palette\" title=\"Color\" %}}Orange{{% /badge %}} {{% badge style=\"red\" icon=\"palette\" title=\"Color\" %}}Red{{% /badge %}} ColorBlue ColorCyan ColorGreen ColorGrey ColorMagenta ColorOrange ColorRed\nBy Special Color {{% badge style=\"default\" icon=\"palette\" title=\"Color\" %}}Default{{% /badge %}} {{% badge style=\"transparent\" icon=\"palette\" title=\"Color\" %}}Transparent{{% /badge %}} ColorDefault ColorTransparent\nVariants Without Icon and Title Text {{% badge %}}6.6.6{{% /badge %}} {{% badge style=\"info\" icon=\" \" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" %}}Captain{{% /badge %}} 6.6.6 Awesome Captain\nWithout Icon {{% badge title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" icon=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 InfoAwesome RankCaptain\nWithout Title Text {{% badge icon=\"star\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" icon=\"angle-double-up\" %}}Captain{{% /badge %}} 6.6.6 Awesome Captain\nAll Set {{% badge icon=\"star\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" %}}Awesome{{% /badge %}} {{% badge style=\"red\" icon=\"angle-double-up\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 InfoAwesome RankCaptain\nOverride for Severity {{% badge style=\"info\" icon=\"rocket\" title=\"Feature\" %}}Awesome{{% /badge %}} FeatureAwesome Other With User-Defined Color, Font Awesome Brand Icon and Markdown Title and Content {{% badge color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" title=\"**Font**\" %}}**Awesome**{{% /badge %}} FontAwesome With Icon Content You can combine the badge with the icon shortcode to create even more stunning visuals.\nIn this case you need to declare {{\u003c badge \u003e}} instead of {{% badge %}}. Note, that in this case it is not possible to put markdown in the content.\n{{\u003c badge style=\"primary\" icon=\"angle-double-up\" \u003e}}{{% icon skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" icon=\"angle-double-up\" \u003e}}{{% icon skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" icon=\"angle-double-up\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" icon=\"angle-double-up\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}} Pirate{{\u003c /badge \u003e}} Pirate\nRank\nRank Pirate\nRank\nRank Pirate\nInside of Text Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. {{% badge style=\"blue\" icon=\"rocket\" %}}Awesome{{% /badge %}} Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Awesome Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.",
"description": "Marker badges to display in your text",
"tags": [],
"title": "Badge",
"uri": "/hugo-theme-relearn/shortcodes/badge/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: BoxStyle",
"uri": "/hugo-theme-relearn/options/boxstyle/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: BreadcrumbSeparator",
"uri": "/hugo-theme-relearn/options/breadcrumbseparator/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The button shortcode displays a clickable button with adjustable color, title and icon.\nGet Hugo Get Hugo\nUsage ​ shortcode partial {{% button href=\"https://gohugo.io/\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" icon=\"dragon\" %}}Get Hugo{{% /button %}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Parameter Name Default Notes href \u003cempty\u003e Either the destination URL for the button or JavaScript code to be executed on click. If this parameter is not set, the button will do nothing but is still displayed as clickable.\n- if starting with javascript: all following text will be executed in your browser\n- every other string will be interpreted as URL style transparent The style scheme used for the button.\n- by severity: caution, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYou can also define your own styles. color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) iconposition left Places the icon to the left or right of the title. target see notes The destination frame/window if href is an URL. Otherwise the parameter is not used. This behaves similar to normal links. If the parameter is not given it defaults to:\n- the setting of externalLinkTarget or _blank if not set, for any address starting with http:// or https://\n- no specific value for all other links type see notes The button type if href is JavaScript. Otherwise the parameter is not used. If the parameter is not given it defaults to button \u003ccontent\u003e see notes Arbitrary text for the button title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"caution\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"important\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Hugo{{% /button %}} Get Hugo Get Hugo Get Hugo Get Hugo Get Hugo Get Hugo\nBy Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Hugo{{% /button %}} Get Hugo Get Hugo Get Hugo\nBy Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"cyan\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"magenta\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Hugo{{% /button %}} Get Hugo Get Hugo Get Hugo Get Hugo Get Hugo Get Hugo Get Hugo\nBy Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Hugo{{% /button %}} Get Hugo Get Hugo\nIcon Empty {{% button href=\"https://gohugo.io/\" icon=\" \" %}}{{% /button %}} Only {{% button href=\"https://gohugo.io/\" icon=\"download\" %}}{{% /button %}} To the Left {{% button href=\"https://gohugo.io/\" icon=\"download\" %}}Get Hugo{{% /button %}} Get Hugo To the Right {{% button href=\"https://gohugo.io/\" icon=\"download\" iconposition=\"right\" %}}Get Hugo{{% /button %}} Get Hugo Override for Severity {{% button href=\"https://gohugo.io/\" icon=\"dragon\" style=\"warning\" %}}Get Hugo{{% /button %}} Get Hugo Target {{% button href=\"https://gohugo.io/\" target=\"_self\" %}}Get Hugo in same window{{% /button %}} {{% button href=\"https://gohugo.io/\" %}}Get Hugo in new Window/Frame (default){{% /button %}} Get Hugo in same Window/Frame Get Hugo in new Window/Frame (default)\nOther With User-Defined Color, Font Awesome Brand Icon and Markdown Title {{% button href=\"https://gohugo.io/\" color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" %}}Get **Hugo**{{% /button %}} Get Hugo Severity Style with All Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Tip Button to Internal Page {{% button href=\"/index.html\" %}}Home{{% /button %}} Home Button with JavaScript Action If your JavaScript action does not change the focus afterwards, make sure to call this.blur() in the end to unselect the button.\n{{% button style=\"primary\" icon=\"bullhorn\" href=\"javascript:alert('Hello world!');this.blur();\" %}}Shout it out{{% /button %}} Shout it out Button within a form Element To use native HTML elements in your Markdown, add this in your hugo.toml\n[markup.goldmark.renderer] unsafe = true \u003cform action=\"../../search.html\" method=\"get\"\u003e \u003cinput name=\"search-by-detail\" class=\"search-by\" type=\"search\"\u003e {{% button type=\"submit\" style=\"secondary\" icon=\"search\" %}}Search{{% /button %}} \u003c/form\u003e Search",
"description": "Clickable buttons",
"tags": [],
"title": "Button",
"uri": "/hugo-theme-relearn/shortcodes/button/index.html"
},
{
"breadcrumb": "",
"content": "",
"description": "",
"tags": [],
"title": "Categories",
"uri": "/hugo-theme-relearn/categories/index.html"
},
{
"breadcrumb": "Tags",
"content": "",
"description": "",
"tags": [],
"title": "Tag :: Children",
"uri": "/hugo-theme-relearn/tags/children/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The children shortcode lists the child pages of the current page and its descendants.\npage 1 page 2 page 3 page X Usage ​ shortcode partial {{% children sort=\"title\" %}} {{ partial \"shortcodes/children.html\" (dict \"page\" . \"sort\" \"title\" )}} Parameter Name Default Notes containerstyle ul Choose the style used to group all children. It could be any HTML tag name. style li Choose the style used to display each descendant. It could be any HTML tag name. showhidden false When true, child pages hidden from the menu will be displayed as well. description false When true shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - read more info about summaries on gohugo.io. depth 1 The depth of descendants to display. For example, if the value is 2, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. 999. sort auto The sort criteria of the displayed list.\n- auto defaults to ordersectionsby of the page’s Front Matter\nor to ordersectionsby of the configuration Option\nor to weight\n- weight\n- title\n- modifieddate\n- expirydate\n- publishdate\n- date\n- length\n- default adhering to Hugo’s default sort criteria Examples All Default {{% children %}} page X page 1 page 2 page 3 With Description {{% children description=\"true\" %}} page XThis is a plain page test, and the beginning of a YAML multiline description... page 1This is a demo child page\npage 2This is a demo child page with no description.\nSo its content is used as description.\npage 3This is a demo child page\nInfinite Depth and Hidden Pages {{% children depth=\"999\" showhidden=\"true\" %}} page X page 1 page 1-1 page 1-1-1 (hidden) page 1-1-1-1 page 1-1-1-1-1 (hidden) page 1-1-1-1-1-1 page 1-1-2 (headless) page 1-1-2-1 page 1-1-2-2 page 1-1-3 page 2 page 3 page 3-1 page 4 (hidden) Heading Styles for Container and Elements {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" description=\"true\" %}} page XThis is a plain page test, and the beginning of a YAML multiline description... page 1This is a demo child page\npage 1-1This is a demo child page\npage 1-1-2 (headless)This is a demo child page\npage 1-1-3This is a demo child page\npage 2This is a demo child page with no description.\nSo its content is used as description.\npage 3This is a demo child page\npage 3-1This is a plain page test nested in a parent\nDivs for Group and Element Styles {{% children containerstyle=\"div\" style=\"div\" depth=\"3\" %}} page X .LinkTitle page 1 .LinkTitle page 1-1 .LinkTitle page 1-1-2 (headless) .LinkTitle page 1-1-3 .LinkTitle page 2 .LinkTitle page 3 .LinkTitle page 3-1 .LinkTitle",
"description": "List the child pages of a page",
"tags": [],
"title": "Children",
"uri": "/hugo-theme-relearn/shortcodes/children/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: CollapsibleMenu",
"uri": "/hugo-theme-relearn/options/collapsiblemenu/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: CollapsibleMenu",
"uri": "/hugo-theme-relearn/frontmatter/collapsiblemenu/index.html"
},
{
"breadcrumb": "Development",
"content": "Code Quality A new release can happen at any time from the main branch of the GitHub project without further acknowledgment. This makes it necessary that, every pushed set of changesets into the main branch must be self-contained and correct, resulting in a releasable version.\nStay simple for the user by focusing on the mantra “convention over configuration”.\nAt installation the site should work reasonable without (m)any configuration.\nStay close to the Hugo way.\nDon’t use npm or any preprocessing, our contributors may not be front-end developers.\nDocument new features in the exampleSite. This also contains entries to the What’s new page.\nDon’t break existing features if you don’t have to.\nRemove reported issue from the browser’s console.\nCheck for unnecessary whitespace and correct indention of your resulting HTML.\nConventional Commits Write commit messages in the conventional commit format.\nFollowing is an inpomplete list of some of the used conventional commit types. Be creative.\nCommon Feature Structure Shortcodes build a11y favicon attachments browser archetypes search badge chore alias menu button docs generator history children shortcodes i18n scrollbar expand theme mobile nav icon print toc include rss clipboard math variant syntaxhighlight mermaid boxes notice openapi piratify siteparam tabs",
"description": "What to know if you want to contribute",
"tags": [],
"title": "Contributing",
"uri": "/hugo-theme-relearn/development/contributing/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: CustomMathJaxURL",
"uri": "/hugo-theme-relearn/options/custommathjaxurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: CustomMathJaxURL",
"uri": "/hugo-theme-relearn/frontmatter/custommathjaxurl/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: CustomMermaidURL",
"uri": "/hugo-theme-relearn/options/custommermaidurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: CustomMermaidURL",
"uri": "/hugo-theme-relearn/frontmatter/custommermaidurl/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: CustomOpenapiURL",
"uri": "/hugo-theme-relearn/options/customopenapiurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: CustomOpenapiURL",
"uri": "/hugo-theme-relearn/frontmatter/customopenapiurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Description",
"uri": "/hugo-theme-relearn/frontmatter/description/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableAnchorCopy",
"uri": "/hugo-theme-relearn/options/disableanchorcopy/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableAnchorScrolling",
"uri": "/hugo-theme-relearn/options/disableanchorscrolling/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableAssetsBusting",
"uri": "/hugo-theme-relearn/options/disableassetsbusting/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableBreadcrumb",
"uri": "/hugo-theme-relearn/options/disablebreadcrumb/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: DisableBreadcrumb",
"uri": "/hugo-theme-relearn/frontmatter/disablebreadcrumb/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableDefaultRelref",
"uri": "/hugo-theme-relearn/options/disabledefaultrelref/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableExplicitIndexURLs",
"uri": "/hugo-theme-relearn/options/disableexplicitindexurls/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableGeneratorVersion",
"uri": "/hugo-theme-relearn/options/disablegeneratorversion/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableHoverBlockCopyToClipBoard",
"uri": "/hugo-theme-relearn/options/disablehoverblockcopytoclipboard/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableInlineCopyToClipBoard",
"uri": "/hugo-theme-relearn/options/disableinlinecopytoclipboard/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableLandingPageButton",
"uri": "/hugo-theme-relearn/options/disablelandingpagebutton/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableLanguageSwitchingButton",
"uri": "/hugo-theme-relearn/options/disablelanguageswitchingbutton/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableNextPrev",
"uri": "/hugo-theme-relearn/options/disablenextprev/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: DisableNextPrev",
"uri": "/hugo-theme-relearn/frontmatter/disablenextprev/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableRandomIds",
"uri": "/hugo-theme-relearn/options/disablerandomids/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableRootBreadcrumb",
"uri": "/hugo-theme-relearn/options/disablerootbreadcrumb/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSearch",
"uri": "/hugo-theme-relearn/options/disablesearch/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSearchHiddenPages",
"uri": "/hugo-theme-relearn/options/disablesearchhiddenpages/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSearchIndex",
"uri": "/hugo-theme-relearn/options/disablesearchindex/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSearchPage",
"uri": "/hugo-theme-relearn/options/disablesearchpage/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSeoHiddenPages",
"uri": "/hugo-theme-relearn/options/disableseohiddenpages/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableShortcutsTitle",
"uri": "/hugo-theme-relearn/options/disableshortcutstitle/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableTagHiddenPages",
"uri": "/hugo-theme-relearn/options/disabletaghiddenpages/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableTermBreadcrumbs",
"uri": "/hugo-theme-relearn/options/disabletermbreadcrumbs/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableToc",
"uri": "/hugo-theme-relearn/options/disabletoc/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: DisableToc",
"uri": "/hugo-theme-relearn/frontmatter/disabletoc/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: EditURL",
"uri": "/hugo-theme-relearn/options/editurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: EditURL",
"uri": "/hugo-theme-relearn/frontmatter/editurl/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The expand shortcode displays an expandable/collapsible section of text.\nExpand me… Thank you!\nThat’s some text with a footnote1\nThat’s some more text with a footnote.2\nAnd that’s the footnote. ↩︎\nAnything of interest goes here.\nBlue light glows blue. ↩︎\nUsage ​ shortcode shortcode (positional) partial {{% expand title=\"Expand me...\" %}}Thank you!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank you!{{% /expand %}} {{ partial \"shortcodes/expand.html\" (dict \"page\" . \"title\" \"Expand me...\" \"content\" \"Thank you!\" )}} The notice shortcode is also capable of displaying expandable/collapsible sections of text but with color options.\nParameter Name Position Default Notes title 1 \"Expand me...\" Arbitrary text to appear next to the expand/collapse icon. expanded 2 false How the content is displayed.\n- true: the content is initially shown\n- false: the content is initially hidden \u003ccontent\u003e \u003cempty\u003e Arbitrary text to be displayed on expand. Examples All Defaults {{% expand %}}Yes, you did it!{{% /expand %}} Expand me… Yes, you did it! Initially Expanded {{% expand title=\"Expand me...\" expanded=\"true\" %}}No need to press you!{{% /expand %}} Expand me… No need to press you! Arbitrary Text {{% expand title=\"Show me almost **endless** possibilities\" %}} You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e the possibilities are endless (almost - including other shortcodes may or may not work) {{% /expand %}} Show me almost endless possibilities You can add standard markdown syntax:\nmultiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc. ...and even source code the possibilities are endless (almost - including other shortcodes may or may not work)",
"description": "Expandable/collapsible sections of text",
"tags": [],
"title": "Expand",
"uri": "/hugo-theme-relearn/shortcodes/expand/index.html"
},
{
"breadcrumb": "Categories",
"content": "",
"description": "",
"tags": [],
"title": "Category :: Explanation",
"uri": "/hugo-theme-relearn/categories/explanation/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: ExternalLinkTarget",
"uri": "/hugo-theme-relearn/options/externallinktarget/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: ExternalLinkTarget",
"uri": "/hugo-theme-relearn/frontmatter/externallinktarget/index.html"
},
{
"breadcrumb": "",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter",
"uri": "/hugo-theme-relearn/frontmatter/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: HeadingPost",
"uri": "/hugo-theme-relearn/frontmatter/headingpost/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: HeadingPre",
"uri": "/hugo-theme-relearn/frontmatter/headingpre/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Hidden",
"uri": "/hugo-theme-relearn/frontmatter/hidden/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The highlight shortcode renders your code with a syntax highlighter.\n​ python 1print(\"Hello World!\") Usage ​ codeodefence shortcode shortcode (positional) partial partial (compat) ```py {lineNos=\"true\" wrap=\"true\" title=\"python\"} print(\"Hello World!\") ``` {{\u003c highlight lineNos=\"true\" type=\"py\" wrap=\"true\" title=\"python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{\u003c highlight py \"lineNos=true,wrap=true,title=python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"lineNos\" \"true\" \"type\" \"py\" \"wrap\" \"true\" \"title\" \"python\" )}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"options\" \"lineNos=true,wrap=true,title=python\" \"type\" \"py\" )}} This shortcode is fully compatible with Hugo’s highlight shortcode but offers some extensions.\nIt is called interchangeably in the same way as Hugo’s own shortcode by providing positional parameter or simply by using Markdown codefences.\nYou are free to also call this shortcode from your own partials. In this case it resembles Hugo’s highlight function syntax if you call it using compatibility syntax.\nCodefence syntax is widely available in other Markdown parsers like GitHub and therefore is the recommend syntax for generating portable Markdown.\nThe tab shortcode is also capable of displaying code but with limited options.\nParameter Name Position Default Notes type 1 \u003cempty\u003e The language of the code to highlight. Choose from one of the supported languages. Case-insensitive. title \u003cempty\u003e Extension. Arbitrary title for code. This displays the code like a single tab if hl_inline=false (which is Hugo’s default). wrap see notes Extension. When true the content may wrap on long lines otherwise it will be scrollable.\nThe default value can be set in your hugo.toml and overwritten via front matter. See below. options 2 \u003cempty\u003e An optional, comma-separated list of zero or more Hugo supported options as well as extension parameter from this table. \u003coption\u003e \u003cempty\u003e Any of Hugo’s supported options. \u003ccontent\u003e \u003cempty\u003e Your code to highlight. Settings Setting Default Values for Hugo’s Options Default values for Hugo’s supported options can be set via goldmark settings.\nIf used together with wrapping of long lines, use this recommended settings. Otherwise, line numbers will shift if code wraps.\nhugo. toml yaml json [markup] [markup.highlight] lineNumbersInTable = false markup: highlight: lineNumbersInTable: false { \"markup\": { \"highlight\": { \"lineNumbersInTable\": false } } } Setting Wrap of Long Lines Option Front Matter By default, code will be wrapped if the line is not long enough.\nYou can disable wrapping by setting highlightWrap=false or by setting the wrap parameter individually for each code block.\n​ toml yaml json highlightWrap = false highlightWrap: false { \"highlightWrap\": false } Copy to Clipboard for Inline Code Option By default inline code has a button to copy the code to the clipboard.\nIf you want to disable this feature, set disableInlineCopyToClipBoard=true.\nhugo. toml yaml json [params] disableInlineCopyToClipBoard = true params: disableInlineCopyToClipBoard: true { \"params\": { \"disableInlineCopyToClipBoard\": true } } Copy to Clipboard for Block Code Option By default block code has a button to copy the code to the clipboard that is only visible on hover.\nSet disableHoverBlockCopyToClipBoard=true to disable the hover effect and always show the button.\nhugo. toml yaml json [params] disableHoverBlockCopyToClipBoard = true params: disableHoverBlockCopyToClipBoard: true { \"params\": { \"disableHoverBlockCopyToClipBoard\": true } } Setting a Specific Color Scheme You can configure the color style used for code blocks in your color variants stylesheet file using the --CODE-theme variable. This requires further configuration as described in the above link.\nExamples Line Numbers with Starting Offset As mentioned above, line numbers in a table layout will shift if code is wrapping, so better use inline. To make things easier for you, set lineNumbersInTable = false in your hugo.toml and add lineNos = true when calling the shortcode instead of the specific values table or inline.\n{{\u003c highlight lineNos=\"true\" lineNoStart=\"666\" type=\"py\" \u003e}} # the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits print(\"Hello\") print(\" \") print(\"World\") print(\"!\") {{\u003c /highlight \u003e}} 666# the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits 667print(\"Hello\") 668print(\" \") 669print(\"World\") 670print(\"!\") Markdown Codefence with Title ```py { title=\"python\" } # a bit shorter print(\"Hello World!\") ``` ​ python # a bit shorter print(\"Hello World!\") With Wrap {{\u003c highlight type=\"py\" wrap=\"true\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff Without Wrap {{\u003c highlight type=\"py\" wrap=\"false\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff",
"description": "Render code with a syntax highlighter",
"tags": [],
"title": "Highlight",
"uri": "/hugo-theme-relearn/shortcodes/highlight/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: HighlightWrap",
"uri": "/hugo-theme-relearn/options/highlightwrap/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: HighlightWrap",
"uri": "/hugo-theme-relearn/frontmatter/highlightwrap/index.html"
},
{
"breadcrumb": "Categories",
"content": "",
"description": "",
"tags": [],
"title": "Category :: Howto",
"uri": "/hugo-theme-relearn/categories/howto/index.html"
},
{
"breadcrumb": "",
"content": "Hugo Relearn Theme A theme for Hugo designed for documentation.\n★ What’s new in the latest version ★\nOverview 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.\nKey Features Versatile Usage\nResponsive 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\nFlexible brand image configuration Automatic light/dark mode switching based on OS settings Many pre-defined color variants User-selectable variants Built-in stylesheet generator Customizable syntax highlighting Advanced Functionality\nChapter and site-wide printing capabilities Versatile search options: in-page, popup, and dedicated search page Customizable top bar buttons Configurable menus Support for hidden pages Comprehensive taxonomy support Social media integration Multilingual Support\nFull 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\nCommonMark and other Markdown extensions Support for Obsidian callouts Advanced image manipulation like lightbox, sizing, shadows, borders, and alignment Rich Shortcode Library\nCustomizable 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.\nUpdates and Changes Visit the What’s New page for feature highlights or the detailed changelog for a complete list of updates.\nContributing We welcome contributions for bug fixes and new features. Please see the contribution guidelines before getting started.\nLicensing The Relearn theme is distributed under the MIT License.\nCredits This theme builds upon the work of many contributors.",
"description": "A theme for Hugo designed for documentation.",
"tags": [],
"title": "Hugo Relearn Theme",
"uri": "/hugo-theme-relearn/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The icon shortcode displays icons using the Font Awesome library.\nUsage ​ shortcode shortcode (positional) partial {{% icon icon=\"exclamation-triangle\" %}} {{% icon icon=\"angle-double-up\" %}} {{% icon icon=\"skull-crossbones\" %}} {{% icon exclamation-triangle %}} {{% icon angle-double-up %}} {{% icon skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Position Default Notes icon 1 \u003cempty\u003e Font Awesome icon name to be displayed. It will be displayed in the text color of its according context. Finding an icon Browse through the available icons in the Font Awesome Gallery. Notice that the free filter is enabled, as only the free icons are available by default.\nOnce on the Font Awesome page for a specific icon, for example the page for the heart, copy the icon name and paste into the Markdown content.\nCustomising Icons Font Awesome provides many ways to modify the icon\nChange color (by default the icon will inherit the parent color) Increase or decrease size Rotate Combine with other icons Check the full documentation on web fonts with CSS for more.\nExamples Standard Usage Built with {{% icon heart %}} by Relearn and Hugo Built with by Relearn and Hugo\nAdvanced HTML Usage While the shortcode simplifies using standard icons, the icon customization and other advanced features of the Font Awesome library require you to use HTML directly. Paste the \u003ci\u003e HTML into markup, and Font Awesome will load the relevant icon.\nBuilt with \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearn and Hugo Built with by Relearn and Hugo\nTo use these native HTML elements in your Markdown, add this in your hugo.toml:\n[markup.goldmark.renderer] unsafe = true",
"description": "Nice icons for your page",
"tags": [],
"title": "Icon",
"uri": "/hugo-theme-relearn/shortcodes/icon/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Image.errorlevel",
"uri": "/hugo-theme-relearn/options/image.errorlevel/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Image.errorlevel",
"uri": "/hugo-theme-relearn/frontmatter/image.errorlevel/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: ImageEffects",
"uri": "/hugo-theme-relearn/options/imageeffects/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: ImageEffects",
"uri": "/hugo-theme-relearn/frontmatter/imageeffects/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The include shortcode includes other pages, resources or files from your project.\nUsage ​ shortcode shortcode (positional) partial {{% include file=\"shortcodes/include/INCLUDE_ME.md\" %}} {{% include \"shortcodes/include/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"page\" . \"file\" \"shortcodes/include/INCLUDE_ME.md\" )}} The included files can even contain Markdown and will be taken into account when generating the table of contents.\nParameter Name Position Default Notes file 1 \u003cempty\u003e The path to the page, resource or file to be included. Page and resource paths adhere to Hugo’s logical path. If not found by logical path it falls back to Hugo’s build-in readFile function hidefirstheading 2 false When true and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files. Settings Enabling Link Warnings Option Front Matter You can use include.errorlevel to control what should happen if a local link can not be resolved to a resource.\nIf not set or empty, any unresolved link is written as given into the resulting output. If set to warning the same happens and an additional warning is printed in the built console. If set to error an error message is printed and the build is aborted.\nPlease note that this can not resolve files inside of your static directory. The file must be a resource of the page or the site.\nLink warnings are also available for images \u0026 links and the openapi shortcode.\n​ toml yaml json [include] errorlevel = 'warning' include: errorlevel: warning { \"include\": { \"errorlevel\": \"warning\" } } Examples Arbitrary Content {{% include \"shortcodes/include/INCLUDE_ME.md\" %}} You can add standard markdown syntax:\nmultiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc.1 ...and even source code the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)\nEt Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a Latin expression that is used in English to mean “and other similar things”, or “and so forth” ↩︎",
"description": "Displays content from other files",
"tags": [],
"title": "Include",
"uri": "/hugo-theme-relearn/shortcodes/include/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Include.errorlevel",
"uri": "/hugo-theme-relearn/options/include.errorlevel/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Include.errorlevel",
"uri": "/hugo-theme-relearn/frontmatter/include.errorlevel/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: LandingPageName",
"uri": "/hugo-theme-relearn/options/landingpagename/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: LastModifierDisplayName",
"uri": "/hugo-theme-relearn/frontmatter/lastmodifierdisplayname/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: LastModifierEmail",
"uri": "/hugo-theme-relearn/frontmatter/lastmodifieremail/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Link.errorlevel",
"uri": "/hugo-theme-relearn/options/link.errorlevel/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Link.errorlevel",
"uri": "/hugo-theme-relearn/frontmatter/link.errorlevel/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: LinkTitle",
"uri": "/hugo-theme-relearn/options/linktitle/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: LinkTitle",
"uri": "/hugo-theme-relearn/frontmatter/linktitle/index.html"
},
{
"breadcrumb": "Development",
"content": "Semver This project tries to follow the semver policy - although not followed 100% in the past.\nUsually an entry of Breaking on the What’s new page causes a new major release number.\nAll other entries on the What’s new page will increase the minor release number.\nReleases resulting in a new major or minor number are called main release.\nReleases containing bugfixes only, are only increasing the patch release number. Those releases don’t result in announcements on the What’s new page.\nEntries on the What’s new page are checked and enforced during the version-release GitHub Action.\nManaging Issues Issues are categorized and managed by assigning labels to it.\nOnce working on an issue, assign it to a fitting maintainer.\nWhen done, close the ticket. Once an issue is closed, it needs to be assigned to next release milestone.\nA once released ticket is not allowed to be reopened and rereleased in a different milestone. This would cause the changelog to be changed even for the milestone the issue was previously released in. Instead write a new ticket.\nManaging Pull Requests If a PR is merged and closed it needs an accompanied issue assigned to. If there is no issue for a PR, the maintainer needs to create one.\nYou can assign multiple PRs to one issue as long as they belong together.\nUsually set the same labels and milestone for the PR as for the accompanied issue.\nLabels Kind An issue that results in changesets must have exactly one of the following labels. This needs to be assigned latest before release.\nLabel Description Changelog section documentation Improvements or additions to documentation - discussion This issue was converted to a discussion - task Maintenance work Maintenance feature New feature or request Features bug Something isn’t working Fixes Impact If the issue would cause a new main release due to semver semantics it needs one of the according labels and the matching badge on the What’s new page.\nLabel Description change Introduces changes with existing installations breaking Introduces breaking changes with existing installations Declination If an issue does not result in changesets but is closed anyways, it must have exactly one of the following labels.\nLabel Description duplicate This issue or pull request already exists invalid This doesn’t seem right support Request for achieving a special goal unresolved No progress on this issue update A change in behavior after updat wontchange This will not be worked on Halt You can assign one further label out of the following list to signal readers that development on an open issue is currently halted for different reasons.\nLabel Description blocked Depends on other issue to be fixed first idea A valuable idea that’s currently not worked on undecided No decision was made yet helpwanted Great idea, send in a PR needsfeedback Further information is needed 3rd-Party If the issue is not caused by a programming error in the themes own code, you can label the causing program or library.\nLabel Description asciidoc This is a topic related to processing of AsciiDoc browser This is a topic related to the browser but not the theme device This is a topic related to a certain device hugo This is a topic related to Hugo itself but not the theme mermaid This is a topic related to Mermaid itself but not the theme Setting Up a Development Environment Git Hooks are used to automate some tasks. They are stored in the .githooks root folder.\nDocumentation for each hook is contained in each file.\nAt least the pre-commit hook is required, as it updates the version number on each commit. This helps to help debugging of user related issues.\nMaking Releases A release is based on a milestone named like the release itself - just the version number, eg: 1.2.3. It’s in the maintainers responsibility to check semver semantics of the milestone’s name prior to release and change it if necessary.\nMaking releases is automated by the version-release GitHub Action. It requires the version number of the milestone that should be released. The release will be created from the main branch of the repository.\nTreat released milestones as immutable. Don’t rerelease an already released milestone. An already released milestone may already been consumed by your users.\nDuring execution of the action a few things are checked. If a check fails the action fails, resulting in no new release. You can correct the errors afterwards and rerun the action.\nThe following checks will be enforced\nthe milestone exists there is at least one closed issue assigned to the milestone all assigned issues for this milestone are closed if it’s a main release, there must be an accompanying releasenotes file present in the repo at introduction/releasenotes/\u003cmajor\u003e/\u003cminor\u003e.en.md After a successful run of the action\nthe changelog at introduction/changelog/\u003cmajor\u003e/\u003cminor\u003e/\u003cpatch\u003e.\u003clang\u003e.md is created for english and piratish, including missing generic upper level files the CHANGELOG.md is updated the releasenotes at introduction/releasenotes/\u003cmajor\u003e/\u003cminor\u003e.en.md are updated, including release version and release date missing generic upper level files for english and piratish are created the version number for the \u003cmeta generator\u003e is updated the updated files are committed the milestone is closed the repository is tagged with the version number (eg. 1.2.3), the main version number (eg. 1.2.x) and the major version number (eg. 1.x) a new entry in the GitHub release list with the according changelog will be created the official documentation is built and deployed the version number for the \u003cmeta generator\u003e is updated to a temporary and committed (this helps to determine if users are running directly on the main branch or are using releases) a new milestone for the next patch release is created (this can later be renamed to a main release if necessary)",
"description": "What to know as a maintainer",
"tags": [],
"title": "Maintaining",
"uri": "/hugo-theme-relearn/development/maintaining/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Math",
"uri": "/hugo-theme-relearn/options/math/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Math",
"uri": "/hugo-theme-relearn/frontmatter/math/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "If this is not enough, the math shortcode helps you rendering math and chemical formulae using the MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Usage ​ passthrough codefence shortcode partial $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ```math {align=\"center\"} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"page\" . \"content\" \"$$left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\" \"align\" \"center\" )}} You can also use pure Markdown for writing simple math expressions.\nPassthrough syntax is only available by further configuration and has limited features as it does not provide any of the below parameter. Nevertheless, it is widely available in other Markdown parsers like GitHub and therefore is the recommend syntax for generating portable Markdown.\nParameter Name Default Notes align center The vertical alignment.\nAllowed values are left, center or right. \u003ccontent\u003e \u003cempty\u003e Your formulae. Settings Providing Initialization Options for the MathJax Library Option Front Matter The MathJax library is configured with default settings for initialization.\nYou can overwrite the settings by providing a JSON object in mathJaxInitialize. See MathJax’s documentation for all allowed settings.\nKeep in mind that initialization settings of your pages front matter overwrite all settings of your configuration options.\n​ toml yaml json mathJaxInitialize = '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' mathJaxInitialize: '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' { \"mathJaxInitialize\": \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" }, { \\\"tex\\\": { \\\"inlineMath\\\": [[\\\"\\\\(\\\", \\\"\\\\)\\\"], [\\\"@\\\", \\\"@\\\"]], displayMath: [[\\\"\\\\[\\\", \\\"\\\\]\\\"], [\\\"@@\\\", \\\"@@\\\"]] }, \\\"options\\\": { \\\"enableMenu\\\": false }\" } Loading an External Version of the MathJax Library Option Front Matter The theme uses the shipped MathJax library by default.\nIn case you want do use a different version of the MathJax library but don’t want to override the shipped version, you can set customMathJaxURL to the URL of the external MathJax library.\n​ toml yaml json customMathJaxURL = 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js' customMathJaxURL: https://unpkg.com/mathjax/es5/tex-mml-chtml.js { \"customMathJaxURL\": \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" } Force Loading of the MathJax Library Option Front Matter The MathJax library will be loaded if the page contains a math shortcode or codefence.\nYou can force loading the MathJax library if no shortcode or codefence was used by setting math=true. If a shortcode or codefence was found, the option has no effect. This must be set in case you are using the passthrough configuration to render math.\nInstead of math=true you can also use the alias math.force=true.\n​ toml yaml json math = true math: true { \"math\": true } Passthrough Configuration You can use your math without enclosing it in a shortcode or codefence by using a passthrough configuration\nhugo. toml yaml json [markup] [markup.goldmark] [markup.goldmark.extensions] [markup.goldmark.extensions.passthrough] enable = true [markup.goldmark.extensions.passthrough.delimiters] block = [['\\[', '\\]'], ['$$', '$$']] inline = [['\\(', '\\)'], ['$', '$']] markup: goldmark: extensions: passthrough: delimiters: block: - - \\[ - \\] - - $$ - $$ inline: - - \\( - \\) - - $ - $ enable: true { \"markup\": { \"goldmark\": { \"extensions\": { \"passthrough\": { \"delimiters\": { \"block\": [ [ \"\\\\[\", \"\\\\]\" ], [ \"$$\", \"$$\" ] ], \"inline\": [ [ \"\\\\(\", \"\\\\)\" ], [ \"$\", \"$\" ] ] }, \"enable\": true } } } } } In this case you have to force load the MathJax library either in your hugo.toml or in your page’s front matter as the theme doesn’t know if math is used.\nSee the example on how a passthrough configurations makes using math really easy.\nExamples Passthrough Block Math With passthrough configuration enabled you can just drop your math without enclosing it by shortcodes or codefences but no other parameters are available.\nIn this case you have to force load the MathJax library by setting math=true either in your hugo.toml or in your page’s front matter.\nIn passthrough default configuration, block math is generated if you use two consecutive $$ as a delimiter around your formulae.\n$$\\left| \\begin{array}{cc} a \u0026 b \\\\ c \u0026 d \\end{array}\\right|$$ $$\\left| \\begin{array}{cc} a \u0026 b \\\\ c \u0026 d \\end{array}\\right|$$Passthrough Inline Math The same usage restrictions as of the previous example apply here as well.\nIn passthrough default configuration, inline math is generated if you use a single $ as a delimiter around your formulae.\nEuclid already knew, $\\sqrt{2}$ is irrational. Euclid already knew, $\\sqrt{2}$ is irrational.\nCodefence Block Math with Right Alignment If you are using codefences, more parameter are available. Your formulae still needs to be enclosed by $ or $$ as delimiters respectively.\n```math {align=\"right\"} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Shortcode Block Math with Right Alignment You can also use shortcode syntax. Your formulae still needs to be enclosed by $ or $$ as delimiters respectively.\n{{\u003c math align=\"right\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Chemical Formulae The MathJax library can also be used for chemical formulae.\n$$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$",
"description": "Beautiful math and chemical formulae",
"tags": [],
"title": "Math",
"uri": "/hugo-theme-relearn/shortcodes/math/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Math.force",
"uri": "/hugo-theme-relearn/options/math.force/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Math.force",
"uri": "/hugo-theme-relearn/frontmatter/math.force/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: MathJaxInitialize",
"uri": "/hugo-theme-relearn/options/mathjaxinitialize/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MathJaxInitialize",
"uri": "/hugo-theme-relearn/frontmatter/mathjaxinitialize/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MenuPageRef",
"uri": "/hugo-theme-relearn/frontmatter/menupageref/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MenuPost",
"uri": "/hugo-theme-relearn/frontmatter/menupost/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MenuPre",
"uri": "/hugo-theme-relearn/frontmatter/menupre/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MenuUrl",
"uri": "/hugo-theme-relearn/frontmatter/menuurl/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The mermaid shortcode generates diagrams and flowcharts from text in a similar manner as Markdown using the Mermaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Usage ​ codefence shortcode partial ```mermaid {align=\"center\" zoom=\"true\"} graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"page\" . \"content\" \"graph LR;\\n If --\u003e Then\\n Then --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} Codefence syntax is widely available in other Markdown parsers like GitHub and therefore is the recommend syntax for generating portable Markdown.\nParameter Name Default Notes align center The vertical alignment.\nAllowed values are left, center or right. zoom see notes Whether the graph is pan- and zoomable.\nIf not set the value is determined by the mermaidZoom setting of your configurations options or the pages front matter or false if not set at all.\n- false: no pan or zoom\n- true: pan and zoom active \u003ccontent\u003e \u003cempty\u003e Your Mermaid graph. Settings Configuring Pan and Zoom Option Front Matter The generated graphs can be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.\nBy default this is disabled. Set mermaidZoom=true to enable it.\nIndividual settings of a graphs zoom parameter have precedence over the page’s front matter and configuration options in that order.\n​ toml yaml json mermaidZoom = true mermaidZoom: true { \"mermaidZoom\": true } Providing Initialization Options for the Mermaid Library Option Front Matter The Mermaid library is configured with default settings for initialization.\nYou can overwrite the settings by providing a JSON object in mermaidInitialize. See Mermaid’s documentation for all allowed settings.\nKeep in mind that initialization settings of your pages front matter overwrite all settings of your configuration options.\nIn addition, you can merge settings for each individual graph through diagram directives on top of the settings of your page’s front matter or configuration options.\n​ toml yaml json mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidInitialize: '{ \"securityLevel\": \"loose\" }' { \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" } Loading an External Version of the Mermaid Library Option Front Matter The theme uses the shipped Mermaid library by default.\nIn case you want do use a different version of the Mermaid library but don’t want to override the shipped version, you can set customMermaidURL to the URL of the external Mermaid library.\n​ toml yaml json customMermaidURL = 'https://unpkg.com/mermaid/dist/mermaid.min.js' customMermaidURL: https://unpkg.com/mermaid/dist/mermaid.min.js { \"customMermaidURL\": \"https://unpkg.com/mermaid/dist/mermaid.min.js\" } Force Loading of the Mermaid Library Option Front Matter The Mermaid library will be loaded if the page contains an mermaid shortcode or codefence.\nYou can force loading the Mermaid library if no shortcode or codefence was used by setting mermaid.force=true. If a shortcode or codefence was found, this option has no effect. This comes handy in case you are using scripting to render a graph.\n​ toml yaml json [mermaid] force = true mermaid: force: true { \"mermaid\": { \"force\": true } } Setting a Specific Mermaid Theme While you can configure the Mermaid theme to render your graph by using one of the initialization options, the recommended way is to set the default value using the --MERMAID-theme variable in your color variant stylesheet. This allows your graphs to look pretty when the user switches the color variant.\nExamples Flowchart with YAML-Title ```mermaid --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] ``` --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] Sequence Diagram with Configuration Directive ```mermaid %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about you? Bob--\u003e\u003eJohn: Jolly good! ``` %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about you? Bob--\u003e\u003eJohn: Jolly good! Class Diagram ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } ``` classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } State Diagram Aligned to the Right Using Shortcode Syntax {{\u003c mermaid align=\"right\" \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open {{\u003c /mermaid \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open Entity Relationship Model with Non-Default Mermaid Theme ```mermaid %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"liable for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" ``` %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"liable for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" User Journey ```mermaid journey title My working day section Go to work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me ``` journey title My working day section Go to work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me GANTT Chart ```mermaid gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d ``` gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d Pie Chart without Zoom ```mermaid {zoom=\"false\"} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 ``` pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 Quadrant Chart ```mermaid quadrantChart title Reach and engagement of campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need to promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] ``` quadrantChart title Reach and engagement of campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need to promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] Requirement Diagram ```mermaid requirementDiagram requirement test_req { id: 1 text: the test text. risk: high verifymethod: test } element test_entity { type: simulation } test_entity - satisfies -\u003e test_req ``` requirementDiagram requirement test_req { id: 1 text: the test text. risk: high verifymethod: test } element test_entity { type: simulation } test_entity - satisfies -\u003e test_req Git Graph ```mermaid gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit ``` gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit C4 Diagrams ```mermaid C4Context title System Context diagram for Internet Banking System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Banking Customer A\", \"A customer of the bank, with personal bank accounts.\") Person(customerB, \"Banking Customer B\") Person_Ext(customerC, \"Banking Customer C\", \"desc\") Person(customerD, \"Banking Customer D\", \"A customer of the bank, \u003cbr/\u003e with personal bank accounts.\") System(SystemAA, \"Internet Banking System\", \"Allows customers to view information about their bank accounts, and make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Banking System\", \"Stores all of the core banking information about customers, accounts, transactions, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Banking System A\") System(SystemB, \"Banking System B\", \"A system of the bank, with personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Banking System D Database\", \"A system of the bank, with personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Banking System F Queue\", \"A system of the bank.\") SystemQueue_Ext(SystemG, \"Banking System G Queue\", \"A system of the bank, with personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") ``` C4Context title System Context diagram for Internet Banking System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Banking Customer A\", \"A customer of the bank, with personal bank accounts.\") Person(customerB, \"Banking Customer B\") Person_Ext(customerC, \"Banking Customer C\", \"desc\") Person(customerD, \"Banking Customer D\", \"A customer of the bank, \u003cbr/\u003e with personal bank accounts.\") System(SystemAA, \"Internet Banking System\", \"Allows customers to view information about their bank accounts, and make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Banking System\", \"Stores all of the core banking information about customers, accounts, transactions, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Banking System A\") System(SystemB, \"Banking System B\", \"A system of the bank, with personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Banking System D Database\", \"A system of the bank, with personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Banking System F Queue\", \"A system of the bank.\") SystemQueue_Ext(SystemG, \"Banking System G Queue\", \"A system of the bank, with personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") Mindmaps ```mermaid mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisation British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creation Uses Creative techniques Strategic planning Argument mapping Tools Pen and paper Mermaid ``` mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisation British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creation Uses Creative techniques Strategic planning Argument mapping Tools Pen and paper Mermaid Timeline ```mermaid timeline title History of Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter ``` timeline title History of Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter Sankey ```mermaid sankey-beta %% source,target,value Electricity grid,Over generation / exports,104.453 Electricity grid,Heating and cooling - homes,113.726 Electricity grid,H2 conversion,27.14 ``` sankey-beta %% source,target,value Electricity grid,Over generation / exports,104.453 Electricity grid,Heating and cooling - homes,113.726 Electricity grid,H2 conversion,27.14 XYChart ```mermaid xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] ``` xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] Block Diagram ```mermaid block-beta columns 1 db((\"DB\")) blockArrowId6\u003c[\"\u0026nbsp;\u0026nbsp;\u0026nbsp;\"]\u003e(down) block:ID A B[\"A wide one in the middle\"] C end space D ID --\u003e D C --\u003e D style B fill:#969,stroke:#333,stroke-width:4px ``` block-beta columns 1 db((\"DB\")) blockArrowId6\u003c[\"\u0026nbsp;\u0026nbsp;\u0026nbsp;\"]\u003e(down) block:ID A B[\"A wide one in the middle\"] C end space D ID --\u003e D C --\u003e D style B fill:#969,stroke:#333,stroke-width:4px Packet ```mermaid --- title: \"TCP Packet\" --- packet-beta 0-15: \"Source Port\" 16-31: \"Destination Port\" 32-63: \"Sequence Number\" 64-95: \"Acknowledgment Number\" 96-99: \"Data Offset\" 100-105: \"Reserved\" 106: \"URG\" 107: \"ACK\" 108: \"PSH\" 109: \"RST\" 110: \"SYN\" 111: \"FIN\" 112-127: \"Window\" 128-143: \"Checksum\" 144-159: \"Urgent Pointer\" 160-191: \"(Options and Padding)\" 192-255: \"Data (variable length)\" ``` --- title: \"TCP Packet\" --- packet-beta 0-15: \"Source Port\" 16-31: \"Destination Port\" 32-63: \"Sequence Number\" 64-95: \"Acknowledgment Number\" 96-99: \"Data Offset\" 100-105: \"Reserved\" 106: \"URG\" 107: \"ACK\" 108: \"PSH\" 109: \"RST\" 110: \"SYN\" 111: \"FIN\" 112-127: \"Window\" 128-143: \"Checksum\" 144-159: \"Urgent Pointer\" 160-191: \"(Options and Padding)\" 192-255: \"Data (variable length)\" Architecture ```mermaid architecture-beta group api(cloud)[API] service db(database)[Database] in api service disk1(disk)[Storage] in api service disk2(disk)[Storage] in api service server(server)[Server] in api db:L -- R:server disk1:T -- B:server disk2:T -- B:db ``` architecture-beta group api(cloud)[API] service db(database)[Database] in api service disk1(disk)[Storage] in api service disk2(disk)[Storage] in api service server(server)[Server] in api db:L -- R:server disk1:T -- B:server disk2:T -- B:db",
"description": "Generate diagrams and flowcharts from text",
"tags": [],
"title": "Mermaid",
"uri": "/hugo-theme-relearn/shortcodes/mermaid/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Mermaid.force",
"uri": "/hugo-theme-relearn/options/mermaid.force/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Mermaid.force",
"uri": "/hugo-theme-relearn/frontmatter/mermaid.force/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: MermaidInitialize",
"uri": "/hugo-theme-relearn/options/mermaidinitialize/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MermaidInitialize",
"uri": "/hugo-theme-relearn/frontmatter/mermaidinitialize/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: MermaidZoom",
"uri": "/hugo-theme-relearn/options/mermaidzoom/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MermaidZoom",
"uri": "/hugo-theme-relearn/frontmatter/mermaidzoom/index.html"
},
{
"breadcrumb": "Tags",
"content": "",
"description": "",
"tags": [],
"title": "Tag :: Non-Hidden",
"uri": "/hugo-theme-relearn/tags/non-hidden/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The notice shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page.\nThere may be pirates It is all about the boxes.\nUsage ​ callout shortcode shortcode (positional) partial \u003e [!primary] There may be pirates \u003e It is all about the boxes. {{% notice style=\"primary\" title=\"There may be pirates\" icon=\"skull-crossbones\" %}} It is all about the boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It is all about the boxes. {{% /notice %}} {{ partial \"shortcodes/notice.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"There may be pirates\" \"icon\" \"skull-crossbones\" \"content\" \"It is all about the boxes.\" )}} Callout syntax has limited features as it does not provide all of the below parameter. Nevertheless, it is widely available in other Markdown parsers like with GitHub alerts or Obsidian callouts and therefore is the recommend syntax for generating portable Markdown.\nIf you want to display a transparent expandable box without any border, you can also use the expand shortcode.\nParameter Name Position Default Notes style 1 default The style scheme used for the box.\n- by severity: caution, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYou can also define your own styles. color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color\nThis is not available using callout syntax. title 2 see notes Arbitrary text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon 3 see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces)\nThis is not available using callout syntax. expanded \u003cempty\u003e Whether to draw an expander and how the content is displayed.\n- \u003cempty\u003e: no expander is drawn and the content is permanently shown\n- true: the expander is drawn and the content is initially shown\n- false: the expander is drawn and the content is initially hidden \u003ccontent\u003e \u003cempty\u003e Arbitrary text to be displayed in box. Settings Defining own Styles Option Besides the predefined style values from above, you are able to define your own.\nhugo. toml yaml json [params] [[params.boxStyle]] color = 'gold' i18n = '' icon = 'rainbow' identifier = 'magic' title = 'Magic' params: boxStyle: - color: gold i18n: \"\" icon: rainbow identifier: magic title: Magic { \"params\": { \"boxStyle\": [ { \"color\": \"gold\", \"i18n\": \"\", \"icon\": \"rainbow\", \"identifier\": \"magic\", \"title\": \"Magic\" } ] } } The style parameter used in a shortcode must match the identifier in the configuration. The title for the style will be determined from the configured title. If no title but a i18n is set, the title will be taken from the translation files by that key. The title may be empty in which case, the box does not contain a default title. icon and color are working similar.\nYou can also redefine the predefined styles if you’re not satisfied with the default values.\nBelow is a usage example.\nExamples By Severity Using Callout Syntax \u003e [!CAUTION] \u003e Advises about risks or negative outcomes of certain actions. \u003e [!IMPORTANT] \u003e Key information users need to know to achieve their goal. \u003e [!INFO] \u003e Information that users \u003cins\u003e_might_\u003c/ins\u003e find interesting. \u003e [!NOTE] \u003e Useful information that users should know, even when skimming content. \u003e [!TIP] \u003e Helpful advice for doing things better or more easily. \u003e [!WARNING] \u003e Urgent info that needs immediate user attention to avoid problems. Caution Advises about risks or negative outcomes of certain actions.\nImportant Key information users need to know to achieve their goal.\nInfo Information that users might find interesting.\nNote Useful information that users should know, even when skimming content.\nTip Helpful advice for doing things better or more easily.\nWarning Urgent info that needs immediate user attention to avoid problems.\nBy Brand Colors with Title and Icon Variantion {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} {{% notice style=\"secondary\" title=\"Secondary\" %}} A **secondary** disclaimer {{% /notice %}} {{% notice style=\"accent\" icon=\"stopwatch\" %}} An **accent** disclaimer {{% /notice %}} Primary A primary disclaimer\nSecondary A secondary disclaimer\nAn accent disclaimer\nBy Color {{% notice style=\"blue\" title=\"Blue\"%}} A **blue** disclaimer {{% /notice %}} {{% notice style=\"cyan\" title=\"Cyan\" %}} A **cyan** disclaimer {{% /notice %}} {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} {{% notice style=\"grey\" icon=\"bug\" %}} A **grey** disclaimer {{% /notice %}} {{% notice style=\"magenta\" title=\"Magenta\" %}} A **magenta** disclaimer {{% /notice %}} {{% notice style=\"orange\" title=\"Orange\" icon=\"bug\" %}} A **orange** disclaimer {{% /notice %}} {{% notice style=\"red\" title=\"Red\" %}} A **red** disclaimer {{% /notice %}} Blue A blue disclaimer\nCyan A cyan disclaimer\nGreen A green disclaimer\nA grey disclaimer\nMagenta A magenta disclaimer\nOrange A orange disclaimer\nRed A red disclaimer\nBy Special Color {{% notice style=\"default\" title=\"Default\" icon=\"skull-crossbones\" %}} Just some grey default color. {{% /notice %}} {{% notice style=\"code\" title=\"Code\" icon=\"skull-crossbones\" %}} Colored like a code fence. {{% /notice %}} {{% notice style=\"transparent\" title=\"Transparent\" icon=\"skull-crossbones\" %}} No visible borders. {{% /notice %}} Default Just some grey default color.\nCode Colored like a code fence.\nTransparent No visible borders.\nVarious Features With User-Defined Color, Font Awesome Brand Icon and Markdown in Title and Content {{% notice color=\"fuchsia\" title=\"**Hugo** is _awesome_\" icon=\"fa-fw fab fa-hackerrank\" %}} You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) - etc.[^etc] [^etc]: Et Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a Latin expression that is used in English to mean \"and other similar things\", or \"and so forth\" ```plaintext ...and even source code ``` \u003e the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work) {{% /notice %}} Hugo is awesome You can add standard markdown syntax:\nmultiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc.1 ...and even source code the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)\nEt Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a Latin expression that is used in English to mean “and other similar things”, or “and so forth” ↩︎\nExpandable Content Area {{% notice style=\"green\" title=\"Expand me...\" expanded=\"true\" %}} No need to press you! {{% /notice %}} {{% notice style=\"red\" title=\"Expand me...\" expanded=\"false\" %}} Thank you! {{% /notice %}} Expand me… No need to press you!\nExpand me… Thank you!\nNo Content or No Title {{% notice style=\"accent\" title=\"Just a bar\" %}} {{% /notice %}} {{% notice style=\"accent\" %}} Just a box {{% /notice %}} Just a bar Just a box\nVarious Callouts \u003e [!caution] Callouts can have custom titles \u003e Like this one. \u003e [!caution] Title-only callout \u003e [!note]- Are callouts foldable? \u003e Yes! In a foldable callout, the contents are hidden when the callout is collapsed \u003e [!note]+ Are callouts foldable? \u003e Yes! In a foldable callout, the contents are hidden when the callout is collapsed \u003e [!info] Can callouts be nested? \u003e \u003e [!important] Yes!, they can. \u003e \u003e \u003e [!tip] You can even use multiple layers of nesting. Callouts can have custom titles Like this one.\nTitle-only callout Are callouts foldable? Yes! In a foldable callout, the contents are hidden when the callout is collapsed\nAre callouts foldable? Yes! In a foldable callout, the contents are hidden when the callout is collapsed\nCan callouts be nested? Yes!, they can. You can even use multiple layers of nesting. Code with Collapsed Colored Borders \u003e [!secondary] \u003e ```c \u003e // With colored border in Markdown syntax \u003e printf(\"Hello World!\"); \u003e ``` {{% notice style=\"red\" %}} ```c // With colored border in Shortcode syntax printf(\"Hello World!\"); ``` {{% /notice %}} // With colored border in Markdown syntax printf(\"Hello World!\"); // With colored border in Shortcode syntax printf(\"Hello World!\"); User-defined Style Self-defined styles can be configured in your hugo.toml and used for every shortcode, that accepts a style parameter.\n\u003e [!magic] \u003e Maaagic! Magic Maaagic!",
"description": "Disclaimers to help you structure your page",
"tags": [],
"title": "Notice",
"uri": "/hugo-theme-relearn/shortcodes/notice/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The openapi shortcode displays your OpenAPI / Swagger specifications using the Swagger UI library.\nUsage ​ shortcode partial {{\u003c openapi src=\"https://petstore3.openapi.io/api/v3/openapi.json\" \u003e}} {{ partial \"shortcodes/openapi.html\" (dict \"page\" . \"src\" \"https://petstore3.openapi.io/api/v3/openapi.json\" )}} If you want to print out (or generate a PDF) from your OpenAPI documentation, don’t initiate printing directly from the page because the elements are optimized for interactive usage in a browser.\nInstead, open the print preview in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.\nParameter Name Default Notes src \u003cempty\u003e The path to the to the OpenAPI specification resource or URL to be used. Resource paths adhere to Hugo’s logical path. Settings Enabling Link Warnings Option Front Matter You can use openapi.errorlevel to control what should happen if a local OpenAPI specification link can not be resolved to a resource.\nIf not set or empty, any unresolved link is written as given into the resulting output. If set to warning the same happens and an additional warning is printed in the built console. If set to error an error message is printed and the build is aborted.\nPlease note that this can not resolve files inside of your static directory. The file must be a resource of the page or the site.\nLink warnings are also available for images \u0026 links and the include shortcode.\n​ toml yaml json [openapi] errorlevel = 'warning' openapi: errorlevel: warning { \"openapi\": { \"errorlevel\": \"warning\" } } Loading an External Version of the Swagger UI Library Option Front Matter The theme uses the shipped Swagger UI library by default.\nIn case you want do use a different version of the Swagger UI library but don’t want to override the shipped version, you can set customOpenapiURL to the URL of the external Swagger UI library.\n​ toml yaml json customOpenapiURL = 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js' customOpenapiURL: https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js { \"customOpenapiURL\": \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" } Force Loading of the Swagger UI Library Option Front Matter The Swagger UI library will be loaded if the page contains an openapi shortcode or codefence.\nYou can force loading the Swagger UI library if no shortcode or codefence was used by setting openapi.force=true. If a shortcode or codefence was found, the option has no effect. This comes handy in case you are using scripting to render a spec.\n​ toml yaml json [openapi] force = true openapi: force: true { \"openapi\": { \"force\": true } } Setting a Specific Swagger UI Theme The recommended way to configure your Swagger UI theme is to set the default value using the --OPENAPI-theme variable in your color variant stylesheet. This allows your specs to look pretty when the user switches the color variant.\nExample Using Local File {{\u003c openapi src=\"petstore.json\" \u003e}}",
"description": "UI for your OpenAPI / Swagger specifications",
"tags": [],
"title": "OpenAPI",
"uri": "/hugo-theme-relearn/shortcodes/openapi/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Openapi.errorlevel",
"uri": "/hugo-theme-relearn/options/openapi.errorlevel/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Openapi.errorlevel",
"uri": "/hugo-theme-relearn/frontmatter/openapi.errorlevel/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Openapi.force",
"uri": "/hugo-theme-relearn/options/openapi.force/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Openapi.force",
"uri": "/hugo-theme-relearn/frontmatter/openapi.force/index.html"
},
{
"breadcrumb": "",
"content": "",
"description": "",
"tags": [],
"title": "Options",
"uri": "/hugo-theme-relearn/options/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Ordersectionsby",
"uri": "/hugo-theme-relearn/options/ordersectionsby/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Ordersectionsby",
"uri": "/hugo-theme-relearn/frontmatter/ordersectionsby/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children \u003e page 1",
"content": "This is a demo child page with a hidden child. You can still access the hidden child directly or via the search.\nSubpages of this page page 1-1-1 (hidden) page 1-1-2 (headless) page 1-1-3",
"description": "This is a demo child page",
"tags": [
"Children",
"Non-Hidden"
],
"title": "page 1-1",
"uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1",
"content": "This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\nSubpages of this page page 1-1-1-1",
"description": "This is a hidden demo child page",
"tags": [
"Children",
"a secret"
],
"title": "page 1-1-1 (hidden)",
"uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1 \u003e page 1-1-1 (hidden)",
"content": "This is a non-hidden demo child page of a hidden parent page with a hidden child. You can still access the hidden child directly or via the search.\nSubpages of this page page 1-1-1-1-1 (hidden)",
"description": "This is a non-hidden demo child page of a hidden parent page",
"tags": [
"Children",
"a secret"
],
"title": "page 1-1-1-1",
"uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1 \u003e page 1-1-1 (hidden) \u003e page 1-1-1-1",
"content": "This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\nSubpages of this page page 1-1-1-1-1-1",
"description": "This is a hidden demo child page",
"tags": [
"Children",
"a secret"
],
"title": "page 1-1-1-1-1 (hidden)",
"uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1 \u003e page 1-1-1 (hidden) \u003e page 1-1-1-1 \u003e page 1-1-1-1-1 (hidden)",
"content": "This is a non-hidden demo child page of a hidden parent page.",
"description": "This is a non-hidden demo child page of a hidden parent page",
"tags": [
"Children",
"a secret"
],
"title": "page 1-1-1-1-1-1",
"uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1 \u003e page 1-1-2 (headless)",
"content": "This is a plain demo child page 1-1-2-1.",
"description": "This is a demo child page",
"tags": [
"Children",
"Non-Hidden"
],
"title": "page 1-1-2-1",
"uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1 \u003e page 1-1-2 (headless)",
"content": "This is a plain demo child page 1-1-2-2.",
"description": "This is a demo child page",
"tags": [
"Children",
"Non-Hidden"
],
"title": "page 1-1-2-2",
"uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1",
"content": "This is a plain demo child page 1-1-3.",
"description": "This is a demo child page",
"tags": [
"Children",
"Non-Hidden"
],
"title": "page 1-1-3",
"uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html"
},
{
"breadcrumb": "Shortcodes \u003e Children \u003e page 3",
"content": "This is a plain demo child page 3-1.",
"description": "This is a plain page test nested in a parent",
"tags": [
"Children",
"Non-Hidden"
],
"title": "page 3-1",
"uri": "/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html"
},
{
"breadcrumb": "Categories",
"content": "",
"description": "",
"tags": [],
"title": "Category :: Reference",
"uri": "/hugo-theme-relearn/categories/reference/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Relearn.dependencies",
"uri": "/hugo-theme-relearn/options/relearn.dependencies/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The resources shortcode displays links to resources contained in a page bundle.\nAttachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Usage ​ shortcode partial {{% resources sort=\"asc\" /%}} {{ partial \"shortcodes/resources.html\" (dict \"page\" . \"sort\" \"asc\" )}} Multilanguage features are not supported directly by the shortcode but rely on Hugo’s handling for resource translations applied when the theme iterates over all available resources.\nParameter Name Default Notes style transparent The style scheme used for the box.\n- by severity: caution, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYou can also define your own styles. color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: Resources\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: paperclip\nIf you want no icon, you have to set this parameter to \" \" (a non empty string filled with spaces) expanded \u003cempty\u003e Whether to draw an expander and how the resource list is displayed.\n- \u003cempty\u003e: no expander is drawn and the resource list is permanently shown\n- true: the expander is drawn and the resource list is initially shown\n- false: the expander is drawn and the resource list is initially hidden sort asc Sorting the output in ascending or descending order. pattern .* A regular expressions, used to filter the resources by name. For example:\n- to match a file suffix of ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- to match file names ending in jpg or png, use .*\\.(jpg|png) Examples Custom Title, List of Resources Ending in png, jpg or gif {{% resources title=\"Related **files**\" pattern=\".*\\.(png|jpg|gif)\" /%}} Related files hugo.png (17 KB) Info Styled Box, Descending Sort Order {{% resources style=\"info\" sort=\"desc\" /%}} Info Treasure.pir.txt (31 B) NoTreasure.en.txt (23 B) MaybeTreasure.txt (23 B) hugo.png (17 KB) With User-Defined Color and Font Awesome Brand Icon {{% resources color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" /%}} Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Expander with Initially Hidden Resource List {{% resources style=\"primary\" expanded=\"false\" /%}} Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Style, Color, Title and Icons For further examples for style, color, title and icon, see the notice shortcode documentation. The parameter are working the same way for both shortcodes, besides having different defaults.",
"description": "List resources contained in a page bundle",
"tags": [],
"title": "Resources",
"uri": "/hugo-theme-relearn/shortcodes/resources/index.html"
},
{
"breadcrumb": "Development",
"content": "Sometimes screenshots need to be redone. This page explains how to create the different screenshots, tools and settings\nCommon Creation:\nUse English translation Empty search Remove history checkmarks but leave it on the page thats used for the screenshot After resize of the page into the required resolution, reload the page to have all scrollbars in default loading position Demo Screenshot Content:\nA meaningful full-screen screenshot of an interesting page.\nThe content should be:\ntimeless: not showing any dates or often edited content interesting: show a bunch of interesting elements like headings, code, etc balanced: no cluttering with overpresent elements or coloring aligned: aligned outlines Used by:\nHugo Themes info: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1000 x 1500 @ 1 (images/screenshot.png) Hugo Themes gallery: https://themes.gohugo.io/tags/docs/ 900 x 600 @ 1 (images/tn.png) Page URL: Screenshot Link\nCreation:\nsave as images/screenshot.png from original screenshot, scale to 900 x 600 and save as images/tn.png Remarks:\nThe locations are mandatory due to Hugo’s theme site builder.\nPreview images/screenshot.png:\nPreview images/tn.png:\nHero Image Content:\nShow the Demo Screenshot page on different devices and different themes. Composition of the different device screenshots into a template.\nThe content should be:\nconsistent: always use the same page for all devices pleasing: use a delightful background Used by:\nHugo Themes notes: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1280 x 640 GitHub project site: https://github.com/McShelby/hugo-theme-relearn 1280 x 640 GitHub social media preview: https://github.com/McShelby/hugo-theme-relearn/settings 1280 x 640 Page URL: Hero Image Link\nCreation:\nTemplate: http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase Desktop: light theme 1440 x 900 @ 1 Tablet: light theme 778 x 1038 @ 1 Phone: dark theme 450 x 801 @ .666 From original template resize to 3000 x 1500 offset y: -330, scale to 1280 x 640 and save as images/hero.png Preview images/hero.png:",
"description": "Recipe to create various documentation screenshots",
"tags": [],
"title": "Screenshots",
"uri": "/hugo-theme-relearn/development/screenshots/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: SearchIndexURL",
"uri": "/hugo-theme-relearn/options/searchindexurl/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: SearchPageURL",
"uri": "/hugo-theme-relearn/options/searchpageurl/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: ShowVisitedLinks",
"uri": "/hugo-theme-relearn/options/showvisitedlinks/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Sidebarmenus",
"uri": "/hugo-theme-relearn/options/sidebarmenus/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Sidebarmenus",
"uri": "/hugo-theme-relearn/frontmatter/sidebarmenus/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The siteparam shortcode prints values of params contained in your hugo.toml.\nUsage ​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Position Default Notes name 1 \u003cempty\u003e The name of the site param to be displayed. Examples editURL `editURL` value: {{% siteparam name=\"editURL\" %}} editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\nNested Parameter with Markdown and HTML Formatting To use formatted parameter, add this in your hugo.toml:\nhugo. toml yaml json [markup] [markup.goldmark] [markup.goldmark.renderer] unsafe = true markup: goldmark: renderer: unsafe: true { \"markup\": { \"goldmark\": { \"renderer\": { \"unsafe\": true } } } } Now values containing Markdown will be formatted correctly.\nhugo. toml yaml json [params] [params.siteparam] [params.siteparam.test] text = 'A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting' params: siteparam: test: text: A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting { \"params\": { \"siteparam\": { \"test\": { \"text\": \"A **nested** parameter \\u003cb\\u003ewith\\u003c/b\\u003e formatting\" } } } } Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}} Formatted parameter: A nested option \u003cb\u003ewith\u003c/b\u003e formatting",
"description": "Get value of site params",
"tags": [],
"title": "SiteParam",
"uri": "/hugo-theme-relearn/shortcodes/siteparam/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "You can use a tab shortcode to display a single tab with a title.\n​ c printf(\"Hello World!\"); Usage ​ shortcode partial {{% tab title=\"c\" %}} ```c printf(\"Hello World!\"); ``` {{% /tab %}} {{ partial \"shortcodes/tab.html\" (dict \"page\" . \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\")\\n```\" | .RenderString) )}} If you want multiple tabs grouped together you can wrap your tabs into the tabs shortcode.\nIf you want further options when using a single code tab, you can also use the highlight shortcode.\nParameter Name Default Notes style see notes The style scheme used for the tab. If you don’t set a style and you display a single code block inside of the tab, its default styling will adapt to that of a code block. Otherwise default is used.\n- by severity: caution, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYou can also define your own styles. color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary title for the tab. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text to be displayed in the tab. Examples Single Code Block with Collapsed Margins {{% tab title=\"Code\" %}} ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Code printf(\"Hello World!\"); Mixed Markdown Content {{% tab title=\"_**Mixed**_\" %}} A tab can not only contain code but arbitrary text. In this case text **and** code will get a margin. ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Mixed A tab can not only contain code but arbitrary text. In this case text and code will get a margin.\nprintf(\"Hello World!\"); Understanding style and color Behavior The style parameter affects how the color parameter is applied.\n{{\u003c tabs \u003e}} {{% tab title=\"just colored style\" style=\"blue\" %}} The `style` parameter is set to a color style. This will set the background to a lighter version of the chosen style color as configured in your theme variant. {{% /tab %}} {{% tab title=\"just color\" color=\"blue\" %}} Only the `color` parameter is set. This will set the background to a lighter version of the chosen CSS color value. {{% /tab %}} {{% tab title=\"default style and color\" style=\"default\" color=\"blue\" %}} The `style` parameter affects how the `color` parameter is applied. The `default` style will set the background to your `--MAIN-BG-color` as configured for your theme variant resembling the default style but with different color. {{% /tab %}} {{% tab title=\"just severity style\" style=\"info\" %}} The `style` parameter is set to a severity style. This will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon. {{% /tab %}} {{% tab title=\"severity style and color\" style=\"info\" color=\"blue\" %}} The `style` parameter affects how the `color` parameter is applied. This will set the background to a lighter version of the chosen CSS color value and also affects the chosen icon. {{% /tab %}} {{\u003c /tabs \u003e}} ​ just colored style just color default style and color just severity style severity style and color The style parameter is set to a color style.\nThis will set the background to a lighter version of the chosen style color as configured in your theme variant.\nOnly the color parameter is set.\nThis will set the background to a lighter version of the chosen CSS color value.\nThe style parameter affects how the color parameter is applied.\nThe default style will set the background to your --MAIN-BG-color as configured for your theme variant resembling the default style but with different color.\nThe style parameter is set to a severity style.\nThis will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon.\nThe style parameter affects how the color parameter is applied.\nThis will set the background to a lighter version of the chosen CSS color value and also affects the chosen icon.",
"description": "Show content in a single tab",
"tags": [],
"title": "Tab",
"uri": "/hugo-theme-relearn/shortcodes/tab/index.html"
},
{
"breadcrumb": "Shortcodes",
"content": "The tabs shortcode displays arbitrary content in an unlimited number of tabs.\nhello. py sh c print(\"Hello World!\") echo \"Hello World!\" printf(\"Hello World!\"); Usage ​ shortcode partial {{\u003c tabs title=\"hello.\" \u003e}} {{% tab title=\"py\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab title=\"sh\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{% tab title=\"c\" %}} ```c printf\"Hello World!\"); ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{ partial \"shortcodes/tabs.html\" (dict \"page\" . \"title\" \"hello.\" \"content\" (slice (dict \"title\" \"py\" \"content\" (\"```python\\nprint(\\\"Hello World!\\\")\\n```\" | .RenderString) ) (dict \"title\" \"sh\" \"content\" (\"```bash\\necho \\\"Hello World!\\\"\\n```\" | .RenderString) ) (dict \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\");\\n```\" | .RenderString) ) ) )}} If you just want a single tab you can instead call the tab shortcode standalone.\nAlso follow the above link to see the parameter for a nested tab.\nParameter Name Default Notes groupid \u003crandom\u003e Arbitrary name of the group the tab view belongs to.\nTab views with the same groupid sychronize their selected tab. The tab selection is restored automatically based on the groupid for tab view. If the selected tab can not be found in a tab group the first tab is selected instead.\nThis sychronization applies to the whole site! style \u003cempty\u003e Sets a default value for every contained tab. Can be overridden by each tab. See the tab shortcode for possible values. color \u003cempty\u003e Sets a default value for every contained tab. Can be overridden by each tab. See the tab shortcode for possible values. title \u003cempty\u003e Arbitrary title written in front of the tab view. icon \u003cempty\u003e Font Awesome icon name set to the left of the title. \u003ccontent\u003e \u003cempty\u003e Arbitrary number of tabs defined with the tab sub-shortcode. Examples Behavior of the groupid See what happens to the tab views while you select different tabs.\nWhile pressing a tab of Group A switches all tab views of Group A in sync (if the tab is available), the tabs of Group B are left untouched.\n​ Group A, Tab View 1 Group A, Tab View 2 Group B {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"_**XML**_ stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{% tab title=\"text\" %}} Hello World {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"b\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} Group A, Tab View 1 ​ json XML stuff text 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello World Group A, Tab View 2 ​ json XML stuff 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Group B ​ json XML stuff 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Nested Tab Views and Color In case you want to nest tab views, the parent tab that contains nested tab views needs to be declared with {{\u003c tab \u003e}} instead of {{% tab %}}. Note, that in this case it is not possible to put markdown in the parent tab.\nYou can also set style and color parameter for all tabs and overwrite them on tab level. See the tab shortcode for possible values.\n{{\u003c tabs groupid=\"main\" style=\"primary\" title=\"Rationale\" icon=\"thumbtack\" \u003e}} {{\u003c tab title=\"Text\" \u003e}} Simple text is possible here... {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab title=\"python\" %}} Python is **super** easy. - most of the time. - if you don't want to output unicode {{% /tab %}} {{% tab title=\"bash\" %}} Bash is for **hackers**. {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c tab title=\"Code\" style=\"default\" color=\"darkorchid\" \u003e}} ...but no markdown {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab title=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab title=\"bash\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c /tabs \u003e}} Rationale Text Code Simple text is possible here... ​ python bash Python is super easy.\nmost of the time. if you don’t want to output unicode Bash is for hackers.\n...but no markdown ​ python bash print(\"Hello World!\") echo \"Hello World!\"",
"description": "Show content in tabbed views",
"tags": [],
"title": "Tabs",
"uri": "/hugo-theme-relearn/shortcodes/tabs/index.html"
},
{
"breadcrumb": "Tags",
"content": "",
"description": "",
"tags": [],
"title": "Tag :: Taxonomy",
"uri": "/hugo-theme-relearn/tags/taxonomy/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: ThemeVariant",
"uri": "/hugo-theme-relearn/options/themevariant/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: TitleSeparator",
"uri": "/hugo-theme-relearn/options/titleseparator/index.html"
},
{
"breadcrumb": "Categories",
"content": "",
"description": "",
"tags": [],
"title": "Category :: Tutorial",
"uri": "/hugo-theme-relearn/categories/tutorial/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 1",
"content": "1.0.1 (2021-07-01) Maintenance [task] Prepare for hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1",
"description": "1.0.1 (2021-07-01) Maintenance [task] Prepare for hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1",
"tags": [],
"title": "Version 1.0",
"uri": "/hugo-theme-relearn/introduction/changelog/1/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 1",
"content": "1.0.0 (2021-07-01) Hugo 0.65.0 0.65.0 The requirement for the Hugo version of this theme is the same as for the Learn theme version 2.5.0 on 2021-07-01. New New Initial fork of the Learn theme based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to Relearn and a new logo. For the reasons behind forking the Learn theme, see this comment in the Learn issues.",
"description": "1.0.0 (2021-07-01) Hugo 0.65.0 0.65.0 The requirement for the Hugo version of this theme is the same as for the Learn theme version 2.5.0 on 2021-07-01. New New Initial fork of the Learn theme based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to Relearn and a new logo. For the reasons behind forking the Learn theme, see this comment in the Learn issues.",
"tags": [],
"title": "Version 1.0",
"uri": "/hugo-theme-relearn/introduction/releasenotes/1/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styling #65 [feature] theme: improve readability #64 [feature] menu: show hidden pages if accessed directly #60 [feature][change] theme: treat pages without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates for pre/post menu entries #56 [feature] theme: make chapter archetype more readable #55 [feature] children: add parameter for container style #53 [feature] theme: make content a template #50 [feature] menu: control menu expansion with alwaysopen parameter #49 [feature] include: new shortcode to include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highlighter: switch to standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sorting ignores ordersectionsby #63 [bug][change] children: default sorting ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden pages #61 [bug] theme: remove superfluous singular taxonomy from taxonomy title #46 [bug][change] theme: missing –MENU-HOME-LINK-HOVER-color in documentation #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog in exampleSite #33",
"description": "2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styling #65 [feature] theme: improve readability #64 [feature] menu: show hidden pages if accessed directly #60 [feature][change] theme: treat pages without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates for pre/post menu entries #56 [feature] theme: make chapter archetype more readable #55 [feature] children: add parameter for container style #53 [feature] theme: make content a template #50 [feature] menu: control menu expansion with alwaysopen parameter #49 [feature] include: new shortcode to include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highlighter: switch to standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sorting ignores ordersectionsby #63 [bug][change] children: default sorting ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden pages #61 [bug] theme: remove superfluous singular taxonomy from taxonomy title #46 [bug][change] theme: missing –MENU-HOME-LINK-HOVER-color in documentation #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog in exampleSite #33",
"tags": [],
"title": "Version 2.0",
"uri": "/hugo-theme-relearn/introduction/changelog/2/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.0.0 (2021-08-28) Change Change Syntax highlighting was switched to the built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation\nChange In the predefined stylesheets there was a typo and --MENU-HOME-LINK-HOVERED-color must be changed to --MENU-HOME-LINK-HOVER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange --MENU-HOME-LINK-color and --MENU-HOME-LINK-HOVER-color were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.\nChange Arrow navigation and children shortcode were ignoring setting for ordersectionsby. This is now changed and may result in different sorting order of your sub pages.\nChange If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.\nChange A page without a title will be treated as hidden=true.\nNew New You can define the expansion state of your menus in the front matter. Please see further documentation for possible values and default behavior.\nNew New partials for defining pre/post content for menu items and the content. See documentation for further reading.\nNew Shortcode children with new parameter containerstyle.\nNew New shortcode include to include arbitrary file content into a page.",
"description": "2.0.0 (2021-08-28) Change Change Syntax highlighting was switched to the built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation",
"tags": [],
"title": "Version 2.0",
"uri": "/hugo-theme-relearn/introduction/releasenotes/2/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.0.4 (2022-02-24) Enhancements [feature] theme: improve font loading #201 [feature][change] variant: fix inconsistent color variable naming #200 Fixes [bug] variant: fix occasional fail when resetting generator #208 [bug] docs: don’t move header on logo hover in IE11 #207 [bug] variant: avoid flash of menu header when non default variant is active #206 [bug] theme: fix wrong HTML closing tag order in chapters #205 [bug] theme: adjust breadcrumb and title for empty home page titles #202 3.0.3 (2022-02-23) Enhancements [feature] tags: show tag count in taxonomy list #195 Fixes [bug] theme: remove Hugo build warning if page is not file based #197 [bug] tags: adhere to titleSeparator #196 [bug] theme: hide footer divider and variant selector in IE11 #194 3.0.2 (2022-02-23) Enhancements [feature] tags: sort by name #193 3.0.1 (2022-02-23) Enhancements [feature] children: set containerstyle automatically according to style #192 Fixes [bug] theme: revert fontawsome to version 5 for IE11 compat #191 3.0.0 (2022-02-22) Enhancements [feature] variant: build a variant generator #188 [feature] nav: only show toc if the page has headings #182 [feature][breaking] theme: change default colors to Relearn defaults #181 [feature] variant: add a variant selector #178 [feature][breaking] menu: rework footer UX #177 [feature] theme: support for dark mode #175 [feature] docs: use light syntax highlighting theme #174 [feature] notice: tweak dull colors #173 [feature] theme: rework header UX #151 Fixes [bug] search: remove additional X in filled out search box in IE11 #190 [bug] clipboard: localize tooltips #186 [bug] print: hide sidebar on Mac #183 [bug] menu: fix scrollbar height #180 [bug][change] search: fix color change for icons on hover #176",
"description": "3.0.4 (2022-02-24) Enhancements [feature] theme: improve font loading #201 [feature][change] variant: fix inconsistent color variable naming #200 Fixes [bug] variant: fix occasional fail when resetting generator #208 [bug] docs: don’t move header on logo hover in IE11 #207 [bug] variant: avoid flash of menu header when non default variant is active #206 [bug] theme: fix wrong HTML closing tag order in chapters #205 [bug] theme: adjust breadcrumb and title for empty home page titles #202",
"tags": [],
"title": "Version 3.0",
"uri": "/hugo-theme-relearn/introduction/changelog/3/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "3.0.0 (2022-02-22) Breaking Breaking We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the menu-footer.html partial that is coming with the exampleSite.\nThis change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and Clear history functionality).\nBreaking We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.\nThis change will only affect your installation if you’ve not set the themeVariant parameter in your hugo.toml. If you still want to use the Learn color variant, you have to explicitly set themeVariant=\"learn\" in your hugo.toml.\nNote, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Change Due to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove --MENU-SEARCH-BOX-ICONS-color and introduced --MENU-SEARCH-color instead. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color to --MENU-SEARCH-BORDER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew New With this release you are now capable to define your own dark mode variants.\nTo make this possible, we have introduced a lot more color variables you can use in your color variants. Your old variants will still work and don’t need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.\nTo see what’s now possible, see the new variants relearn-dark and neon that are coming with this release.\nNew To make the creation of new variants easier for you, we’ve added a new interactive theme variant generator. This feature will not work with Internet Explorer 11.\nNew You can now configure multiple color variants in your hugo.toml. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer. See the documentation for configuration.\nNote, that the new variant selector will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant selector will not be displayed with Internet Explorer 11.",
"description": "3.0.0 (2022-02-22) Breaking Breaking We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the menu-footer.html partial that is coming with the exampleSite.",
"tags": [],
"title": "Version 3.0",
"uri": "/hugo-theme-relearn/introduction/releasenotes/3/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 4",
"content": "4.0.5 (2022-06-12) Fixes [bug] i18n: Vietnamese language with wrong lang code #270 [bug] i18n: fix search for non western languages #269 4.0.4 (2022-06-07) Enhancements [feature] theme: improve keyboard navigation for scrolling #268 Fixes [bug] swagger: adjust font-size for method buttons #267 [bug] menu: hide expander when only hidden subpages #264 [bug] theme: make compatible with Hugo 0.100.0 #263 Maintenance [task] swagger: update rapidoc to 9.3.2 #266 [task] mermaid: update to 9.1.1 #265 4.0.3 (2022-06-05) Enhancements [feature] toc: add scrollbar #262 4.0.2 (2022-06-05) Fixes [bug] theme: let browser scroll page on CTRL+f #242 4.0.1 (2022-06-05) No changelog for this release. 4.0.0 (2022-06-05) Enhancements [feature] shortcodes: add named parameter if missing #260 [feature][breaking] theme: remove –MAIN-ANCHOR-color from stylesheet #256 [feature] i18n: add Italian translation #254 [feature] attachments: support for brand colors #252 [feature] notice: support for brand colors #251 [feature][breaking] config: remove custom_css #248 [feature] theme: use proper file extension for page-meta.go #246 [feature] variant: add support for brand color variables #239 [feature] i18n: add Polish translation #237 Fixes [bug] shortcodes: accept boolean parameters if given as string #261 [bug] print: adjust button and tab size #259 [bug] print: show Mermaid if requested in frontmatter #255 [bug] theme: adjust thin scrollbar slider #244 [bug] mobile: fix broken scrollbar #243 [bug] theme: fix display of tooltip for heading anchor #241",
"description": "4.0.5 (2022-06-12) Fixes [bug] i18n: Vietnamese language with wrong lang code #270 [bug] i18n: fix search for non western languages #269",
"tags": [],
"title": "Version 4.0",
"uri": "/hugo-theme-relearn/introduction/changelog/4/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 4",
"content": "4.0.0 (2022-06-05) Breaking Breaking The custom_css config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the custom-header.html template in a much more generic manner.\nBreaking Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove --MAIN-ANCHOR-color instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from --MAIN-LINK-color and --MAIN-ANCHOR-HOVER-color respectively.\nNew New All shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don’t need to change anything in your installation.\nThis applies to expand, include, notice and siteparam.\nNew The button shortcode received some love and now has a parameter for the color style similar to other shortcodes.\nNew New colors --PRIMARY-color and --SECONDARY-color were added to provide easier modification of your custom style. Shortcodes with a color style can now have primary or secondary as additional values.\nThese two colors are the default for other, more specific color variables. You don’t need to change anything in your existing custom color stylesheets as those variables get reasonable default values.\nNew Translation into Polish. This language is not supported for search.\nNew The documentation for all shortcodes were revised.",
"description": "4.0.0 (2022-06-05) Breaking Breaking The custom_css config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the custom-header.html template in a much more generic manner.",
"tags": [],
"title": "Version 4.0",
"uri": "/hugo-theme-relearn/introduction/releasenotes/4/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.0.3 (2022-07-07) Fixes [bug] ie11: no styles after rework of archetypes #306 5.0.2 (2022-07-07) Fixes [bug] theme: load CSS if JS is disabled #305 5.0.1 (2022-07-07) Enhancements [feature][breaking] theme: optimize loading of js and css #303 5.0.0 (2022-07-05) Enhancements [feature][change] archetypes: modularize rendering #300 [feature] history: don’t reload page when history gets cleared #299 [feature] menu: replace expander by fontawesome chevrons #296 [feature] theme: align content with topbar icon limits #290 [feature] button: allow for empty href #288 [feature] i18n: make Simplified Chinese the standard language for the zn code #287 [feature] clipboard: move head styles to stylesheet #286 [feature] math: add mathjax rendering #235 [feature] theme: allow for page heading modification #139 Fixes [bug] favicon: fix URL if site resides in subdirectory #302 [bug] code: show copy-to-clipboard marker for blocklevel code #298 [bug] menu: make active expander visible on hover #297 [bug] print: disable arrow navigation #294 [bug] print: add missing page break after index or section #292 [bug] theme: use more space on wide screens #291 [bug] theme: fix size of chapter heading #289 Maintenance [task] chore: update RapiDoc 9.3.3 #301 [task] chore: update Mermaid 9.1.3 #293",
"description": "5.0.3 (2022-07-07) Fixes [bug] ie11: no styles after rework of archetypes #306",
"tags": [],
"title": "Version 5.0",
"uri": "/hugo-theme-relearn/introduction/changelog/5/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.0.0 (2022-07-05) Breaking Breaking The theme changed how JavaScript and CSS dependencies are loaded to provide a better performance. In case you’ve added own JavaScript code that depends on the themes jQuery implementation, you have to put it into a separate *.js file (if not already) and add the defer keyword to the script element. Eg.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e Change Change The way archetypes are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones.\nYour existing markdown files will still work like before and therefore you don’t need to change anything after the upgrade. Nevertheless, it is recommended to adapt your existing markdown files to the new way as follows:\nfor your home page, add the front matter parameter archetype = \"home\" and remove the leading heading\nfor all files containing the deprecated front matter parameter chapter = true, replace it with archetype = \"chapter\" and remove the leading headings\nChange The front matter options pre / post were renamed to menuPre / menuPost. The old options will still be used if the new options aren’t set. Therefore you don’t need to change anything after the upgrade.\nNew New Adding new partials heading-pre.html / heading-post.html and according front matter options headingPre / headingPost to modify the way your page`s main heading gets styled.\nNew The new shortcode math is available to add beautiful math and chemical formulae. See the documentation for available features. This feature will not work with Internet Explorer 11.",
"description": "5.0.0 (2022-07-05) Breaking Breaking The theme changed how JavaScript and CSS dependencies are loaded to provide a better performance. In case you’ve added own JavaScript code that depends on the themes jQuery implementation, you have to put it into a separate *.js file (if not already) and add the defer keyword to the script element. Eg.",
"tags": [],
"title": "Version 5.0",
"uri": "/hugo-theme-relearn/introduction/releasenotes/5/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "6.0.0 (2024-04-27) Enhancements [feature][breaking] theme: unify description #845 [feature] schema: add schema support in meta data #844 [feature] include: use Hugo’s resources #835 [feature] math: allow to work with Hugo’s passthrough configuration #832 [feature] i18n: add Romanian translation #828 [feature][breaking] menu: remove menuTitle frontmatter #714 [feature][breaking] theme: end support for Internet Explorer 11 #584 Fixes [bug] frontmatter: move frontmatter config for exampleSite out of root #843 [bug] images: color outline using primary color #838 [bug][breaking] variant: avoid Hugo permission errors on build #831 [bug] theme: unwanted paragraph break with AsciiDoc #829 Maintenance [task][breaking] swagger: remove shortcode #847 [task][breaking] search: remove JSON outputformat for search index #846 [task] theme: sync to Hugo’s implementation #841 [task][change] fontawesome: update to 6.5.2 #834",
"description": "6.0.0 (2024-04-27) Enhancements [feature][breaking] theme: unify description #845 [feature] schema: add schema support in meta data #844 [feature] include: use Hugo’s resources #835 [feature] math: allow to work with Hugo’s passthrough configuration #832 [feature] i18n: add Romanian translation #828 [feature][breaking] menu: remove menuTitle frontmatter #714 [feature][breaking] theme: end support for Internet Explorer 11 #584 Fixes [bug] frontmatter: move frontmatter config for exampleSite out of root #843 [bug] images: color outline using primary color #838 [bug][breaking] variant: avoid Hugo permission errors on build #831 [bug] theme: unwanted paragraph break with AsciiDoc #829 Maintenance [task][breaking] swagger: remove shortcode #847 [task][breaking] search: remove JSON outputformat for search index #846 [task] theme: sync to Hugo’s implementation #841 [task][change] fontawesome: update to 6.5.2 #834",
"tags": [],
"title": "Version 6.0",
"uri": "/hugo-theme-relearn/introduction/changelog/6/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "6.0.0 (2024-04-27) Breaking Breaking This release requires you to move your self-defined variant (theme-*.css) and chroma stylesheets (chroma-*.css) from static/css to assets/css.\nThis was necessary to avoid permission errors on build if running in certain Unix configurations.\nIn addition it is not allowed anymore to @import your chroma stylesheet from inside of your variant stylesheet.\nSay, your chroma stylesheet is named chroma-monokai.css, you have to add the following inside your variant stylesheet:\n--CODE-theme: monokai; Breaking The parameter description in your hugo.toml will now be ignored.\nWith the newly introduced unified handling of descriptions throughout the theme, the only place the old parameter would have been used was your home page.\nFor migration, move the description parameter of your hugo.toml into the front matter section of your home page.\nBreaking Search support for the json outputformat deprecated in 5.4.0 was removed.\nChange it to search for the homepage in your hugo.toml. See the docs for detailed configuration.\nBreaking The front matter option menuTitle deprecated in 5.24.0 was removed in favor for Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead of title to generate the breadcrumb.\nBreaking The swagger shortcode deprecated in 5.13.0 was removed in favor for the openapi shortcode with the same set of parameter.\nBreaking Support for Internet Explorer 11 was finally dropped.\nChange Change With the removal of support for Internet Explorer 11, Font Awesome was upgraded to version 6.5.2.\nYou may experience slight changes for some icons. In addition you have additional ~1700 icons to chose from.\nChange The children shortcode was fixed to adhere to its documentation, generating the description based on this rule: When no description or summary exists for the page, the first 70 words of the content is taken.\nPreviously, the summary erroneously was ignored which now can lead to different output if you set description=true as a parameter.\nNew New The include shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting include.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.\nNew Math is now usable without enclosing it in a shortcode or Markdown codefence by using Hugo’s passthrough configuration.\nNew Translation into Romanian.",
"description": "6.0.0 (2024-04-27) Breaking Breaking This release requires you to move your self-defined variant (theme-*.css) and chroma stylesheets (chroma-*.css) from static/css to assets/css.",
"tags": [],
"title": "Version 6.0",
"uri": "/hugo-theme-relearn/introduction/releasenotes/6/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 7",
"content": "7.0.1 (2024-10-15) Fixes [bug] search: search page not generated with renderer.unsafe #929 7.0.0 (2024-10-13) Enhancements [feature][change] logo: move Relearn logo to exampleSite #924 [feature][change] math: adhere to Hugo’s default config params #923 [feature][change] theme: replace font #922 [feature][breaking] theme: reduce build time #685 Fixes [bug] theme: remove duplicate path warning #926 Maintenance [task] theme: remove author deprecation warning #919 [task] theme: remove deprecation waring for usage of .Sites.First #912 [task][breaking] theme: restructure code #891 [task][breaking] search: improve generation of dedicated search page #888 [task] theme: remove warning for usage of .Site.IsMultiLingual #877 [task][breaking] roadmap: upcoming major changes for 7.0.0 #715",
"description": "7.0.1 (2024-10-15) Fixes [bug] search: search page not generated with renderer.unsafe #929",
"tags": [],
"title": "Version 7.0",
"uri": "/hugo-theme-relearn/introduction/changelog/7/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 7",
"content": "7.0.0 (2024-10-15) Hugo 0.126.0 0.126.0 This release requires a newer Hugo version. Breaking Breaking This release comes with significant changes in file naming of partials and how the theme works internally. This was done because the theme\nsuffered from poor build performance for sites with 1000 or more pages reinvented the wheel instead of using available Hugo mechanisms What do I gain, you may ask. A significant performance boost during build! Usually, the build time has been cut at least in half for bigger sites. It is now possible to build even larger sites with 5000 or more pages. This was previously almost impossible due to rapidly increasing build time with the more pages you’ve introduced. For even bigger sites, the theme now has configurable performance optimizations - at the price of feature limitations.\nIf you haven’t done customizations to any partials, you can update right away.\nIf you have customized your templates, in the best cases, you will get build warnings or even errors. In the worst cases, your build succeeds but the site will not work as intended by you.\nSpecifically, you will have to adapt your site if you have\noverwritten the header.html, menu.html or footer.html partials self-defined output formats self-defined archetype partials in layouts/partials/archetypes - now becoming page designs overwritten prev/next topbar buttons - needs sync with implementation changes Breaking This release changes the way the search index and the dedicated search page are generated. This may require reconfiguration by you to still work as you have intended.\nYou need to remove the now obsolete search and searchpage output format from [outputs.home] in your hugo.toml, resulting in something similar to\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'print'] outputs: home: - html - rss - print { \"outputs\": { \"home\": [ \"html\", \"rss\", \"print\" ] } } After that, your build will succeed but will most likely cause new defaults to be applied. With no further settings, in-page search, search popup and dedicated search page are all active by default. This can be reconfigured.\nIn addition, you are now able to overwrite the default file name of the search index and the default page name of the dedicated search page by changing searchIndexURL and searchPageURL respectively in your hugo.toml.\nSee the updated documentation for reference.\nChange Change Once again, the theme changed the font. We switched to the excellent Roboto Flex font.\nCare was taken to configure the font to look similar to the previously used Work Sans. Nevertheless, in direct comparison, you will see slight differences in appearance.\nThis change was necessary as the previously used font had display issues with marked text, contrast, and some other minor stuff. As an aftermath, the number of requests and the download size were decreased when loading a page.\nThe font was created by Google, is licensed under OFL 1.1 and is delivered from your theme’s installation. As always, no third-party server calls are involved.\nIf you have changed the font-family in your installation, you most likely have to adjust the variables --MAIN-font-weight, --MAIN-BOLD-font-weight and --MAIN-letter-spacing.\nAdditionally, if you have changed the font to a variable font in your installation, you may have to adjust the variable --MAIN-font-variation-settings. As this only applies to variable fonts, this should rarely be necessary.\nChange While switching the font, it was discovered that certain CSS variables were falsely named. You don’t need to change anything in your custom variant stylesheet as the old names will be used as a fallback.\n--MAIN-TITLES-TEXT-font was renamed to --MAIN-TITLES-font, --MAIN-TITLES-H\u003cn\u003e-color was renamed to --MAIN-TITLES-H\u003cn\u003e-TEXT-color.\nChange The options and front matter to force loading a math, mermaid or openapi library has been changed.\nPreviously, you had to set the unintuitive disableMathJax=false to force load the math library in case of a passthrough configuration. This is replaced by the simpler math=true or math.force=true and is now in line with Hugo’s official documentation.\nYou don’t need to change anything yet but will receive warnings if the old settings are used.\nChange The default logo is not contained inside of the theme’s logo partial anymore.\nThis is to avoid usage of the theme’s branding throughout the web in non-modified installations.\nIn addition, the default text for the logo partial is now taken from the linkTitle setting of your hugo.toml.\nNew New The docs received a much-needed overhaul for all chapters.\nBasically, the structure was reorganized, giving each topic its own page while keeping the amount of items for each menu level comprehensible by adding sub-pages.\nThe docs now clearly differentiate between configuration of your site, all things writing page content and the shortcodes docs that cover both topics, configuration and usage.\nTo give you a better overview of what’s possible with the theme, we introduced reference pages for all theme configuration options and front matter and mark each occurrence of such on all pages with the badges Option and Front Matter.\nAlso, a lot of previously undocumented features are now included, namely\nthe hidden pages feature options of the menus configuring breadcrumb, titles and headings of your content options for using links adding custom output formats",
"description": "7.0.0 (2024-10-15) Hugo 0.126.0 0.126.0 This release requires a newer Hugo version. Breaking Breaking This release comes with significant changes in file naming of partials and how the theme works internally. This was done because the theme",
"tags": [],
"title": "Version 7.0",
"uri": "/hugo-theme-relearn/introduction/releasenotes/7/0/index.html"
}
]
Reference in a new issue View git blame Copy permalink