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.
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
suffered 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.
If you haven’t done customizations to any partials, you can update right away.
If 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.
Specifically, you will have to adapt your site if you have
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.
You need to remove the now obsolete search and searchpage output format from [outputs.home] in your hugo.toml, resulting in something similar to
hugo.
[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.
In 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.
Change Once again, the theme changed the font. We switched to the excellent Roboto Flex font.
Care 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.
This 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.
The 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.
If 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.
Additionally, 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.
Change 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.
--MAIN-TITLES-TEXT-font was renamed to --MAIN-TITLES-font, --MAIN-TITLES-H<n>-color was renamed to --MAIN-TITLES-H<n>-TEXT-color.
Change The options and front matter to force loading a math, mermaid or openapi library has been changed.
Previously, 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.
You don’t need to change anything yet but will receive warnings if the old settings are used.
Change The default logo is not contained inside of the theme’s logo partial anymore.
This is to avoid usage of the theme’s branding throughout the web in non-modified installations.
New The docs received a much-needed overhaul for all chapters.
Basically, 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.
To 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.
Also, a lot of previously undocumented features are now included, namely
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.
New 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.
Change If the content for the notice shortcode is empty, now only the title bar will be displayed. Previously an empty content box was displayed.
New
New The notice shortcode has a new parameter expanded to make the content collapsible.
New If you are running Hugo 0.134.0 or later, the theme now supports Obsidian callouts.
New 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.
If 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.
If you dislike the new behavior, you can deactivate it by setting disableAnchorScrolling=true in your hugo.toml. See the docs for further options.
New
New If you are running Hugo 0.132.0 or later, the theme is now capable to print GitHub alerts.
New 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.
New 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).
Change 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.
New
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.
New Shortcodes supporting an errorlevel configuration can now have overridden values in the front matter section of each individual page.
New The theme now comes with its own overridden version of the relref shortcode.
While 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.
The shortcode is deactivated by default and can be activated by setting
hugo.
[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.
This was necessary to avoid permission errors on build if running in certain Unix configurations.
In addition it is not allowed anymore to @import your chroma stylesheet from inside of your variant stylesheet.
Say, your chroma stylesheet is named chroma-monokai.css, you have to add the following inside your variant stylesheet:
--CODE-theme:monokai;
Breaking The parameter description in your hugo.toml will now be ignored.
With the newly introduced unified handling of descriptions throughout the theme, the only place the old parameter would have been used was your home page.
For migration, move the description parameter of your hugo.toml into the front matter section of your home page.
Breaking Search support for the json outputformat deprecated in 5.4.0 was removed.
Change it to search for the homepage in your hugo.toml. See the docs for detailed configuration.
Breaking The front matter option menuTitledeprecated in 5.24.0 was removed in favor for Hugo’s own linkTitle.
Additionally, if set, linkTitle will now be used instead of title to generate the breadcrumb.
Breaking Support for Internet Explorer 11 was finally dropped.
Change
Change With the removal of support for Internet Explorer 11, Font Awesome was upgraded to version 6.5.2.
You may experience slight changes for some icons. In addition you have additional ~1700 icons to chose from.
Change 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.
Previously, the summary erroneously was ignored which now can lead to different output if you set description=true as a parameter.
New
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.
New Math is now usable without enclosing it in a shortcode or Markdown codefence by using Hugo’s passthrough configuration.
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.
The 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.
With 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.
By 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.
New
New Additional styling was added for the native HTML elements <mark> and <kbd>. To use them you must allow the usage of HTML in your hugo.toml. The Markdown documentation was enhanced for this.
New 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.
New 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 lazyimage effect. The default value hasn’t changed in comparison to older versions, you don’t need to change anything.
If 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).
Anyways, users are strongly advised to migrate as the attachments shortcode will not receive support anymore. Migration instructions are listed on the attachments shortcode page.
Change 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.
Change 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.
Change 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.
New
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.
Please note that a page link will generate false negatives if uglyURLs=true and it references an ordinary page before 0.123.0.
Please note that an image link will generate false negatives if the file resides in your static directory.
New 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).
The 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.
New New partial for defining the heading. See documentation for further reading.
New On taxonomy and term pages you can now use prev/next navigation as within the normal page structure.
New 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.
New Improvements for accessibility when tabbing through the page for images, links and tab handles.
New 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.
New The themes config and front matter options received a comprehensive documentation update. In addition the theme switched from config.toml to hugo.toml.
New Restored compatibility with Hugo versions 0.121.0 or higher for the highlight shortcode. This does not change the minimum required Hugo version.
New 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.
Change your previous setting from
hugo.
[params]author='Hugo'
params:author:Hugo
{"params":{"author":"Hugo"}}
to
hugo.
[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.
New
New Taxonomy and term pages are now allowed to contain content. This is added inbetween the title and the page list.
New It is now possible to print custom taxonomies anywhere in your page. See the docs.
New It is now possible to adjust the menu width for your whole site. See the docs.
New This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. See the docs.
New 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).
New 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.
New The theme has updated its Mermaid dependency to 10.6.0. This adds support for the xychart type.
New This release adds portable Markdown links.
Previously 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.
You could work around this by using the relref shortcode (eg [generator]({{% relref "../generator" %}})) which works but results in non-portable Markdown.
Now 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.
The following types of linking are supported:
link
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-.
If you haven’t modified anything, everything is fine. Otherwise you have to check your custom CSS rules and JavaScript code.
Change You can now have structural sections in the hierarchical menu without generating a page for it.
This 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.
This 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.
In 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.
New
New It is now possible to overwrite the setting for collapsibleMenu of your hugo.toml inside of a page’s front matter.
New 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.
New It is now possible to remove the root breadcrumb by setting disableRootBreadcrumb=true in your hugo.toml.
New The output of the dedicated search page now displays the result’s breadcrumb.
New Table rows now change their background color on every even row.
New 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.htmlpartial 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.
New 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.
With 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.
Additionally, the syntaxhighlighting inside of openapi for printing was switched to a light scheme for all theme variants.
If you dislike this change, you can revert this in your theme variants CSS by adding
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.
New
New The theme variants Zen Light and Zen Dark now add more contrast between menu, topbar and content by adding thin borders.
Those 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.
For existing variants nothing has changed visually.
New The default values for the image effects are now configurable for your whole site via hugo.toml or for each page through front matter.
New 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.
New 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.
New The theme has added two new color variants zen-light and zen-dark. Check it out!
New The theme now dispatches the custom eventthemeVariantLoaded on the document when the variant is fully loaded either initially or by switching the variant manually with the variant selector.
New 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).
New Translation into Hungarian.
5.18.0 (2023-07-27)
Change
Change The theme adds additional warnings for deprecated or now unsupported features.
Change 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.
New
New Restored compatibility with Hugo 0.95.0 or higher. This does not change the minimum required Hugo version.
New 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.
The copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.
If 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.
New
New Restored compatibility with Hugo 0.114.0 or higher. This does not change the minimum required Hugo version.
New The new highlight shortcode replaces Hugo’s default implementation and is fully compatible. So you don’t need to change anything.
In 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.
DEPRECATION warnings mark features that still work but may be removed in the future.
UNSUPPORTED warnings mark features that will not work anymore.
Change The 404 error page was revamped. Hopefully you will not see this very often.
New
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.
The 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.
Additionally 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.
New The theme now optionally supports separate favicons for light & 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.
The attachments shortcode has compatibility issues with newer Hugo versions. You must switch to leaf bundles or are locked to Hugo < 0.112.0 for now.
It 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.
Change The tabs shortcode has changed behavior if you haven’t set the groupid parameter.
Formerly 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.
New
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.
Additionally for such a use case, the whitespace between a tab outline and the code is removed if only a single code block is contained.
New Besides the tagtaxonomy 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.
Hugo’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.
New To give you more flexibility in customizing your article layout a new partial content-header.html is introduced.
This 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.
So how to adjust the position of tags starting from the theme’s default where tags are only shown above the title?
Hide 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.
Additionally, 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.
The 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
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.
New 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.
In 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:
This is also the new default setting if you haven’t configured themeVariant in your hugo.toml.
Additionally you can configure the variants to be taken for light/dark mode with the new themeVariantAuto parameter.
This is not supported for Internet Explorer 11, which still displays in the relearn-light variant.
Change The JavaScript code for handling image lightboxes (provided by Featherlight) was replaced by a CSS-only solution.
This 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.
Change 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.
New
New Translation into Czech. This language is not supported for search.
NewGitHub 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.
Additionally 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.
It 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.
To get rid of this undesired behavior you have two choices:
Make 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.
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.
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.
+++title='Credits'+++
---title:Credits---
{"title":"Credits"}
Change
Change The required directory name for the attachments shortcode was changed for leaf bundles.
Previously, 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.<LANGCODE>.files or index.<LANGCODE>.files subdirectory accordingly.
This 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.
Change Absolute links prefixed with http:// or https:// are now opened in a separate browser tab.
You can revert back to the old behavior by defining externalLinkTarget="_self" in the params section of your hugo.toml.
New The new badge shortcode is now available to add highly configurable markers to your content as you can see it on this page.
New The new icon shortcode simplyfies the usage of icons. This can even be combined with also new badge shortcode.
New The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely task lists, defintion lists and footnotes.
New 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.
New 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.
To 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.
You can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.
New Keyboard handling for the TOC and search was improved.
Pressing 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.
The 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.
New 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.
To configure this in your hugo.toml make sure to set Hugo’s disableHugoGeneratorInject=trueand also [params] disableGeneratorVersion=true, otherwise Hugo will generate a meta tag into your home page automagically.
New Creation of your project gets a little bit faster with this release.
This 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.
For 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.
If 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.
ChangeWith the proper settings in your hugo.toml your page is now servable from the local file system using file:// URLs.
Please 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://.
Change 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.
New 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.
New 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
NewImage formatting has two new classes to align images to the left or right. Additionally, the already existing inline option is now documented.
New 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.
You can revert this behavior by overwriting the print output format setting in your hugo.tomlto:
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.
<scriptdefersrc="myscript.js"></script>
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.
Your 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:
for your home page, add the front matter parameter archetype = "home" and remove the leading heading
for all files containing the deprecated front matter parameter chapter = true, replace it with archetype = "chapter" and remove the leading headings
Change 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.
New
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.
New 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.
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.
If you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.
Change
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.
Change 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.
New
New All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.
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.
Breaking 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.
New
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.
New The button shortcode received some love and now has a parameter for the color style similar to other shortcodes.
New 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.
These 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.
New Translation into Polish. This language is not supported for search.
New The documentation for all shortcodes were revised.
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.
New You can activate print support in your hugo.toml to add the capability to print whole chapters or even the complete site.
New 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.
New 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.
The 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.
New
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.
Breaking We made changes to the menu footer. If you have your menu-footer.htmlpartial 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.
This 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).
Breaking 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.
This 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.
Note, 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.
Change
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.
Change 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.
New
New With this release you are now capable to define your own dark mode variants.
To 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.
To see what’s now possible, see the new variants relearn-dark and neon that are coming with this release.
New 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.
New 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.
Note, 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.
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.
In 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:
Type
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.
Also, 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.
In 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.
You may see errors on the console after the update in the form:
ERROR 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:
Start 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.
Copy 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.
New 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.
New 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.
New New front matter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.
New 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.
New If a search term is found in an expand shortcode, the expand will be opened.
New 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
Change 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.
Change--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.
Change 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.
Change If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.
Change A page without a title will be treated as hidden=true.
New
New You can define the expansion state of your menus in the front matter. Please see further documentation for possible values and default behavior.
New New partials for defining pre/post content for menu items and the content. See documentation for further reading.
New Shortcode children with new parameter containerstyle.
New New shortcode include to include arbitrary file content into a page.
New Shortcode expand with new parameter to open on page load.
1.1.0 (2021-07-02)
Breaking
BreakingMermaid diagrams can now be panned and zoomed. This isn’t configurable yet.
New
NewMermaid 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.
Hugo uses a union file system, which lets you combine multiple directories.
By 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.
For 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.
See this list, to learn which files are allowed to be modified by you.
This makes it easy to customize the theme without changing files in the themes directory, making future theme updates simpler.
Warning
Don’t edit files inside the themes/hugo-theme-relearn directory. That’s not the recommended way to customize! Refer to the explanation above.
Don’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.
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:enlanguages:en:languageCode:enlanguageName:Englishtitle:My Websiteweight:1pir:languageCode:art-x-pirlanguageDirection:rtllanguageName:Pirrratishtitle:Arrr, my Websiteweight: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:
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.
The title will be used in meta information of your HTML.
hugo.
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.
Social Media Images
When your page is shared on social media, you can set a site-wide image to display with the link
hugo.
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.
Deployment Scenarios
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.
No calls to 3rd party servers, no calling home, no tracking. Privacy friendly.
Server Deployment
If your server deployment has no special requirements, you can skip this section and use the standard Hugo options.
For 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.
If you are still using Hugo’s relref shortcode (which you shouldn’t), you will need further configuration.
Warning
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.
Private Web Server (LAN)
The same settings as with any of the public web server scenarios or
hugo.
baseURL='/'relativeURLs=true
baseURL:/relativeURLs:true
{"baseURL":"/","relativeURLs":true}
File System
Your generated site can be used headless without a HTTP server.
This 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.
Use the following settings
hugo.
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.
Available Output Formats
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:
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.
The 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.
If you don’t like the URLs, you can reconfigure outputFormats.print in your hugo.toml to something other than the default of:
An interactive tool to generate color variant stylesheets
Subsections of Branding
Logo
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.
If 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.
If 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.
If 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:
By default, only your site title will be shown at the top of the menu. You can configure this, or override the logo partial.
Create 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!
The size of the logo will adapt automatically.
Colors
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.
Place your theme file in assets/css or themes/hugo-theme-relearn/assets/css. Name it theme-*.css.
In 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.
Multiple Variants
To let the reader choose between multiple variants, set themeVariant like this:
The first variant is the default, and a selector will appear if there’s more than one.
Adjust 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.
hugo.
[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.
Default 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.
You can override the default with themeVariantAuto:
hugo.
[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.
Like with the multiple variants option, you are defining your theme variants in an array but now in a table with suboptions.
Again, 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.
The identifier option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.
Parameter
Name
Default
Notes
identifier
<empty>
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-<IDENTIFIER>.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
<empty>
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.
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.
Copy and change
You 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.
Create and import
You 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.
For 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:
@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:
hugo.
[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.
React 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.
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.
hugo.
[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.
hugo gen chromastyles --style=monokai > chroma-mycode.css
The file must be written to assets/css/chroma-<NAME>.css. To use it with your color variant, you have to modify --CODE-theme: <NAME> in the color variant stylesheet file.
@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.
This interactive tool may help you to generate your own color variant stylesheet.
To get started, first select a color variant from the variant selector in the lower left sidebar that fits you best as a starting point.
The graph is interactive and 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.
The 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.
To 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.
Once 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.
Once you are satisfied, you can download the new variants file and copy it into your site’s assets/css directory.
Option 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.
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.
hugo.
[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.
Option To hide the Home button on the left menu, set disableLandingPageButton=true.
hugo.
[params]disableLandingPageButton=true
params:disableLandingPageButton:true
{"params":{"disableLandingPageButton":true}}
Option To change its icon or text, configure the landingPageName for your defined languages.
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.
hugo.
[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.
Search
Configure Search
The theme offers three levels of search through the menu’s search form:
In-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.
Option All levels are enabled by default. Disable them in hugo.toml:
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.
Check for duplicate URLs by running hugo --printPathWarnings.
Supported 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
Czech
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.
hugo.
[params]additionalContentLanguage=['en']
params:additionalContentLanguage:- en
{"params":{"additionalContentLanguage":["en"]}}
You can add multiple languages to this array.
Note
Use the base language code. For example, if your page is using zh-CN, add zh to this parameter.
Shortcut Menu
The sidebar contains your content’s navigation menu, but you can also add extra menu entries or shortcuts in a separate section.
For internal links, use the pageRef property instead of url. Learn more about Hugo’s menu configuration.
Title
Option By default, the shortcut menu has a title ("More" in English).
You can disable this title with disableShortcutsTitle=true.
hugo.
[params]disableShortcutsTitle=true
params:disableShortcutsTitle:true
{"params":{"disableShortcutsTitle":true}}
To change the title, update your local i18n translation file.
[Shortcuts-Title]other="Other Great Stuff"
Single Language Example
Edit hugo.toml and add [[menu.shortcuts]] entries for each link:
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.
The theme adjusts the content width when you resize your browser.
If you want to change the chosen default width, you can add CSS variables to layouts/partials/custom-header.html.
Changing 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
For full width, use a large value like 1000rem.
<style>:root{--MAIN-WIDTH-MAX:1000rem;}</style>
Titles & Breadcrumbs
Breadcrumbs
Learn how to turn off the breadcrumbs completely and further configure the topbar.
Option 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.
Option 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.
Option 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.
Option You can override the default title separator by using titleSeparator='|'.
hugo.
[params]titleSeparator='|'
params:titleSeparator:'|'
{"params":{"titleSeparator":"|"}}
Headings
Headings can have anchor links that appear when you hover over them.
You 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.
Copy Anchor Links
Option Set disableAnchorCopy=true to prevent copying the anchor link when you click the icon.
hugo.
[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.
Hidden pages are created but not shown in the navigation. This is useful for pages you only want to access via a direct link.
When you visit a hidden page’s URL, it will appear in the navigation menu.
Hidden pages can also have hidden subpages, creating multiple levels of hiding.
By 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.
Hide from Search
Option To remove hidden pages from search results, use disableSearchHiddenPages=true.
hugo.
[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.
hugo.
[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.
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.
Customizable Partials
The Relearn theme allows you to customize various parts of the theme by overriding partials. This makes the theme highly configurable.
A good rule to follow: The less code a partial contains, the easier it will be to update the theme in the future.
Here’s a list of partials you can safely override:
layouts/partials/content.html: The main content of a page. Override this to display additonal page metadata.
layouts/partials/content-header.html: The header above the title. By default, it shows tags, but you can change this.
layouts/partials/content-footer.html: The footer below the content. By default, it shows author info, modification dates, and categories. You can customize this.
layouts/partials/custom-header.html: For adding custom CSS. Remember to include the style HTML tag.
layouts/partials/custom-footer.html: For adding custom JavaScript. Remember to include the script HTML tag.
layouts/partials/favicon.html: The favicon. You should definitely customize this.
layouts/partials/heading.html: the page’s title headings
layouts/partials/heading-pre.html: Add content before the page’s title headings. Remember to consider the headingPre front matter.
layouts/partials/heading-post.html: Add content after the page’s title headings. Remember to consider the headingPost front matter.
layouts/partials/logo.html: The logo in the top left corner. You should customize this.
layouts/partials/menu-pre.html: Add content before menu items. Remember to consider the menuPre front matter.
layouts/partials/menu-post.html: Add content after menu items. Remember to consider the menuPost front matter.
layouts/partials/menu-footer.html: The footer of the left menu.
You can override other partials from themes/hugo-relearn-themes/, but be careful as this might make future updates more difficult.
Extending Scripts
A common question is how to add extra CSS styles or JavaScript to your site. This depends on what you need.
Adding 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.
However, 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.
Custom 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.
For example, to create a shortcode called myshortcode that needs the jquery library:
Create the shortcode file layouts/shortcodes/myshortcode.html and add the folloging line somewhere:
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.
Image Effects
This page shows you, how to configure custom image effects on top of existing ones.
Nevertheless, 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.
Tip
All mentioned file names below can be clicked and show you the implementation for a better understanding.
Areas
The default configuration comes with three predefined areas that may contain an arbitrary set of buttons.
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.
Buttons
The theme ships with the following predefined buttons (from left to right in the screenshot):
sidebar: opens the sidebar flyout if in mobile layout
Not all buttons are displayed at every given time. This is configurable (see below if interested).
Redefining 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.
E.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.
The 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.
The theme distinguishes between two types of buttons:
button: 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:
s: (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:
show: 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.
For 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).
This parameter can have one of the following values:
disable: 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.
For displaying an area in the button’s overlay, see Area-Button.
Parameter
Name
Default
Notes
page
<empty>
Mandatory reference to the page.
class
<empty>
Mandatory unique class name for this button. Displaying two buttons with the same value for class is undefined.
href
<empty>
Either the destination URL for the button or JavaScript code to be executed on click.
- If starting with javascript: all following text will be executed in your browser - Every other string will be interpreted as URL - If empty, the button will be displayed in a disabled state regardless of its content
Defines what to do with the button if the content parameter was set but ends up empty:
- disable: The button is displayed in a disabled state. - hide: The button is removed.
onwidths
show
The action that should be executed if the site is displayed in the given width:
- show: 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.
onwidthm
show
See above.
onwidthl
show
See above.
hint
<empty>
Arbitrary text displayed in the tooltip.
title
<empty>
Arbitrary text for the button.
content
<empty>
Arbitrary HTML to put into the content overlay. This parameter may be empty. In this case, no overlay will be generated.
Call 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).
Parameter
Name
Default
Notes
page
<empty>
Mandatory reference to the page.
area
<empty>
Mandatory unique area name for this area. Displaying two areas with the same value for area is undefined.
Defines what to do with the button if the content overlay is empty:
- disable: The button is displayed in a disabled state. - hide: The button is removed.
onwidths
show
The action that should be executed if the site is displayed in the given width:
- show: 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.
onwidthm
show
See above.
onwidthl
show
See above.
hint
<empty>
Arbitrary text displayed in the tooltip.
title
<empty>
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).
Call these from your own redefined area templates if you want to use default button behavior.
The <varying> parameter values are different for each button and configured for standard behavior as seen on this page.
Parameter
Name
Default
Notes
page
<empty>
Mandatory reference to the page.
onwidths
<varying>
The action that should be executed if the site is displayed in the given width:
- show: 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.
Call these from your own redefined area templates if you want to use default button behavior utilizing overlay functionality.
The <varying> parameter values are different for each button and configured for standard behavior as seen on this page.
Parameter
Name
Default
Notes
page
<empty>
Mandatory reference to the page.
onempty
disable
Defines what to do with the button if the content overlay is empty:
- disable: The button is displayed in a disabled state. - hide: The button is removed.
onwidths
<varying>
The action that should be executed if the site is displayed in the given width:
- show: 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.
onwidthm
<varying>
See above.
onwidthl
<varying>
See above.
Page Designs
A page is displayed by exactly one page design. The Relearn theme offers the page designs home, chapter, and default.
A page design usually consists of
an archetype file: a template for creating new Markdown files with this design
If no type is set in your front matter, the page is treated as if type='default' was set.
Warning
Don’t use the type option in your modifications for other functionality!
All 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.
Using a Page Design
Regardless of shipped or custom page design, you are using them in the same way.
Creating a Page Designs
To make a custom page design:
Choose a name (for example, mydesign)
Create a content view file at layouts/mydesign/views/article.html
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:
Create 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:
layouts/_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
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.
[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# 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# 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# Hide heading above the shortcut menu.# Default: false# The title for the heading can be overwritten in your i18n files. See Hugo's# documentation how to do this.disableShortcutsTitle=false# 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#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++# 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 enginesdisableSeoHiddenPages=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: '>'# Changes the breadcrumb separator used in the topbars breadcrumb area and for# search results and term pages.breadcrumbSeparator='>'# 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: falseimageEffects.border=true# Default: trueimageEffects.lazy=true# Default: trueimageEffects.lightbox=true# Default: falseimageEffects.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/862disableDefaultRelref=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 < 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'
Chapter 3
Authoring
Learn how to create and organize your content pages.
If you are creating your Markdown files manually, you can achieve the same by just setting type='chapter' in the front matter.
Your resulting Markdown file needs to have at least the type front matter set to the value of the page design
+++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.
To create a home page, run the following command
hugo new --kind home _index.md
Chapter
A Chapter displays a page meant to be used as introduction for a set of child pages.
Commonly, it contains a title front matter and a short description in the content.
To create a chapter page, run the following command
hugo 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.
Default
A Default page is any other content page.
To create a default page, run either one of the following commands
All configurations options apply to all pages but can be changed in each page’s front matter.
Expand State of Nested Sections
OptionFront Matter You can change how the theme submenus appear with alwaysopen.
If 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.
The theme generates the expand state based on the following rules:
all parent entries of the active page including their visible siblings are shown regardless of any settings
immediate child entries of the active page 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
alwaysopen=false
alwaysopen:false
{"alwaysopen":false}
Expander for Nested Sections
OptionFront Matter Set collapsibleMenu=true to add an expander for submenus. This shows submenus as collapsible trees with a clickable expander.
collapsibleMenu=true
collapsibleMenu:true
{"collapsibleMenu":true}
Warning
Using this option may slow down your build process, especially with many pages.
We’ve seen builds taking 2 minutes with 1000+ pages, and over 30 minutes with 5000+ pages.
This happens because each new page affects all other pages, leading to exponentially longer build times.
Ordering Sibling Menu Entries
By Weight
Hugo provides a simple way to handle order for your pages by setting the weight front matter to a number.
+++title='My page'weight=5+++
---title:My pageweight:5---
{"title":"My page","weight":5}
By Other
OptionFront Matter 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.
ordersectionsby='linktitle'
ordersectionsby:linktitle
{"ordersectionsby":"linktitle"}
Custom Title for Menu Entries
By default, the Relearn theme will use a page’s title front matter for the menu entry.
Front Matter But a page’s title has to be descriptive on its own while the menu is a hierarchy. Use linkTitle to shorten the text of the menu entry.
For example for a page named install/linux.md
+++linkTitle='Linux'title='Install on Linux'+++
---linkTitle:Linuxtitle:Install on Linux---
{"linkTitle":"Linux","title":"Install on Linux"}
Add Icon to a Menu Entry
Front Matter In the page front matter, 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.
You may want to structure your pages in a hierarchical way but don’t want to generate pages for those sections? The theme got you covered.
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 show an expander.
For this, open content/first-chapter/first-page/_index.md and add the following front matter
OptionFront Matter By default, external links open in a new tab. To change this, use the externalLinkTarget setting with a proper link target.
For example, this will open links in the same tab
externalLinkTarget='_self'
externalLinkTarget:_self
{"externalLinkTarget":"_self"}
Enabling Link and Image Link Warnings
OptionFront 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.
If 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.
Please note that this can not resolve files inside of your static directory. The file must be a resource of the page or the site.
Link warnings are also available for the include and openapi shortcodes.
more: opens the overlay if screen space is limited
Table of Contents
OptionFront 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.
disableToc=true
disableToc:true
{"disableToc":true}
Breadcrumbs
OptionFront Matter Set disableBreadcrumb=true to hide the breadcrumb in the topbar.
OptionFront 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.
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 front matter.
OptionFront Matter You can hide the previous/next buttons by setting disableNextPrev=true. If the buttons are hidden, also the keyboard shortcuts are disabled.
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.
+++# 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=''# 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#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++# 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: falseimageEffects.border=true# Default: trueimageEffects.lazy=true# Default: trueimageEffects.lightbox=true# Default: falseimageEffects.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 < 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=''+++
Meta Information
Page Title
The title will be used in the heading and meta information of your HTML.
The description is used for generating HTML meta information, in the children shortcode and in social media meta information.
If 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.
+++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.
+++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.
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.
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.
Markdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it.
Some of the key benefits are:
Markdown 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:
The 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
Tip
Bookmark this page for easy future reference!
Standard 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:
HTML If the usage of HTML is allowed, the theme supports styling for further HTML elements.
Relearn Extension specific to this theme.
Paragraphs
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.
Any 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.
Lorem 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.
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.
Headings
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.
In 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.
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 ---.
Lorem 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.
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.
Blockquotes
Quotations
For quoting blocks of content from another source within your document add > before any text you want to quote.
Blockquotes can also be nested.
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.
>
> > 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.
>
> 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.
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.
Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
GitHub Alerts
GFM Since Hugo 0.132.0GitHub alerts are also supported. Please note, that coloring and icons of severities may defer between GitHub and this theme.
If you are in need of more advanced options to style your alerts, like icons, use the notice shortcode.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!INFO]
> Information that users <ins>_might_</ins> find interesting.
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
Result
Caution
Advises about risks or negative outcomes of certain actions.
Important
Key information users need to know to achieve their goal.
Info
Information that users might find interesting.
Note
Useful information that users should know, even when skimming content.
Tip
Helpful advice for doing things better or more easily.
Warning
Urgent info that needs immediate user attention to avoid problems.
Obsidian Callouts
Obsidian Since Hugo 0.134.0Obsidian callouts are also supported. Which enables configurable title text and expand/collapse.
If you are in need of more advanced options to style your alerts, like icons, use the notice shortcode.
> [!tip] Callouts can have custom titles
> Like this one.
> [!tip] Title-only callout
> [!note]- Are callouts foldable?
> Yes! In a foldable callout, the contents are hidden when the callout is collapsed
> [!note]+ Are callouts foldable?
> Yes! In a foldable callout, the contents are hidden when the callout is collapsed
Result
Callouts can have custom titles
Like this one.
Title-only callout
Yes! In a foldable callout, the contents are hidden when the callout is collapsed
Yes! In a foldable callout, the contents are hidden when the callout is collapsed
Text Markers
Bold
You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks **.
I am rendered with **bold text**
Result
I am rendered with bold text
Italics
You can emphasize a snippet of text with italics by enclosing it with underscores _.
I am rendered with _italicized text_
Result
I am rendered with italicized text
Marked Text
You can mark text in the predefined accent color of your stylesheet.
HTML You can also use it by configuring Hugo for usage of HTML.
The <ins>hot, new</ins> stuff
Result
The hot, new stuff
Deleted 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.
~~Strike through~~ this text
Result
Strike through this text
Special 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.
Double 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 `<<` or right `>>` are replaced by arrow **<<** and **>>** 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’.
Double dashes -- and triple dashes --- are replaced by en-dash – and em-dash — entities.
Double arrows pointing left << or right >> are replaced by arrow « and » entities.
Three consecutive dots ... are replaced by an ellipsis … entity.
Subscript and Superscript
You can also use subscript and superscript text. For more complex stuff, you can use the math shortcode.
HTML You can also use it by configuring Hugo for usage of HTML.
How many liters H<sub>2</sub>O fit into 1dm<sup>3</sup>?
Result
How many liters H2O fit into 1dm3?
Keyboard Shortcuts
HTML You can use the <kbd> element to style keyboard shortcuts.
Press <kbd>STRG</kbd><kbd>ALT</kbd><kbd>DEL</kbd> to end your shift early.
Result
Press STRGALTDEL to end your shift early.
Lists
Unordered
You can write a list of items in which the order of the items does not explicitly matter.
It is possible to nest lists by indenting an item for the next sublevel.
You may use any of -, * or + to denote bullets for each list item but should not switch between those symbols inside one whole list.
- 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.
It is possible to nest lists by indenting an item for the next sublevel.
Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.
1. 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
- [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.
A 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.
If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible
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.
: 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.
A telecommunication company.
You can’t make juice out of it.
Code
Inline Code
Inline snippets of code can be wrapped with backticks `.
In this example, `<div></div>` is marked as code.
Result
In this example, <div></div> is marked as code.
Indented Code Block
A simple code block can be generated by indenting several lines of code by at least two spaces.
Be 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:
// 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.
GFM 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.
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.
| 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.
| 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.
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.
[Example][somelinkID]
[somelinkID]: https://example.com "Go to example domain"
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.
Usually 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.
Footnotes 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.
That'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.
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.
![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.
Resizing
Add query parameter width and/or height to the link image to resize the image. Values are CSS values (default is auto).
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:
The default image effects shipped with the theme are
Name
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.
This 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.
Explicitly set URL query parameter will override the defaults set for a page or your site.
Without any settings in your hugo.tomlimageEffects defaults to
Hugo uses Markdown as its content format. However, there are a lot of things that Markdown doesn’t support well.
You 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.
To avoid Markdown’s limitations, Hugo created shortcodes. A shortcode is a simple snippet inside of a page.
The badge shortcode displays little markers in your text with adjustable color, title and icon.
ImportantVersion6.6.6Captain InfoNewAwesome
Usage
{{%badge%}}Important{{%/badge%}}{{%badgestyle="primary"title="Version"%}}6.6.6{{%/badge%}}{{%badgestyle="red"icon="angle-double-up"%}}Captain{{%/badge%}}{{%badgestyle="info"%}}New{{%/badge%}}{{%badgecolor="fuchsia"icon="fa-fw fab fa-hackerrank"%}}Awesome{{%/badge%}}
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.
Button
The button shortcode displays a clickable button with adjustable color, title and icon.
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.
- if starting with javascript: all following text will be executed in your browser - every other string will be interpreted as URL
style
transparent
The style scheme used for the button.
- by severity: caution, important, info, note, tip, warning - by brand color: primary, secondary, accent - by color: blue, cyan, green, grey, magenta, orange, red - by special color: default, transparent, code
The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.
- for severity styles: a nice matching color for the severity - 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.
- for severity styles: a nice matching icon for the severity - for all other styles: <empty>
If 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:
- the setting of externalLinkTarget or _blank if not set, for any address starting with http:// or https:// - 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
<content>
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.
- for severity styles: the matching title for the severity - for all other styles: <empty>
If you want no title for a severity style, you have to set this parameter to " " (a non empty string filled with spaces)
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.
- auto defaults to ordersectionsby of the page’s Front Matter or to ordersectionsby of the configuration Option or to weight - weight - title - linktitle - modifieddate - expirydate - publishdate - date - length - default adhering to Hugo’s default sort criteria
{{%expandtitle="Show me almost **endless** possibilities"%}}Youcanaddstandardmarkdownsyntax:-multipleparagraphs-bulletpointlists-_emphasized_,**bold**andeven**_boldemphasized_**text-[links](https://example.com)
-etc.```plaintext
...and even source code
```>thepossibilitiesareendless(almost-includingothershortcodesmayormaynotwork){{%/expand%}}
This shortcode is fully compatible with Hugo’s highlight shortcode but offers some extensions.
It is called interchangeably in the same way as Hugo’s own shortcode by providing positional parameter or simply by using Markdown codefences.
You 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.
Codefence syntax is widely available in other Markdown parsers like GitHub and therefore is the recommend syntax for generating portable Markdown.
The tab shortcode is also capable of displaying code but with limited options.
Parameter
Name
Position
Default
Notes
type
1
<empty>
The language of the code to highlight. Choose from one of the supported languages. Case-insensitive.
title
<empty>
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.
The default value can be set in your hugo.toml and overwritten via front matter. See below.
options
2
<empty>
An optional, comma-separated list of zero or more Hugo supported options as well as extension parameter from this table.
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.
Examples
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.
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 credits667print("Hello")668print(" ")669print("World")670print("!")
Markdown Codefence with Title
```py { title="python" }
# a bit shorter
print("Hello World!")
```
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.
Once 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.
Customising Icons
Font Awesome provides many ways to modify the icon
Change color (by default the icon will inherit the parent color)
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 <i> HTML into markup, and Font Awesome will load the relevant icon.
Built with <iclass="fas fa-heart"></i> by Relearn and Hugo
Built with by Relearn and Hugo
To use these native HTML elements in your Markdown, add this in your hugo.toml:
[markup.goldmark.renderer]unsafe=true
Include
The include shortcode includes other pages, resources or files from your project.
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
OptionFront Matter You can use include.errorlevel to control what should happen if a local link can not be resolved to a resource.
If 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.
Please note that this can not resolve files inside of your static directory. The file must be a resource of the page or the site.
the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)
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” ↩︎
Math
If this is not enough, the math shortcode helps you rendering math and chemical formulae using the MathJax library.
You can also use pure Markdown for writing simple math expressions.
Passthrough 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.
Parameter
Name
Default
Notes
align
center
The vertical alignment.
Allowed values are left, center or right.
<content>
<empty>
Your formulae.
Settings
Providing Initialization Options for the MathJax Library
OptionFront Matter The MathJax library is configured with default settings for initialization.
You can overwrite the settings by providing a JSON object in mathJaxInitialize. See MathJax’s documentation for all allowed settings.
Keep in mind that initialization settings of your pages front matter overwrite all settings of your configuration options.
Loading an External Version of the MathJax Library
OptionFront Matter The theme uses the shipped MathJax library by default.
In 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.
OptionFront Matter The MathJax library will be loaded if the page contains a math shortcode or codefence.
You 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.
Instead of math=true you can also use the alias math.force=true.
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
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.
See the example on how a passthrough configurations makes using math really easy.
Examples
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.
In 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.
In passthrough default configuration, block math is generated if you use two consecutive $$ as a delimiter around your formulae.
$$\left|
\begin{array}{cc}
a & b \\
c & d
\end{array}\right|$$
$$\left|
\begin{array}{cc}
a & b \\
c & d
\end{array}\right|$$
Passthrough Inline Math
The same usage restrictions as of the previous example apply here as well.
In passthrough default configuration, inline math is generated if you use a single $ as a delimiter around your formulae.
Euclid already knew, $\sqrt{2}$ is irrational.
Euclid already knew, $\sqrt{2}$ is irrational.
Codefence 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.
{{partial"shortcodes/mermaid.html"(dict"page"."content""graph LR;\n If --> Then\n Then --> 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.
Parameter
Name
Default
Notes
align
center
The vertical alignment.
Allowed values are left, center or right.
zoom
see notes
Whether the graph is pan- and zoomable.
If 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.
- false: no pan or zoom - true: pan and zoom active
<content>
<empty>
Your Mermaid graph.
Settings
Configuring Pan and Zoom
OptionFront Matter The generated graphs can be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.
By default this is disabled. Set mermaidZoom=true to enable it.
Individual settings of a graphs zoom parameter have precedence over the page’s front matter and configuration options in that order.
mermaidZoom=true
mermaidZoom:true
{"mermaidZoom":true}
Providing Initialization Options for the Mermaid Library
OptionFront Matter The Mermaid library is configured with default settings for initialization.
You can overwrite the settings by providing a JSON object in mermaidInitialize. See Mermaid’s documentation for all allowed settings.
Keep in mind that initialization settings of your pages front matter overwrite all settings of your configuration options.
In 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.
Loading an External Version of the Mermaid Library
OptionFront Matter The theme uses the shipped Mermaid library by default.
In 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.
OptionFront Matter The Mermaid library will be loaded if the page contains an mermaid shortcode or codefence.
You 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.
[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.
Examples
Flowchart with YAML-Title
```mermaid
---
title: Example Diagram
---
graph LR;
A[Hard edge] -->|Link text| B(Round edge)
B --> C{<strong>Decision</strong>}
C -->|One| D[Result one]
C -->|Two| E[Result two]
```
---
title: Example Diagram
---
graph LR;
A[Hard edge] -->|Link text| B(Round edge)
B --> C{<strong>Decision</strong>}
C -->|One| D[Result one]
C -->|Two| E[Result two]
Sequence Diagram with Configuration Directive
```mermaid
%%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%%
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
```
%%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%%
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
Class Diagram
```mermaid
classDiagram
Animal <|-- Duck
Animal <|-- Fish
Animal <|-- 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 <|-- Duck
Animal <|-- Fish
Animal <|-- 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
stateDiagram-v2
open: Open Door
closed: Closed Door
locked: Locked Door
open --> closed: Close
closed --> locked: Lock
locked --> closed: Unlock
closed --> 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 --> High Reach
y-axis Low Engagement --> 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 --> High Reach
y-axis Low Engagement --> 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 -> test_req
```
requirementDiagram
requirement test_req {
id: 1
text: the test text.
risk: high
verifymethod: test
}
element test_entity {
type: simulation
}
test_entity - satisfies -> test_req
```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, <br/> 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, <br/> 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<br/>and 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<br/>and 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
```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 --> 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 --> 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<[" "]>(down)
block:ID
A
B["A wide one in the middle"]
C
end
space
D
ID --> D
C --> D
style B fill:#969,stroke:#333,stroke-width:4px
```
block-beta
columns 1
db(("DB"))
blockArrowId6<[" "]>(down)
block:ID
A
B["A wide one in the middle"]
C
end
space
D
ID --> D
C --> D
style B fill:#969,stroke:#333,stroke-width:4px
```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
Notice
The notice shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page.
There may be pirates
It is all about the boxes.
Usage
> [!primary] There may be pirates
> It is all about the boxes.
{{%noticestyle="primary"title="There may be pirates"icon="skull-crossbones"%}}Itisallabouttheboxes.{{%/notice%}}
{{%noticeprimary"There may be pirates""skull-crossbones"%}}Itisallabouttheboxes.{{%/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.
If you want to display a transparent expandable box without any border, you can also use the expand shortcode.
Parameter
Name
Position
Default
Notes
style
1
default
The style scheme used for the box.
- by severity: caution, important, info, note, tip, warning - by brand color: primary, secondary, accent - by color: blue, cyan, green, grey, magenta, orange, red - by special color: default, transparent, code
The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.
- for severity styles: a nice matching color for the severity - for all other styles: the corresponding color
This 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.
- for severity styles: the matching title for the severity - for all other styles: <empty>
If 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.
- for severity styles: a nice matching icon for the severity - for all other styles: <empty>
If you want no icon for a severity style, you have to set this parameter to " " (a non empty string filled with spaces)
This is not available using callout syntax.
expanded
<empty>
Whether to draw an expander and how the content is displayed.
- <empty>: no expander is drawn and the content is permanently shown - true: the expander is drawn and the content is initially shown - false: the expander is drawn and the content is initially hidden
<content>
<empty>
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.
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.
You can also redefine the predefined styles if you’re not satisfied with the default values.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!INFO]
> Information that users <ins>_might_</ins> find interesting.
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
Caution
Advises about risks or negative outcomes of certain actions.
Important
Key information users need to know to achieve their goal.
Info
Information that users might find interesting.
Note
Useful information that users should know, even when skimming content.
Tip
Helpful advice for doing things better or more easily.
Warning
Urgent info that needs immediate user attention to avoid problems.
With User-Defined Color, Font Awesome Brand Icon and Markdown in Title and Content
{{%noticecolor="fuchsia"title="**Hugo** is _awesome_"icon="fa-fw fab fa-hackerrank"%}}Youcanaddstandardmarkdownsyntax:-multipleparagraphs-bulletpointlists-_emphasized_,**bold**andeven**_boldemphasized_**text-[links](https://example.com)
-etc.[^etc][^etc]:EtCetera(English:/ɛtˈsɛtərə/),abbreviatedtoetc.,etc,etcet.,isaLatinexpressionthatisusedinEnglishtomean"and other similar things",or"and so forth"```plaintext
...and even source code
```>thepossibilitiesareendless(almost-includingothershortcodesmayormaynotwork)(almost-includingothershortcodesmayormaynotwork){{%/notice%}}
the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)
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” ↩︎
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.
Instead, 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.
Parameter
Name
Default
Notes
src
<empty>
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
OptionFront Matter You can use openapi.errorlevel to control what should happen if a local OpenAPI specification link can not be resolved to a resource.
If 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.
Please note that this can not resolve files inside of your static directory. The file must be a resource of the page or the site.
Loading an External Version of the Swagger UI Library
OptionFront Matter The theme uses the shipped Swagger UI library by default.
In 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.
OptionFront Matter The Swagger UI library will be loaded if the page contains an openapi shortcode or codefence.
You 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.
[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.
Example
Using Local File
{{<openapisrc="petstore.json">}}
Resources
The resources shortcode displays links to resources contained in a page bundle.
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.
Parameter
Name
Default
Notes
style
transparent
The style scheme used for the box.
- by severity: caution, important, info, note, tip, warning - by brand color: primary, secondary, accent - by color: blue, cyan, green, grey, magenta, orange, red - by special color: default, transparent, code
The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.
- for severity styles: a nice matching color for the severity - 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.
- for severity styles: the matching title for the severity - for all other styles: Resources
If 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.
- for severity styles: a nice matching icon for the severity - for all other styles: paperclip
If you want no icon, you have to set this parameter to " " (a non empty string filled with spaces)
expanded
<empty>
Whether to draw an expander and how the resource list is displayed.
- <empty>: no expander is drawn and the resource list is permanently shown - true: the expander is drawn and the resource list is initially shown - false: the expander is drawn and the resource list is initially hidden
sort
asc
Sorting the output in ascending or descending order.
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.
SiteParam
The siteparam shortcode prints values of params contained in your hugo.toml.
If you want multiple tabs grouped together you can wrap your tabs into the tabs shortcode.
If you want further options when using a single code tab, you can also use the highlight shortcode.
Parameter
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.
- by severity: caution, important, info, note, tip, warning - by brand color: primary, secondary, accent - by color: blue, cyan, green, grey, magenta, orange, red - by special color: default, transparent, code
A tab can not only contain code but arbitrary text. In this case text and code will get a margin.
printf("Hello World!");
Understanding style and color Behavior
The style parameter affects how the color parameter is applied.
{{<tabs>}}{{%tabtitle="just colored style"style="blue"%}}The`style`parameterissettoacolorstyle.Thiswillsetthebackgroundtoalighterversionofthechosenstylecolorasconfiguredinyourthemevariant.{{%/tab%}}{{%tabtitle="just color"color="blue"%}}Onlythe`color`parameterisset.ThiswillsetthebackgroundtoalighterversionofthechosenCSScolorvalue.{{%/tab%}}{{%tabtitle="default style and color"style="default"color="blue"%}}The`style`parameteraffectshowthe`color`parameterisapplied.The`default`stylewillsetthebackgroundtoyour`--MAIN-BG-color`asconfiguredforyourthemevariantresemblingthedefaultstylebutwithdifferentcolor.{{%/tab%}}{{%tabtitle="just severity style"style="info"%}}The`style`parameterissettoaseveritystyle.Thiswillsetthebackgroundtoalighterversionofthechosenstylecolorasconfiguredinyourthemevariantandalsoaffectsthechosenicon.{{%/tab%}}{{%tabtitle="severity style and color"style="info"color="blue"%}}The`style`parameteraffectshowthe`color`parameterisapplied.ThiswillsetthebackgroundtoalighterversionofthechosenCSScolorvalueandalsoaffectsthechosenicon.{{%/tab%}}{{</tabs>}}
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.
Only the color parameter is set.
This will set the background to a lighter version of the chosen CSS color value.
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.
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.
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.
Tabs
The tabs shortcode displays arbitrary content in an unlimited number of tabs.
If you just want a single tab you can instead call the tab shortcode standalone.
Also follow the above link to see the parameter for a nested tab.
Parameter
Name
Default
Notes
groupid
<random>
Arbitrary name of the group the tab view belongs to.
Tab 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.
This sychronization applies to the whole site!
style
<empty>
Sets a default value for every contained tab. Can be overridden by each tab. See the tab shortcode for possible values.
color
<empty>
Sets a default value for every contained tab. Can be overridden by each tab. See the tab shortcode for possible values.
In case you want to nest tab views, the parent tab that contains nested tab views needs to be declared with {{< tab >}} instead of {{% tab %}}. Note, that in this case it is not possible to put markdown in the parent tab.
You can also set style and color parameter for all tabs and overwrite them on tab level. See the tab shortcode for possible values.
