# Hugo Relearn Theme
Documentation for Hugo Relearn Theme
Author: Sören Weber

The Relearn theme is a theme for Hugo, a static website generator written in Go. Where Hugo is often used for blogs, this theme is designed with documentation in mind.

Info

The theme is a fork of the great Learn theme with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.

## Features

Tip

See What’s New within the latest update.

- Usable offline, no external dependencies
- Usable without a HTTP server from the file system
- Support for Internet Explorer 11
- Responsive design
- Configurable hidden pages
- Automatic next/prev buttons to navigate through menu entries
- Automatic Search
- Dedicated search page
- Support for GFM (GitHub Flavored Markdown)
- Print whole chapters or even the complete site
- Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, Finnish, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
- Support for languages written right to left
- Unrestricted menu configuration relating to amount of items and level of nesting
- Font Awesome icons
- Tagging support
- Image styling like sizing, shadow, border and alignment
- Syntax highlighting
- Customizable look and feel
- Predefined (light, dark) and customizable color variants
- Automatic switch for light/dark mode dependend on your OS settings
- Attachments files
- List child pages
- Math and chemical formulae using the MathJax library
- Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.
- Swagger UI for OpenAPI Specifications
- Badges
- Buttons
- Tip/Note/Info/Warning boxes
- Expand
- Tabs
- File inclusion

## Getting Support

To get support, feel free to open a new discussion topic or issue report in the official repository on GitHub.

## Become a Contributor

Feel free to update this documentation by just clicking the
button displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.

You are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the official repository via GitHub. Please visit the contribution guidelines first.

## License

This theme is licensed under the MIT License.

## Credits

This theme would not be possible without the work of many others. See the credits for a detailed list.

# Subsections of Hugo Relearn Theme

Chapter 1

# Basics

Discover what this Hugo theme is all about and the core-concepts behind it.

# Subsections of Basics

# What's New

This document shows you what’s new in the latest release. For a detailed list of changes, see the history page.

0.95.0 The minimum required Hugo version.

Breaking A change that requires action by you after upgrading to assure the site is still functional.

Change A change in default behavior that may requires action by you if you want to revert it.

New Marks new behavior you might find interesting or comes configurable.

## 5.11.0 (2023-02-06)

- Change The theme removed the popular jQuery library from its distribution.

  In case you made changes to the theme that are dependend 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:

      <script src="{{"js/jquery.min.js"| relURL}}{{ if $assetBusting }}?{{ now.Unix }}{{ end }}" defer></script>

- Change Mermaid diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.

  The default setting of `on`, in effect since 1.1.0, changed back to `off` as there was interference with scrolling on mobile and big pages.

- Change The theme is now capable to visually adapt to your OS’s light/dark mode setting.

  This is also the new default setting if you haven’t configured `themeVariant` in your `config.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 Translation for Czech. This language is not supported for search.

- New GitHub releases are also now tagged for the main version (eg. `1.2.x`), major version (eg. `1.x`) and the latest (just `x`) release making it easier for you to pin the theme to a certain version.

## 5.10.0 (2023-01-25)

- New 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)

- Change The required folder 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 unnessessary 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 compatiblity.

- 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 `config.toml`.

- New The theme now supports Hugo’s module system.

## 5.8.0 (2022-12-08)

- 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 highlightning 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 The Korean language translation for this theme is now available with the language code `ko`. Formerly the country code `kr` was used instead.

- 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 This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning thru large number of results.

  To activate this feature, you need to configure it in your `config.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 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 `config.toml` make sure to set Hugo’s `disableHugoGeneratorInject=true` and also `[params] disableGeneratorVersion=true`, otherwise Hugo will generate a meta tag into your home page automagically.

- New Creation of your project gets a little bit faster with this release.

  This addresses increased build time with the 5.x 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 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.

  Old | New
  --- | ---
  `<img src="pic.png?width=20vw&classes=shadow,border">` | `<img src="pic.png" style="width:20vw;" class="shadow border">`

## 5.4.0 (2022-11-01)

- Change With the proper settings in your `config.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 homepage in your `config.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 The `math` shortcode and `mermaid` shortcode now also support the `align` parameter if codefence syntax is used.

- 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 for Finnish (Suomi).

## 5.3.0 (2022-10-07)

- 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 Image 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 If you’ve set `collapsibleMenu = true` in your `config.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)

- 0.95.0 This release requires a newer Hugo version.

- 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 `config.toml`to:

      [outputFormats]
        [outputFormats.PRINT]
          name= "PRINT"
          baseName = "index"
          path = "_print"
          isHTML = true
          mediaType = 'text/html'
          permalinkable = false

## 5.0.0 (2022-07-05)

- 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.

      <script defer src="myscript.js"></script>

- 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 frontmatter parameter `archetype = "home"` and remove the leading heading

  - for all files containing the deprecated frontmatter parameter `chapter = true`, replace it with `archetype = "chapter"` and remove the leading headings

- Change The frontmatter 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 Adding new partials `heading-pre.html` / `heading-post.html` and according frontmatter 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.

## 4.2.0 (2022-06-23)

- 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 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 `config.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.

- New All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.

## 4.1.0 (2022-06-12)

- New While fixing issues with the search functionality for non Latin languages, you can now configure to have multiple languages on a single page.

## 4.0.0 (2022-06-05)

- Breaking 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 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.

  This applies to `expand`, `include`, `notice` and `siteparam`.

- 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 for Polish. This language is not supported for search.

- New The documentation for all shortcodes were revised.

## 3.4.0 (2022-04-03)

- 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 If you prefer expandable/collapsible menu items, you can now set `collapsibleMenu=true` in your `config.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 `config.toml` to add the capability to print whole chapters or even the complete site.

- New Translation for Traditional Chinese.

## 3.3.0 (2022-03-28)

- 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)

- 0.93.0 This release requires a newer Hugo version.

- Change In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Mermaid codefences. This changes the behavior of `disableMermaid` config option as follows: If a Mermaid shortcode or 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 codefence is involved and the library is not loaded by default. In this case you can set `disableMermaid=false` in your frontmatter to force the library to be loaded. See the theme variant generator of the exampleSite for an example.

- New Additional color variant variable `--MERMAID-theme` to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant.

## 3.1.0 (2022-03-15)

- New `attachment` and `notice` shortcodes have a new parameter to override the default icon. Allowed values are all Font Awesome 5 Free icons.

## 3.0.0 (2022-02-22)

- Breaking We made changes to the menu footer. If you have your `menu-footer.html` partial overridden, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the `menu-footer.html` partial that is coming with the exampleSite.

  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 `config.toml`. If you still want to use the Learn color variant, you have to explicitly set `themeVariant="learn"` in your `config.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 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 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 `config.toml`. In this case, the first variant is the default chosen on first view and a variant switch will be shown in the menu footer. See the documentation for configuration.

  Note, that the new variant switch will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant switcher will not be displayed with Internet Explorer 11.

## 2.9.0 (2021-11-19)

- Breaking This release removes the themes implementation of `ref`/`relref` in favor for Hugos 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 | `basics/configuration/_index.md` | `basics/configuration`
  Leaf bundle | `basics/configuration/index.md` | `basics/configuration`
  Page | `basics/configuration.md` | `basics/configuration`

  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 Hugos 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 Hugos 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 "basics/configuration/_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:

  1. 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. Start up a text editor with regular expression support for search and replace. Apply the following conversions in the given order on all `*.md` files. This is the recommended choice.

  Type | Search | Replace by
  --- | --- | ---
  Branch bundle | `(ref\s+"[^"]*)/_index\.md"` | `$1"`
  Leaf bundle | `(ref\s+"[^"]*)/index\.md"` | `$1"`
  Page | `(ref\s+"[^"]*)\.md"` | `$1"`

## 2.8.0 (2021-11-03)

- 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 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 `config.toml`. For an example see the example configuration.

## 2.7.0 (2021-10-24)

- New Optional second parameter for `notice` shortcode to set title in box header.

## 2.6.0 (2021-10-21)

- New Your site can now be served from a subfolder if you set `baseURL` and `canonifyURLs=true` in your `config.toml`. See the documentation for a detailed example.

## 2.5.0 (2021-10-08)

- Change New colors `--CODE-BLOCK-color` and `--CODE-BLOCK-BG-color` were added to provide a fallback for Hugos syntax highlighting in case `guessSyntax=true` is set. Ideally the colors are set to the same values as the ones from your chosen chroma style.

## 2.4.0 (2021-10-07)

- 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 Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting `disableTagHiddenPages=true` in your `config.toml`.

- New You can define the expansion state of your menus for the whole site by setting the `alwaysopen` option in your `config.toml`. Please see further documentation for possible values and default behavior.

- New New frontmatter `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)

- 0.81.0 This release requires a newer Hugo version.

- 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 Pirates one due to maintenance constraints.

## 2.2.0 (2021-09-09)

- 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 `config.toml`.

## 2.1.0 (2021-09-07)

- 0.69.0 This release requires a newer Hugo version.

- 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 Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting `disableSearchHiddenPages=true` in your `config.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 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 You can define the expansion state of your menus in the frontmatter. 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.

## 1.2.0 (2021-07-26)

- New Shortcode `expand` with new parameter to open on page load.

## 1.1.0 (2021-07-02)

- Breaking Mermaid diagrams can now be panned and zoomed. This isn’t configurable yet.

- New `Mermaid` config options can be set in `config.toml`.

## 1.0.0 (2021-07-01)

- 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 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.

# Requirements

Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.

Just download at least version 0.95.0 of the Hugo binary for your OS (Windows, Linux, Mac).

# Installation

The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this great documentation for beginners.

## Create your project

Hugo provides a `new` command to create a new website.

    hugo new site <new_project>

## Install the theme

Install the Relearn theme by following this documentation using Hugo’s module system.

This theme’s repository is: https://github.com/McShelby/hugo-theme-relearn.git

Alternatively, you can download the theme as .zip file and extract it in the `themes` directory

### From Git

If you install the theme from your git repository or GitHub, you have several options.

If you use the `head` of the `main` branch, you are using the development version. Usually it is fully functional but can break from time to time. We try to fix newly introduced bugs in this version as soon as possible.

Additionally you can checkout one of the tagged versions. These tagged versions correspond to an official releases from the GitHub repository.

Besides the usual version tags (eg `1.2.3`) there are also tags for the main version (eg. `1.2.x`), major version (eg. `1.x`) and the latest (just `x`) released version making it easier for you to pin the theme to a certain version.

## Basic configuration

When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`config.toml`) and set the theme as the default. You can also add the `[outputs]` section to enable the search functionality.

    # Change the default theme to be use when building the site with Hugo
    theme = "hugo-theme-relearn"

    # For search functionality
    [outputs]
    home = [ "HTML", "RSS", "SEARCH"]

## Create your first chapter page

Chapters are pages that contain other child pages. It has a special layout style and usually just contains a chapter name, the title and a brief abstract of the section.

    ### Chapter 1

    # Basics

    Discover what this Hugo theme is all about and the core concepts behind it.

renders as

The Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command

    hugo new --kind chapter basics/_index.md

By opening the given file, you should see the property `chapter=true` on top, meaning this page is a chapter.

By default all chapters and pages are created as a draft. If you want to render these pages, remove the property `draft: true` from the metadata.

## Create your first content pages

Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:

    hugo new basics/first-content.md
    hugo new basics/second-content/_index.md

Feel free to edit those files by adding some sample content and replacing the `title` value in the beginning of the files.

## Launching the website locally

Launch by using the following command:

    hugo serve

Go to `http://localhost:1313`

You should notice three things:

1. You have a left-side Basics menu, containing two submenus with names equal to the `title` properties in the previously created files.
2. The home page explains how to customize it by following the instructions.
3. When you run `hugo serve`, when the contents of the files change, the page automatically refreshes with the changes. Neat!

## Build the website

When your site is ready to deploy, run the following command:

    hugo

A `public` folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.

Note

This website can be automatically published and hosted with Netlify (Read more about Automated HUGO deployments with Netlify). Alternatively, you can use GitHub pages.

# Configuration

## Global site parameters

On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your `config.toml` (here, values are default).

Note that some of these parameters are explained in details in other sections of this documentation.

    [params]
      # This controls whether submenus will be expanded (true), or collapsed (false) in the
      # menu; if no setting is given, the first menu level is set to false, all others to true;
      # this can be overridden in the pages frontmatter
      alwaysopen = true
      # Prefix URL to edit current page. Will display an "Edit" button on top right hand corner of every page.
      # Useful to give opportunity to people to create merge request for your doc.
      # See the config.toml file from this documentation site to have an example.
      editURL = ""
      # Author of the site, will be used in meta information
      author = ""
      # Description of the site, will be used in meta information
      description = ""
      # Shows a checkmark for visited pages on the menu
      showVisitedLinks = false
      # Disable search function. It will hide search bar
      disableSearch = false
      # Disable search in hidden pages, otherwise they will be shown in search box
      disableSearchHiddenPages = false
      # Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines
      disableSeoHiddenPages = false
      # Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden
      disableTagHiddenPages = false
      # Javascript and CSS cache are automatically busted when new version of site is generated.
      # Set this to true to disable this behavior (some proxies don't handle well this optimization)
      disableAssetsBusting = false
      # Set this to true if you want to disable generation for generator version meta tags of hugo and the theme;
      # don't forget to also set Hugo's disableHugoGeneratorInject=true, otherwise it will generate a meta tag into your home page
      disableGeneratorVersion = false
      # Set this to true to disable copy-to-clipboard button for inline code.
      disableInlineCopyToClipBoard = false
      # A title for shortcuts in menu is set by default. Set this to true to disable it.
      disableShortcutsTitle = false
      # If set to false, a Home button will appear below the search bar on the menu.
      # It is redirecting to the landing page of the current language if specified. (Default is "/")
      disableLandingPageButton = true
      # When using mulitlingual website, disable the switch language button.
      disableLanguageSwitchingButton = false
      # Hide breadcrumbs in the header and only show the current page title
      disableBreadcrumb = true
      # If set to true, hide table of contents menu in the header of all pages
      disableToc = false
      # If set to false, load the MathJax module on every page regardless if a MathJax shortcode is present
      disableMathJax = false
      # Specifies the remote location of the MathJax js
      customMathJaxURL = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
      # Initialization parameter for MathJax, see MathJax documentation
      mathJaxInitialize = "{}"
      # If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present
      disableMermaid = false
      # Specifies the remote location of the Mermaid js
      customMermaidURL = "https://unpkg.com/mermaid/dist/mermaid.min.js"
      # Initialization parameter for Mermaid, see Mermaid documentation
      mermaidInitialize = "{ \"theme\": \"default\" }"
      # If set to false, load the Swagger module on every page regardless if a Swagger shortcode is present
      disableSwagger = false
      # Specifies the remote location of the RapiDoc js
      customSwaggerURL = "https://unpkg.com/rapidoc/dist/rapidoc-min.js"
      # Initialization parameter for Swagger, see RapiDoc documentation
      swaggerInitialize = "{ \"theme\": \"light\" }"
      # Hide Next and Previous page buttons normally displayed full height beside content
      disableNextPrev = true
      # Order sections in menu by "weight" or "title". Default to "weight";
      # this can be overridden in the pages frontmatter
      ordersectionsby = "weight"
      # Change default color scheme with a variant one. Eg. can be "auto", "red", "blue", "green" or an array like [ "blue", "green" ].
      themeVariant = "auto"
      # Change the title separator. Default to "::".
      titleSeparator = "-"
      # If set to true, the menu in the sidebar will be displayed in a collapsible tree view. Although the functionality works with old browsers (IE11), the display of the expander icons is limited to modern browsers
      collapsibleMenu = false
      # If a single page can contain content in multiple languages, add those here
      additionalContentLanguage = [ "en" ]
      # If set to true, no index.html will be appended to prettyURLs; this will cause pages not
      # to be servable from the file system
      disableExplicitIndexURLs = false
      # For external links you can define how they are opened in your browser; this setting will only be applied to the content area but not the shortcut menu
      externalLinkTarget = "_blank"

## Serving your page from a subfolder

If your site is served from a subfolder, eg. `https://example.com/mysite/`, you have to set the following lines to your `config.toml`

    baseURL = "https://example.com/mysite/"
    canonifyURLs = true
    relativeURLs = true

Without `canonifyURLs=true` URLs in sublemental pages (like `sitemap.xml`, `rss.xml`) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.

## Serving your page from the filesystem

If you want your page served from the filesystem by using URLs starting with `file://` you’ll need the following configuration in your `config.toml`:

    relativeURLs = true

The theme will append an additional `index.html` to all branch bundle links by default to make the page be servable from the file system. If you don’t care about the file system and only serve your page via a webserver you can also generate the links without this change by adding this to your `config.toml`

    [params]
      disableExplicitIndexURLs = true

Note

If you want to use the search feature from the file system using an older installation of the theme make sure to change your outputformat for the homepage from the now deprecated `JSON` to `SEARCH` as seen below.

## Activate search

If not already present, add the following lines in the same `config.toml` file.

    [outputs]
      home = ["HTML", "RSS", "SEARCH"]

This will generate a search index file at the root of your public folder ready to be consumed by the Lunr search library. Note that the `SEARCH` outputformat was named `JSON` in previous releases but was implemented differently. Although `JSON` still works, it is now deprecated.

### Activate dedicated search page

You can add a dedicated search page for your page by adding the `SEARCHPAGE` outputformat to your home page by adding the following lines in your `config.toml` file.

    [outputs]
      home = ["HTML", "RSS", "SEARCH", "SEARCHPAGE"]

You can access this page by either clicking on the magnifier glass or by typing some search term and pressing `ENTER` inside of the menu’s search box .

## Activate print support

You can activate print support to add the capability to print whole chapters or even the complete site. Just add the `PRINT` output format to your home, section and page in your `config.toml` as seen below:

    [outputs]
      home = ["HTML", "RSS", "PRINT", "SEARCH"]
      section = ["HTML", "RSS", "PRINT"]
      page = ["HTML", "RSS", "PRINT"]

This will add a little printer icon in the top bar. It will switch the page to print preview when clicked. You can then send this page to the printer by using your browser’s usual print functionality.

Note

The resulting URL will not be configured ugly in terms of Hugo’s URL handling even if you’ve set `uglyURLs=true` in your `config.toml`. This is due to the fact that for one mime type only one suffix can be configured.

Nevertheless, if you’re unhappy with the resulting URLs you can manually redefine `outputFormats.PRINT` in your own `config.toml` to your liking.

## MathJax

The MathJax configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Math for additional documentation.

### Example

MathJax is globally disabled. By default it won’t be loaded by any page.

On page “Physics” you coded some JavaScript for a dynamic formulae. You can set the MathJax parameters locally to load mathJax on this page.

You also can disable MathJax for specific pages while globally enabled.

## Mermaid

The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Mermaid for additional documentation.

### Example

Mermaid is globally disabled. By default it won’t be loaded by any page.

On page “Architecture” you coded some JavaScript to dynamically generate a class diagram. You can set the Mermaid parameters locally to load mermaid on this page.

You also can disable Mermaid for specific pages while globally enabled.

## Home Button Configuration

If the `disableLandingPageButton` option is set to `false`, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure two parameters for the defined languages:

    [Languages]
    [Languages.en]
    ...
    landingPageName = "<i class='fas fa-home'></i> Home"
    ...
    [Languages.pir]
    ...
    landingPageName = "<i class='fas fa-home'></i> Arrr! Homme"
    ...

If those params are not configured for a specific language, they will get their default values:

    landingPageName = "<i class='fas fa-home'></i> Home"

The home button is going to look like this:

# Customization

The Relearn theme has been built to be as configurable as possible by defining multiple partials

In `themes/hugo-theme-relearn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the `layouts/partials` folder of your local project. This partial will have the priority.

This theme defines the following partials :

- `header.html`: the header of the page. See output-formats
- `footer.html`: the footer of the page. See output-formats
- `body.html`: the body of the page. The body may contain of one or many articles. See output-formats
- `article.html`: the output for a single article, can contain elements around your content. See output-formats
- `menu.html`: left menu. Not meant to be overwritten
- `search.html`: search box. Not meant to be overwritten
- `custom-header.html`: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include `style` HTML tag directive in your file.
- `custom-footer.html`: custom footer in page. Meant to be overwritten when adding JavaScript. Don’t forget to include `javascript` HTML tag directive in your file.
- `favicon.html`: the favicon
- `heading-pre.html`: side-wide configuration to prepend to pages title headings. If you override this, it is your responsibility to take the page’s `headingPre` setting into account.
- `heading-post.html`: side-wide configuration to append to pages title headings. If you override this, it is your responsibility to take the page’s `headingPost` setting into account.
- `logo.html`: the logo, on top left hand corner
- `meta.html`: HTML meta tags, if you want to change default behavior
- `menu-pre.html`: side-wide configuration to prepend to menu items. If you override this, it is your responsibility to take the page’s `menuPre` setting into account.
- `menu-post.html`: side-wide configuration to append to menu items. If you override this, it is your responsibility to take the page’s `menuPost` setting into account.
- `menu-footer.html`: footer of the the left menu
- `toc.html`: table of contents
- `content.html`: the content page itself. This can be overridden if you want to display page’s meta data above or below the content.
- `content-footer`: footer below the content, has a default implementation but you can overwrite it if you don’t like it.

## Change the logo

Create a new file in `layouts/partials/` named `logo.html`. Then write any HTML you want. You could use an `img` HTML tag and reference an image created under the static folder, or you could paste a SVG definition!

Note

The size of the logo will adapt automatically

## Change the favicon

If your favicon is a SVG, PNG or ICO, just drop off your image in your local `static/images/` folder and name it `favicon.svg`, `favicon.png` or `favicon.ico` respectively.

If no favicon file is found, the theme will lookup 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 in `layouts/partials/` named `favicon.html`. Then write something like this:

    <link rel="icon" href="/images/favicon.bmp" type="image/bmp">

## Change the colors

The Relearn theme lets you choose between some predefined color variants in light or dark mode, but feel free to add one yourself!

You can preview the shipped variants by changing them in the variant selector at the bottom of the menu.

### Single variant

Set the `themeVariant` value with the name of your theme file. That’s it!

    [params]
      themeVariant = "relearn-light"

In the above example your theme file has to be named `theme-relearn-light.css`

### Multiple variants

You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant switch will be shown in the menu footer.

    [params]
      # Change default color scheme with a variant one.
      themeVariant = [ "relearn-light", "relearn-dark" ]

Tip

If you want to switch the syntax highlighting theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation according to Hugo’s documentation, and `@import` this stylesheet in your color variant stylesheet. For an example, take a look into `theme-relearn-light.css` and `config.toml` of the exampleSite.

### Adjust to OS Settings

You can also cause the site to adjust to your OS settings for light/dark mode. Just set the `themeVariant` to `auto`. That’s it.

If you’ve set multiple variants, you can drop `auto` at any position, but usually it makes sense to set it in the first position and make it the default.

    [params]
      themeVariant = [ "auto", "red" ]

If you don’t configure anything else, the theme will use `relearn-light` for light mode and `relearn-dark` for dark mode.

If you don’t like that, you can set `themeVariantAuto`. The first element is the variant for light mode, the second for dark mode

    [params]
      themeVariantAuto = [ "learn", "neon" ]

Note

This is not supported for Internet Explorer 11, which still displays in the `relearn-light` variant.

### Roll your own

If you are not happy with the shipped variants you can either copy and rename one of the shipped files from `themes/hugo-theme-relearn/static/css` to `static/css`, edit them afterwards to your liking in a text editor and configure the `themeVariant` parameter in your `config.toml` or just use the interactive variant generator.

### Output formats

Certain parts of the theme can be changed for support of your own output formats. Eg. if you define a new output format `PLAINTEXT` in your `config.toml`, you can add a file `layouts/partials/header.plaintext.html` to change the way, the page header should look like for that output format.

# Stylesheet generator

This interactive tool may help you to generate your own color variant stylesheet.

To get started, first select a color variant from the variant switch that fits you best as a starting point.

The graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly.

The arrowed lines reflects how colors are inherited thru different parts of the theme if the descendent 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 heading `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 switch will show a “My custom variant” entry and your changes are stored in the browser. You can change 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 `static/css` directory. Afterwards you have to adjust the `themeVariant` parameter in your `config.toml` to your chosen file name.

Eg. if your new variants file is named `theme-my-custom-variant.css`, you have to set `themeVariant='my-custom-variant'` to use it.

Note

This only works in modern browsers.

## Variant generator

Graph

# History

# Changelog

## 5.11.1 (2023-02-06)

### Fixes

- [bug] variant: include missing `theme-auto.css` in distribution #467

## 5.11.0 (2023-02-05)

### Enhancements

- [feature] i18n: add Czech translation #455
- [feature][change] lightbox: switch to CSS-only solution #451
- [feature][change] variant: add support for `prefers-color-scheme` #445
- [feature][change] expand: refactor for a11y #339
- [feature][change] mermaid: make zoom configurable #144

### Fixes

- [bug] swagger: avoid errors when using invalid rapi-doc fragment ids #465
- [bug] search: fix oddities in keyboard handling #463
- [bug] badge: fix text color for IE11 #462
- [bug] mermaid: rerender graph if search term is present and variant is switched #460
- [bug] tags: show tag on pages when tag has space #459
- [bug] edit: remove double slash on root page link #450

### Maintenance

- [task] build: add moving version tags #453
- [task][change] theme: remove jQuery #452
- [task] build: check for release notes before release #448

## 5.10.2 (2023-01-25)

### Fixes

- [bug] nav: fix breadcrumb for huge installations #446

## 5.10.1 (2023-01-25)

### Fixes

- [bug] print: fix image links with relative path #444

## 5.10.0 (2023-01-25)

### Enhancements

- [feature] shortcodes: support for accent color #440
- [feature] shortcodes: add color parameter where applicable #438
- [feature] theme: announce translations as alternate links #422

### Fixes

- [bug] nav: fix breadcrumbs for deeply nested sections #442
- [bug] theme: improve whitespacing in tables #441

## 5.9.4 (2023-01-23)

### Fixes

- [bug] variant: fix search icon and text color #437

## 5.9.3 (2023-01-22)

### Fixes

- [bug] nav: fix left/right navigation for horizontal scrolling #435
- [bug] theme: allow pages on top level #434

### Maintenance

- [task] build: switch to wildcard version of actions #428

## 5.9.2 (2022-12-30)

### Fixes

- [bug] search: apply dependency scripts for Hindi and Japanese #427

## 5.9.1 (2022-12-23)

### Enhancements

- [feature] theme: make external link target configurable #426

## 5.9.0 (2022-12-23)

### Enhancements

- [feature][change] theme: open external links in separate tab #419
- [feature] theme: make it a Hugo module #417

### Fixes

- [bug][change] attachments: fix incorrect links for defaultContentLanguageInSubdir=true #425

## 5.8.1 (2022-12-11)

### Fixes

- [bug] theme: fix alias for home page if defaultContentLanguageInSubdir=true #414

## 5.8.0 (2022-12-08)

### Enhancements

- [feature] icon: add new shortcode #412
- [feature] theme: style and document markdown extensions #411
- [feature] badge: add new shortcode #410
- [feature] theme: add accent color #409

### Fixes

- [bug] theme: fix spacing for tag flyout in FF #413

## 5.7.0 (2022-11-29)

### Enhancements

- [feature] button: refactor for a11y #372

### Fixes

- [bug] search: don’t freeze browser on long search terms #408
- [bug] search: fix searchbox placeholder color in FF and IE #405
- [bug][change] i18n: rename Korean translation from country to lang code #404

### Maintenance

- [task] search: update lunr languages to 1.10.0 #403

## 5.6.6 (2022-11-23)

### Enhancements

- [feature] search: make build and js forgiving against config errors #400

### Fixes

- [bug] variant: minor color adjustments #402
- [bug] variant: fix generator for use of neon #401

## 5.6.5 (2022-11-19)

### Fixes

- [bug] menu: relax usage of background color #399

## 5.6.4 (2022-11-19)

### Fixes

- [bug] theme: make alias pages usable by file:// protocol #398

## 5.6.3 (2022-11-19)

### Fixes

- [bug] theme: be compatible with Hugo >= 0.95.0 #397

## 5.6.2 (2022-11-19)

### Fixes

- [bug] theme: build breaks sites without “output” section in config #396

## 5.6.1 (2022-11-19)

### Fixes

- [bug] theme: fix image distortion #395

## 5.6.0 (2022-11-18)

### Enhancements

- [feature] toc: improve keyboard handling #390
- [feature] search: improve keyboard handling #387
- [feature] search: add dedicated search page #386
- [feature] theme: make creation of generator meta tag configurable #383
- [feature] theme: increase build performance #380

### Fixes

- [bug] mermaid: avoid leading whitespace #394
- [bug] theme: fix build errors when referencing SVGs in markdown #393
- [bug] variant: avoid neon to leak into IE11 fallback #392
- [bug] theme: fix urls for file:// protocol in sitemap #385
- [bug] theme: add id to h1 elements #384
- [bug] rss: fix display of hidden subpages #382
- [bug] nav: fix key navigation when pressing wrong modifiers #379

### Maintenance

- [task] mermaid: update to version 9.2.2 #391

## 5.5.3 (2022-11-10)

### Fixes

- [bug] tags: fix non-latin tag display on pages #378

## 5.5.2 (2022-11-08)

### Fixes

- [bug] theme: fix typo in 404.html #376
- [bug] theme: allow menu items and children to be served by file:// protocol #375

## 5.5.1 (2022-11-07)

### Fixes

- [bug] theme: fix overflowing issue with anchors and tooltips #364

## 5.5.0 (2022-11-06)

### Enhancements

- [feature][change] theme: optimize page load for images #304

### Fixes

- [bug] theme: fix context in render hooks #373
- [bug] print: make canonical URL absolute #371

## 5.4.3 (2022-11-05)

### Enhancements

- [feature] history: refactor for a11y #341

### Fixes

- [bug] theme: fix multilang links when site served from subdirectory #370

## 5.4.2 (2022-11-05)

### Maintenance

- [task] build: change set-output to env vars #348

## 5.4.1 (2022-11-05)

### Fixes

- [bug] mermaid: fix Gantt chart width #365

## 5.4.0 (2022-11-01)

### Enhancements

- [feature] math: allow passing of parameters with codefence syntax #363
- [feature] i18n: add Finnish translation #361
- [feature] mermaid: allow passing of parameters with codefence syntax #360
- [feature] i18n: support RTL #357
- [feature][change] button: add option for target #351
- [feature][change] theme: allow to be served by file:// protocol #349

## 5.3.3 (2022-10-09)

### Fixes

- [bug] archetypes: fix frontmatter on home.md template #346

## 5.3.2 (2022-10-08)

### Fixes

- [bug] nav: change defunct keyboard shortcuts #344

## 5.3.1 (2022-10-08)

### Enhancements

- [feature] i18n: update Spanish translation #343
- [feature] theme: option to align images #327

## 5.3.0 (2022-10-07)

### Enhancements

- [feature] expander: improve whitespace between label and content #338
- [feature] swagger: improve print version #333

### Fixes

- [bug] print: fix links of subsections #340
- [bug] theme: remove W3C validator errors #337
- [bug] children: remove unused `page` parameter from docs #336
- [bug] print: remove menu placeholder in Firefox #335
- [bug] swagger: fix download button overflow #334
- [bug][change] a11y: remove WCAG errors where applicable #307

## 5.2.4 (2022-10-02)

### Fixes

- [bug] theme: remove HTML5 validator errors #329

## 5.2.3 (2022-09-12)

### Fixes

- [bug] print: chapter pages overwrite font-size #328

## 5.2.2 (2022-08-23)

### Fixes

- [bug] print: fix urls for uglyURLs=true #322

## 5.2.1 (2022-08-05)

### Enhancements

- [feature] i18n: improve Japanese translation #318

### Fixes

- [bug] nav: prev/next ignores ordersectionby #320

### Maintenance

- [task] task: bump Hugo minimum requirement to 0.95 #319

## 5.2.0 (2022-08-03)

### Enhancements

- [feature][change] menu: expand collapsed menus if search term is found in submenus #312

### Fixes

- [bug] print: switch mermaid and swagger style before print #316
- [bug] theme: fix chapter margins on big screens #315

## 5.1.2 (2022-07-18)

### Fixes

- [bug] print: reset mermaid theme to light #313
- [bug] mermaid: header is showing up in FF #311

## 5.1.1 (2022-07-15)

### Fixes

- [bug] tags: don’t count tags if page is hidden #310

## 5.1.0 (2022-07-15)

### Enhancements

- [feature][change] print: make print url deterministic #309
- [feature] theme: allow overriding partials for output formats #308

## 5.0.3 (2022-07-07)

### Fixes

- [bug] ie11: no styles after rework of archetypes #306

## 5.0.2 (2022-07-07)

### Fixes

- [bug] theme: load CSS if JS is disabled #305

## 5.0.1 (2022-07-07)

### Enhancements

- [feature][breaking] theme: optimize loading of js and css #303

## 5.0.0 (2022-07-05)

### Enhancements

- [feature][change] archetypes: modularize rendering #300
- [feature] history: don’t reload page when history gets cleared #299
- [feature] menu: replace expander by fontawesome chevrons #296
- [feature] theme: align content with topbar icon limits #290
- [feature] button: allow for empty href #288
- [feature] i18n: make Simplified Chinese the standard language for the `zn` code #287
- [feature] clipboard: move head styles to stylesheet #286
- [feature] math: add mathjax rendering #235
- [feature] theme: allow for page heading modification #139

### Fixes

- [bug] favicon: fix URL if site resides in subfolder #302
- [bug] code: show copy-to-clipboard marker for blocklevel code #298
- [bug] menu: make active expander visible on hover #297
- [bug] print: disable arrow navigation #294
- [bug] print: add missing page break after index or section #292
- [bug] theme: use more space on wide screens #291
- [bug] theme: fix size of chapter heading #289

### Maintenance

- [task] chore: update RapiDoc 9.3.3 #301
- [task] chore: update Mermaid 9.1.3 #293

## 4.2.5 (2022-06-23)

### Fixes

- [bug] swagger: javascript code does not load in documentation #285
- [bug] children: descriptions not working #284
- [bug] print: fix empty page for shortcut links #283

## 4.2.4 (2022-06-23)

### Fixes

- [bug] theme: fix url for logo and home button #282

## 4.2.3 (2022-06-23)

### Fixes

- [bug][breaking] include: second parameter is ignored #281

## 4.2.2 (2022-06-23)

No changelog for this release.

## 4.2.1 (2022-06-23)

No changelog for this release.

## 4.2.0 (2022-06-23)

### Enhancements

- [feature][change] tabs: don’t change tab selection if panel does not contain item #279
- [feature] shortcodes: convert to partials #277

### Fixes

- [bug] swagger: avoid builtin syntax-highlightning #280
- [bug] search: fix console message for missing lunr translations #278
- [bug] tabs: fix wrapping when having many tabs #272

## 4.1.1 (2022-06-18)

### Fixes

- [bug] notice: fix layout when content starts with heading #275

## 4.1.0 (2022-06-12)

### Enhancements

- [feature] i18n: support multilang content #271

## 4.0.5 (2022-06-12)

### Fixes

- [bug] i18n: Vietnamese language with wrong lang code #270
- [bug] i18n: fix search for non western languages #269

## 4.0.4 (2022-06-07)

### Enhancements

- [feature] theme: improve keyboard navigation for scrolling #268

### Fixes

- [bug] swagger: adjust font-size for method buttons #267
- [bug] menu: hide expander when only hidden subpages #264
- [bug] theme: make compatible with Hugo 0.100.0 #263

### Maintenance

- [task] swagger: update rapidoc to 9.3.2 #266
- [task] mermaid: update to 9.1.1 #265

## 4.0.3 (2022-06-05)

### Enhancements

- [feature] toc: add scrollbar #262

## 4.0.2 (2022-06-05)

### Fixes

- [bug] theme: let browser scroll page on CTRL+f #242

## 4.0.1 (2022-06-05)

No changelog for this release.

## 4.0.0 (2022-06-05)

### Enhancements

- [feature] shortcodes: add named parameter if missing #260
- [feature][breaking] theme: remove –MAIN-ANCHOR-color from stylesheet #256
- [feature] i18n: add Italian translation #254
- [feature] attachments: support for brand colors #252
- [feature] notice: support for brand colors #251
- [feature][breaking] config: remove custom_css #248
- [feature] theme: use proper file extension for page-meta.go #246
- [feature] variant: add support for brand color variables #239
- [feature] i18n: add Polish translation #237

### Fixes

- [bug] shortcodes: accept boolean parameters if given as string #261
- [bug] print: adjust button and tab size #259
- [bug] print: show Mermaid if requested in frontmatter #255
- [bug] theme: adjust thin scrollbar slider #244
- [bug] mobile: fix broken scrollbar #243
- [bug] theme: fix display of tooltip for heading anchor #241

## 3.4.1 (2022-04-03)

### Fixes

- [bug] theme: fix IE11 incompatibilities #234

## 3.4.0 (2022-04-03)

### Enhancements

- [feature] i18n: add Traditional Chinese translation #233
- [feature] menu: expand/collapse menu items without navigation #231
- [feature] print: add option to print whole chapter #230
- [feature][breaking] theme: apply user supplied content footer below content #229

### Fixes

- [bug] theme: scroll to heading on initial load #232

## 3.3.0 (2022-03-28)

### Enhancements

- [feature] theme: add CSS font variables #227
- [feature] swagger: add support for oas/swagger documentation #226

### Fixes

- [bug] variant: make variant switch work on slow networks #228

## 3.2.1 (2022-03-25)

### Fixes

- [bug] print: fix minor inconsistencies #225
- [bug] print: show more than just the title page #224
- [bug] theme: align content scrollbar to the right on big screens #223

## 3.2.0 (2022-03-19)

### Enhancements

- [feature][change] mermaid: support differing themes for color variant switch #219
- [feature] mermaid: load javascript on demand #218

### Maintenance

- [task] mermaid: update to 8.14.0 #220

## 3.1.1 (2022-03-16)

### Enhancements

- [feature] i18n: add Korean translation #217

## 3.1.0 (2022-03-15)

### Enhancements

- [feature] notice: add icon parameter #212
- [feature] mobile: remove breadcrumb ellipsis #211

### Fixes

- [bug] theme: make storage of multiple Hugo sites on same server distinct #214
- [bug] variant: switch breadcrumb color in Chrome #213
- [bug] mobile: improve behavior of sidebar menu #210

## 3.0.4 (2022-02-24)

### Enhancements

- [feature] theme: improve font loading #201
- [feature][change] variant: fix inconsistent color variable naming #200

### Fixes

- [bug] variant: fix occasional fail when resetting generator #208
- [bug] docs: don’t move header on logo hover in IE11 #207
- [bug] variant: avoid flash of menu header when non default variant is active #206
- [bug] theme: fix wrong HTML closing tag order in chapters #205
- [bug] theme: adjust breadcrumb and title for empty home page titles #202

## 3.0.3 (2022-02-23)

### Enhancements

- [feature] tags: show tag count in taxonomy list #195

### Fixes

- [bug] theme: remove Hugo build warning if page is not file based #197
- [bug] tags: adhere to titleSeparator #196
- [bug] theme: hide footer divider and variant selector in IE11 #194

## 3.0.2 (2022-02-23)

### Enhancements

- [feature] tags: sort by name #193

## 3.0.1 (2022-02-23)

### Enhancements

- [feature] children: set containerstyle automatically according to style #192

### Fixes

- [bug] theme: revert fontawsome to version 5 for IE11 compat #191

## 3.0.0 (2022-02-22)

### Enhancements

- [feature] variant: build a variant generator #188
- [feature] nav: only show toc if the page has headings #182
- [feature][breaking] theme: change default colors to Relearn defaults #181
- [feature] variant: add a variant selector #178
- [feature][breaking] menu: rework footer UX #177
- [feature] theme: support for dark mode #175
- [feature] docs: use light syntax highlightning theme #174
- [feature] notice: tweak dull colors #173
- [feature] theme: rework header UX #151

### Fixes

- [bug] search: remove additional X in filled out search box in IE11 #190
- [bug] clipboard: localize tooltips #186
- [bug] print: hide sidebar on Mac #183
- [bug] menu: fix scrollbar height #180
- [bug][change] search: fix color change for icons on hover #176

## 2.9.6 (2022-02-07)

### Fixes

- [bug] menu: remove debug output #171

## 2.9.5 (2022-02-07)

### Fixes

- [bug] menu: let arrow navigation respect ordersectionsby configuration #170

## 2.9.4 (2022-02-06)

### Fixes

- [bug] exampleSite: fix links in official documentation #168

## 2.9.3 (2022-02-06)

### Fixes

- [bug] menu: invalid URL when the shortcut is an internal link #163

## 2.9.2 (2021-11-26)

### Enhancements

- [feature] theme: add theme version info to head #158

### Fixes

- [bug] theme: fix selection of *.ico files as favicons #160

## 2.9.1 (2021-11-22)

### Fixes

- [bug] menu: fix significantly low performance for collecting of meta info #157

## 2.9.0 (2021-11-19)

### Fixes

- [bug][breaking] relref: fix inconsistent behavior #156
- [bug] search: make dropdown stick to search field when scrolling #155
- [bug] menu: align long text properly #154
- [bug] copyToClipBoard: add missing right border for inline code if `disableInlineCopyToClipBoard=true` #153
- [bug] menu: show hidden sibling pages reliably #152
- [bug] menu: bring active item in sight for large menus #149

## 2.8.3 (2021-11-09)

### Fixes

- [bug] mermaid: let zoom reset to initial size #145
- [bug] mermaid: remove whitespace from big graphs #143

## 2.8.2 (2021-11-08)

### Fixes

- [bug] mermaid: always load javascript to avoid break if code fences are used #142

## 2.8.1 (2021-11-04)

### Fixes

- [bug] search: don’t break JS in multilang setup if search is disabled #140

## 2.8.0 (2021-11-03)

### Enhancements

- [feature] toc: make disableTOC globally available via config.toml #133
- [feature] mermaid: only load javascript if necessary #95
- [feature][change] theme: switch font #83
- [feature] theme: make favicon configurable #2

### Fixes

- [bug] mermaid: assert that window.mermaid is actually mermaid #136
- [bug] menu: remove usage of Hugos UniqueID #131
- [bug] theme: reduce margin for children shortcode #130
- [bug] theme: left-align h3 in chapters #129
- [bug] theme: align copy link to clipboard #128

## 2.7.0 (2021-10-24)

### Enhancements

- [feature] notice: support custom titles #124

## 2.6.0 (2021-10-21)

### Fixes

- [bug] theme: generate correct links if theme served from subdirectory #120

## 2.5.1 (2021-10-12)

### Fixes

- [bug] security: fix XSS for malicioius image URLs #117

## 2.5.0 (2021-10-08)

### Enhancements

- [feature][change] syntax highlight: provide default colors for unknown languages #113

### Fixes

- [bug] security: fix XSS for malicioius URLs #114
- [bug] menu: write correct local shortcut links #112

## 2.4.1 (2021-10-07)

### Fixes

- [bug] theme: remove runtime styles from print #111

## 2.4.0 (2021-10-07)

### Enhancements

- [feature] lang: add vietnamese translation #109
- [feature][change] theme: simplify stylesheet for color variants #107
- [feature] hidden pages: remove from RSS feed, JSON, taxonomy etc #102
- [feature] theme: announce alternative content in header #101
- [feature] menu: frontmatter option to change sort predicate #98
- [feature] menu: add default setting for menu expansion #97
- [feature] theme: improve print style #93
- [feature] theme: improve style #92

### Fixes

- [bug] include: don’t generate additional HTML if file should be displayed “as is” #110
- [bug] attachments: fix broken links if multilang config is used #105
- [bug] theme: fix sticky header to remove horizontal scrollbar #82

### Maintenance

- [task] chore: update fontawesome #94

## 2.3.2 (2021-09-20)

### Fixes

- [bug] docs: rename history pirate translation #91

## 2.3.1 (2021-09-20)

### Fixes

- [bug] docs: rename english pirate translation to avoid crash on rendering #90

## 2.3.0 (2021-09-13)

### Fixes

- [bug] theme: fix usage of section element #88

### Maintenance

- [task] theme: ensure IE11 compatiblity #89
- [task] docs: Arrr! showcase multilang featurrre #87

## 2.2.0 (2021-09-09)

### Enhancements

- [feature] sitemap: hide hidden pages from sitemap and SEO indexing #85

### Fixes

- [bug] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs #86

### Maintenance

- [task] theme: switch from data-vocabulary to schema #84

## 2.1.0 (2021-09-07)

### Enhancements

- [feature] search: open expand if it contains search term #80
- [feature] menu: scroll active item into view #79
- [feature] search: disable search in hidden pages #76
- [feature] search: improve readablility of index.json #75
- [feature] search: increase performance #74
- [feature] search: improve search context preview #73

### Fixes

- [bug][change] search: hide non-site content #81
- [bug] menu: always hide hidden sub pages #77

## 2.0.0 (2021-08-28)

### Enhancements

- [feature] tabs: enhance styling #65
- [feature] theme: improve readability #64
- [feature] menu: show hidden pages if accessed directly #60
- [feature][change] theme: treat pages without title as hidden #59
- [feature] search: show search results if field gains focus #58
- [feature] theme: add partial templates for pre/post menu entries #56
- [feature] theme: make chapter archetype more readable #55
- [feature] children: add parameter for container style #53
- [feature] theme: make content a template #50
- [feature] menu: control menu expansion with alwaysopen parameter #49
- [feature] include: new shortcode to include other files #43
- [feature] theme: adjust print styles #35
- [feature][change] code highlighter: switch to standard hugo highlighter #32

### Fixes

- [bug][change] arrow-nav: default sorting ignores ordersectionsby #63
- [bug][change] children: default sorting ignores ordersectionsby #62
- [bug][change] arrow-nav: fix broken links on (and below) hidden pages #61
- [bug] theme: remove superfluous singular taxonomy from taxonomy title #46
- [bug][change] theme: missing –MENU-HOME-LINK-HOVER-color in documentation #45
- [bug] theme: fix home link when base URL has some path #44

### Maintenance

- [task] docs: include changelog in exampleSite #33

## 1.2.0 (2021-07-26)

### Enhancements

- [feature] theme: adjust copy-to-clipboard #29
- [feature] attachments: adjust style between notice boxes and attachments #28
- [feature] theme: adjust blockquote contrast #27
- [feature] expand: add option to open on page load #25
- [feature] expand: rework styling #24
- [feature] attachments: sort output #23
- [feature] notice: make restyling of notice boxes more robust #20
- [feature] notice: fix contrast issues #19
- [feature] notice: align box colors to common standards #18
- [feature] notice: use distinct icons for notice box type #17

### Fixes

- [bug] attachments: support i18n for attachment size #21
- [bug] notice: support i18n for box labels #16
- [bug] notice: support multiple blocks in one box #15

### Maintenance

- [task] dependency: upgrade jquery to 3.6.0 #30

## 1.1.1 (2021-07-04)

### Maintenance

- [task] theme: prepare for new hugo theme registration #13

## 1.1.0 (2021-07-02)

### Enhancements

- [feature] mermaid: expose options in config.toml #4

### Fixes

- [bug] mermaid: config option for CDN url not used #12
- [bug] mermaid: only highlight text in HTML elements #10
- [bug] mermaid: support pan & zoom for graphs #9
- [bug] mermaid: code fences not always rendered #6
- [bug] mermaid: search term on load may bomb chart #5

### Maintenance

- [task] mermaid: update to 8.10.2 #7

## 1.0.1 (2021-07-01)

### Maintenance

- [task] Prepare for hugo showcase #3

## 1.0.0 (2021-07-01)

### Maintenance

- [task] Fork project #1

Chapter 2

# Content

Find out how to create and organize your content quickly and intuitively.

# Subsections of Content

# Pages organization

In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.

## Folders

Organize your site like any other Hugo project. Typically, you will have a content folder with all your pages.

    content
    ├── level-one
    │   ├── level-two
    │   │   ├── level-three
    │   │   │   ├── level-four
    │   │   │   │   ├── _index.md       <-- /level-one/level-two/level-three/level-four
    │   │   │   │   ├── page-4-a.md     <-- /level-one/level-two/level-three/level-four/page-4-a
    │   │   │   │   ├── page-4-b.md     <-- /level-one/level-two/level-three/level-four/page-4-b
    │   │   │   │   └── page-4-c.md     <-- /level-one/level-two/level-three/level-four/page-4-c
    │   │   │   ├── _index.md           <-- /level-one/level-two/level-three
    │   │   │   ├── page-3-a.md         <-- /level-one/level-two/level-three/page-3-a
    │   │   │   ├── page-3-b.md         <-- /level-one/level-two/level-three/page-3-b
    │   │   │   └── page-3-c.md         <-- /level-one/level-two/level-three/page-3-c
    │   │   ├── _index.md               <-- /level-one/level-two
    │   │   ├── page-2-a.md             <-- /level-one/level-two/page-2-a
    │   │   ├── page-2-b.md             <-- /level-one/level-two/page-2-b
    │   │   └── page-2-c.md             <-- /level-one/level-two/page-2-c
    │   ├── _index.md                   <-- /level-one
    │   ├── page-1-a.md                 <-- /level-one/page-1-a
    │   ├── page-1-b.md                 <-- /level-one/page-1-b
    │   └── page-1-c.md                 <-- /level-one/page-1-c
    ├── _index.md                       <-- /
    └── page-top.md                     <-- /page-top

Note

`_index.md` is required in each folder, it’s your “folder home page”

## Create your project

The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you to train by following great documentation for beginners.

Hugo provides a `new` command to create a new website.

    hugo new site <new_project>

The Relearn theme provides archetypes to help you create this kind of pages.

## Frontmatter Configuration

Each Hugo page has to define a frontmatter in toml, yaml or json. This site will use toml in all cases.

The Relearn theme uses the following parameters on top of Hugo ones:

    +++
    # Table of contents (toc) is enabled by default. Set this parameter to true to disable it.
    # Note: Toc is always disabled for chapter pages
    disableToc = false
    # If set, this will be used for the page's menu entry (instead of the `title` attribute)
    menuTitle = ""
    # If set, this will explicitly override common rules for the expand state of a page's menu entry
    alwaysopen = true
    # If set, this will explicitly override common rules for the sorting order of a page's submenu entries
    ordersectionsby = "title"
    # The title of the page heading will be prefixed by this HTML content
    headingPre = ""
    # The title of the page heading will be postfixed by this HTML content
    headingPost = ""
    # The title of the page in menu will be prefixed by this HTML content
    menuPre = ""
    # The title of the page in menu will be postfixed by this HTML content
    menuPost = ""
    # Hide a menu entry by setting this to true
    hidden = false
    # Display name of this page modifier. If set, it will be displayed in the footer.
    LastModifierDisplayName = ""
    # Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer
    LastModifierEmail = ""
    +++

### Add icon to a menu entry

In the page frontmatter, add a `menuPre` param to insert any HTML code before the menu label. The example below uses the GitHub icon.

    +++
    title = "GitHub repo"
    menuPre = "<i class='fab fa-github'></i> "
    +++

### Ordering sibling menu/page entries

Hugo provides a flexible way to handle order for your pages.

The simplest way is to set `weight` parameter to a number.

    +++
    title = "My page"
    weight = 5
    +++

### Using a custom title for menu entries

By default, the Relearn theme will use a page’s `title` attribute for the menu item (or `linkTitle` if defined).

But a page’s title has to be descriptive on its own while the menu is a hierarchy. We’ve added the `menuTitle` parameter for that purpose:

For example (for a page named `content/install/linux.md`):

    +++
    title = "Install on Linux"
    menuTitle = "Linux"
    +++

### Override expand state rules for menu entries

You can change how the theme expands menu entries on the side of the content with the `alwaysopen` setting on a per page basis. 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 menu based on the following rules:

- all parent entries of the active page including their siblings are shown regardless of any settings
- immediate children 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 children entries if `alwaysopen=true`; this proceeds recursively
- all remaining entries are not shown

You can see this feature in action on the example page for children shortcode and its children pages.

# Archetypes

Using the command: `hugo new [relative new content path]`, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: archetypes. These are preconfigured skeleton pages with default frontmatter.

The Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.

## Predefined Archetypes

### 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

This leads to a file with the following content

    +++
    archetype = "home"
    title = "{{ replace .Name "-" " " | title }}"
    +++

    Lorem Ipsum.

### Chapter

A Chapter displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found below it.

To create a chapter page, run the following command

    hugo new --kind chapter <name>/_index.md

This leads to a file with the following content

    +++
    archetype = "chapter"
    title = "{{ replace .Name "-" " " | title }}"
    weight = X
    +++

    Lorem Ipsum.

Replace the `X` with a number. Because this number 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 level.

### Default

A Default page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.

To create a default page, run either one of the following commands

    hugo new <chapter>/<name>/_index.md

or

    hugo new <chapter>/<name>.md

This leads to a file with the following content

    +++
    title = "{{ replace .Name "-" " " | title }}"
    weight = X
    +++

    Lorem Ipsum.

Replace the `X` with a number or delete the whole `weight` parameter entirely.

## Self defined Archetypes

If you are in need of further archetypes you can define your own or even redefine existing ones.

### Template

Define a template file in your project at `archetypes/<kind>.md` and make sure it has at least the frontmatter parameter for that archetype like

    +++
    archetype = "<kind>"
    +++

Afterwards you can generate new content files of that kind with the following command

    hugo new --kind <kind> <name>/_index.md

### Partials

To define how your archetypes are rendered, define corresponding partial files in your projects directory `layouts/partials/archetypes/<kind>`.

If you use an unknown archetype in your frontmatter, the `default` archetype will be used to generate the page.

Related to each archetype, several hook partial files in the form of `<hook>.html` can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.

The following hooks are used:

Name | Notes
--- | ---
styleclass | Defines a set of CSS classes to be added to the HTML’s `<main>` element. You can use these classes to define own CSS rules in your `custom-header.html`
article | Defines the HTML how to render your content

Take a look at the existing archetypes of this theme to get an idea how to utilize it.

#### Output formats

Each hook file can be overridden of a specific output format. Eg. if you define a new output format `PLAINTEXT` in your `config.toml`, you can add a file `layouts/partials/archetypes/default.plaintext.html` to change the way how normal content is written for that output format.

# Markdown syntax

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:

1. Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content.
2. Less chance of errors when writing in Markdown.
3. Produces valid HTML output.
4. Keeps the content and the visual display separate, so you cannot mess up the look of your site.
5. Write in any text editor or Markdown application you like.
6. 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

Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:

Tip

Bookmark this page and the official Commonmark reference for easy future reference!

## 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.

    # h1 Heading

    ## h2 Heading

    ### h3 Heading

    #### h4 Heading

    ##### h5 Heading

    ###### h6 Heading

Result

# h1 Heading

## h2 Heading

### h3 Heading

#### h4 Heading

##### h5 Heading

###### h6 Heading

## Horizontal Rules

To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes `---`.

    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.

## 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

### Strikethrough

In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes `~~`.

    ~~Strike through this text~~

Result

Strike through this text

## Text substitution

This Markdown dialect supports an extension to 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.

## 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

1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
   1. Integer molestie lorem at massa
   2. Facilisis in pretium nisl aliquet
3. Nulla volutpat aliquam velit
   1. Faucibus porta lacus fringilla vel
   2. Aenean sit amet erat nunc
4. Eget porttitor lorem

### Tasks

In GFM (GitHub Flavored Markdown) 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

### Defintions

This Markdown dialect supports an extension to add defintion lists. 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.

In GFM (GitHub Flavored Markdown) 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.

See Code Highlighting for additional documentation.

    ```js
    grunt.initConfig({
      assemble: {
        options: {
          assets: 'docs/assets',
          data: 'src/data/*.{json,yml}',
          helpers: 'src/custom-helpers.js',
          partials: ['src/partials/**/*.{hbs,md}']
        },
        pages: {
          options: {
            layout: 'default.hbs'
          },
          files: {
            './': ['src/templates/pages/index.hbs']
          }
        }
      }
    };
    ```

Result

    grunt.initConfig({
      assemble: {
        options: {
          assets: 'docs/assets',
          data: 'src/data/*.{json,yml}',
          helpers: 'src/custom-helpers.js',
          partials: ['src/partials/**/*.{hbs,md}']
        },
        pages: {
          options: {
            layout: 'default.hbs'
          },
          files: {
            './': ['src/templates/pages/index.hbs']
          }
        }
      }
    };

## Tables

In GFM (GitHub Flavored Markdown) 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.

## Blockquotes

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 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 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.

## Links

### Autolink

In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.

    This is a link to https://example.com.

Result

This is a link to https://example.com.

### Basic Link

You can explicitly define links in case you want to use non-absolute URLs or want to give different text.

    [Assemble](http://assemble.io)

Result

Assemble

### Link with Tooltip

For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.

    [Upstage](https://github.com/upstage/ "Visit Upstage!")

Result

Upstage

### Link References

Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.

    [Example][somelinkID]

    [somelinkID]: https://example.com "Go to example domain"

Result

Example

### Footnotes

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.

Result

That’s some text with a footnote1

That’s some more text with a footnote.2

1. And that’s the footnote. ↩︎

2. Anything of interest goes here.

   Blue light glows blue. ↩︎

## Images

### Basic Images

Images have a similar syntax to links but include a preceding exclamation mark.

    ![Spock](https://octodex.github.com/images/spocktocat.png)

Result

### Image with Tooltip

Like links, images can also be given a tooltip.

    ![Picard](https://octodex.github.com/images/jean-luc-picat.jpg "Jean Luc Picard")

Result

### Image References

Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.

    ![La Forge][laforge]

    [laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"

Result

### Further Image Formatting

This theme allows additional non-standard formatting by setting query parameter at the end of the image URL.

#### Resizing

Add query parameter `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).

    ![Minion](https://octodex.github.com/images/minion.png?width=20vw)

Result

    ![Minion](https://octodex.github.com/images/minion.png?height=50px)

Result

    ![Minion](https://octodex.github.com/images/minion.png?height=50px&width=40vw)

Result

#### CSS Classes

Add a query parameter `classes` to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.

##### Shadow

    ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow)

Result

##### Border

    ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border)

Result

##### Left

    ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left)

Result

##### Right

    ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right)

Result

##### Inline

    ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline)
    ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline)
    ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline)
    ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline)

Result

##### Combination

    ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left)

Result

#### Lightbox

Add the query parameter `lightbox=false` to the image link to disable the lightbox.

    ![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)

Result

# Code highlighting

The Relearn theme uses Hugo’s built-in syntax highlighting for code.

## Markdown syntax

Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided.

    ```json
    [
      {
        "title": "apples",
        "count": [12000, 20000],
        "description": {"text": "...", "sensitive": false}
      },
      {
        "title": "oranges",
        "count": [17500, null],
        "description": {"text": "...", "sensitive": false}
      }
    ]
    ```

Renders to:

    [
      {
        "title": "apples",
        "count": [12000, 20000],
        "description": {"text": "...", "sensitive": false}
      },
      {
        "title": "oranges",
        "count": [17500, null],
        "description": {"text": "...", "sensitive": false}
      }
    ]

## Supported languages

Hugo comes with a remarkable list of supported languages.

## Recommended configuration

You can choose a color theme from the list of supported themes and add it in your `config.toml`

    [markup]
      [markup.highlight]
        # if `guessSyntax = true`, there will be no unstyled code even if no language
        # was given BUT Mermaid and Math codefences will not work anymore! So this is a
        # mandatory setting for your site if you want to use Mermaid or Math codefences
        guessSyntax = false

        # choose a color theme or create your own
        style = "base16-snazzy"

# Menu extra shortcuts

You can define additional menu entries or shortcuts in the navigation menu without any link to content.

## Basic configuration

Edit the website configuration `config.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.

Example from the current website:

    [[menu.shortcuts]]
    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
    identifier = "ds"
    url = "https://github.com/McShelby/hugo-theme-relearn"
    weight = 10

    [[menu.shortcuts]]
    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
    url = "more/showcase/"
    weight = 11

    [[menu.shortcuts]]
    name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
    identifier = "hugodoc"
    url = "https://gohugo.io/"
    weight = 20

    [[menu.shortcuts]]
    name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
    url = "more/credits/"
    weight = 30

    [[menu.shortcuts]]
    name = "<i class='fas fa-fw fa-tags'></i> Tags"
    url = "tags/"
    weight = 40

By default, shortcuts are preceded by a title. This title can be disabled by setting `disableShortcutsTitle=true`. However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.

For example, in your local `i18n/en.toml` file, add the following content

    [Shortcuts-Title]
    other = "<Your value>"

Read more about hugo menu and hugo i18n translation strings

## Configuration for Multilingual mode

When using a multilingual website, you can set different menus for each language. In the `config.toml` file, prefix your menu configuration by `Languages.<language-id>`.

Example from the current website:

    [Languages]
      [Languages.en]
        title = "Hugo Relearn Theme"
        weight = 1
        languageName = "English"
        landingPageURL = "/"
        landingPageName = "<i class='fas fa-home'></i> Home"

      [[Languages.en.menu.shortcuts]]
        name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
        identifier = "ds"
        url = "https://github.com/McShelby/hugo-theme-relearn"
        weight = 10

      [[Languages.en.menu.shortcuts]]
        name = "<i class='fas fa-fw fa-camera'></i> Showcases"
        url = "more/showcase/"
        weight = 11

      [[Languages.en.menu.shortcuts]]
        name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
        identifier = "hugodoc"
        url = "https://gohugo.io/"
        weight = 20

      [[Languages.en.menu.shortcuts]]
        name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
        url = "more/credits/"
        weight = 30

      [[Languages.en.menu.shortcuts]]
        name = "<i class='fas fa-fw fa-tags'></i> Tags"
        url = "tags/"
        weight = 40

      [Languages.pir]
        title = "Cap'n Hugo Relearrrn Theme"
        weight = 1
        languageName = "Arrr! Pirrrates"
        landingPageURL = "/pir/"
        landingPageName = "<i class='fas fa-home'></i> Arrr! Home"

      [[Languages.pir.menu.shortcuts]]
        name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
        identifier = "ds"
        url = "https://github.com/McShelby/hugo-theme-relearn"
        weight = 10

      [[Languages.pir.menu.shortcuts]]
        name = "<i class='fas fa-fw fa-camera'></i> Showcases"
        url = "more/showcase/"
        weight = 11

      [[Languages.pir.menu.shortcuts]]
        name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentat'n"
        identifier = "hugodoc"
        url = "https://gohugo.io/"
        weight = 20

      [[Languages.pir.menu.shortcuts]]
        name = "<i class='fas fa-fw fa-bullhorn'></i> Crrredits"
        url = "more/credits/"
        weight = 30

      [[Languages.pir.menu.shortcuts]]
        name = "<i class='fas fa-fw fa-tags'></i> Arrr! Tags"
        url = "tags/"
        weight = 40

Read more about hugo menu and hugo multilingual menus

# Multilingual and i18n

The Relearn theme is fully compatible with Hugo multilingual mode.

It provides:

- Translation strings for default values (English, Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, Finnish French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese). Feel free to contribute!
- Support for languages written right to left
- Automatic menu generation from multilingual content
- In-browser language switching

## Basic configuration

After learning how Hugo handle multilingual websites, define your languages in your `config.toml` file.

For example with current English and Piratized English website.

Note

Make sure your default language is defined as the first one in the `[Languages]` array, as the theme needs to make assumptions on it

    # English is the default language
    defaultContentLanguage = "en"

    [Languages]
    [Languages.en]
    title = "Hugo Relearn Theme"
    weight = 1
    languageName = "English"

    [Languages.pir]
    title = "Cap'n Hugo Relearrrn Theme"
    weight = 2
    languageName = "Arrr! Pirrrates"

Then, for each new page, append the id of the language to the file.

- Single file `my-page.md` is split in two files:
  - in English: `my-page.md`
  - in Piratized English: `my-page.pir.md`
- Single file `_index.md` is split in two files:
  - in English: `_index.md`
  - in Piratized English: `_index.pir.md`

Info

Be aware that only translated pages are displayed in menu. It’s not replaced with default language content.

Tip

Use slug frontmatter parameter to translate urls too.

## Search

In case each page’s content is written in one single language only, the above configuration will already configure the site’s search functionality correctly.

Warning

Although the theme supports a wide variety of supported languages, the site’s search via the Lunr search library does not. You’ll see error reports in your browsers console log for each unsupported language. Currently unsupported are:

- Czech
- Indonesian
- Polish

### Search with mixed language support

In case your page’s content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your `config.toml` to broaden search.

    [params]
      additionalContentLanguage = [ "en" ]

As this is an array, you can add multiple additional languages.

Note

Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in `zh-CN`, you have to add just `zh` to this parameter.

## Overwrite translation strings

Translations strings are used for common default values used in the theme (Edit button, Search placeholder and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.

To override these values, create a new file in your local i18n folder `i18n/<idlanguage>.toml` and inspire yourself from the theme `themes/hugo-theme-relearn/i18n/en.toml`

## Disable language switching

Switching the language in the browser is a great feature, but for some reasons you may want to disable it.

Just set `disableLanguageSwitchingButton=true` in your `config.toml`

    [params]
      # When using multilingual website, disable the switch language button.
      disableLanguageSwitchingButton = true

# Tags

The Relearn theme supports one default taxonomy of Hugo: the tag feature.

## Configuration

Just add tags to any page:

    +++
    tags = ["tutorial", "theme"]
    title = "Theme tutorial"
    weight = 15
    +++

## Behavior

The tags are displayed at the top of the page, in their insertion order.

Each tag is a link to a Taxonomy page displaying all the articles with the given tag.

## List all the tags

In the `config.toml` file you can add a shortcut to display all the tags

    [[menu.shortcuts]]
    name = "<i class='fas fa-tags'></i> Tags"
    url = "/tags"
    weight = 30

Chapter 3

# Shortcodes

Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.

But this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.

To avoid this limitations, Hugo created shortcodes. A shortcode is a simple snippet inside a page.

The Relearn theme provides multiple shortcodes on top of existing ones.

## Attachments

List of files attached to a page

## Badge

Marker badges to display in your text

## Button

Clickable buttons

## Children

List the child pages of a page

## Expand

Expandable/collapsible sections of text

## Icon

Nice icons for your page

## Include

Displays content from other files

## Math

Beautiful math and chemical formulae

## Mermaid

Generate diagrams and flowcharts from text

## Notice

Disclaimers to help you structure your page

## Site param

Get value of site params

## Swagger

UI for your Swagger / OpenAPI Specifications

## Tabs

Show content in tabbed views

# Subsections of Shortcodes

# Attachments

The `attachments` shortcode displays a list of files attached to a page with adjustable color, title and icon.

Attachments

- adivorciarsetoca00cape.pdf (361 KB)
- BachGavotteShort.mp3 (357 KB)
- Carroll_AliceAuPaysDesMerveilles.pdf (175 KB)
- hugo.png (17 KB)
- hugo.txt (20 B)
- movieselectricsheep-flock-244-32500-2.mp4 (340 KB)

## Usage

While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.

    {{% attachments sort="asc" /%}}

    {{ partial "shortcodes/attachments.html" (dict
      "context" .
      "sort" "asc"
    )}}

### Parameter

Name | Default | Notes
--- | --- | ---
style | `transparent` | The style scheme used for the box. - by severity: `info`, `note`, `tip`, `warning` - by brand color: `primary`, `secondary`, `accent` - by color: `blue`, `green`, `grey`, `orange`, `red` - by special color: `default`, `transparent`
color | see notes | The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default. - 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: `Attachments` 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 d with spaces)
sort | `asc` | Sorting the output in `asc`ending or `desc`ending order.
pattern | `.*` | A regular expressions, used to filter the attachments by file name. For example: - to match a file suffix of ‘jpg’, use `.*\.jpg` (not `*.\.jpg`) - to match file names ending in `jpg` or `png`, use `.*\.(jpg|png)`

## Setup

### Single language

The shortcode lists files found in a specific folder. The name of the folder depends on your page type (either branch bundle, leaf bundle or page).

1. For simple pages, attachments must be placed in a folder named like your page and ending with `.files`.

   > - content
   >   - _index.md
   >   - page.files
   >     - attachment.pdf
   >   - page.md

2. If your page is a branch or leaf bundle, attachments must be placed in a nested `_index.files` or `index.files` folder, accordingly.

   For branch bundles:

   > - content
   >   - _index.md
   >   - page
   >     - index.md
   >     - index.files
   >       - attachment.pdf

   For leaf bundles:

   > - content
   >   - _index.md
   >   - page
   >     - _index.md
   >     - _index.files
   >       - attachment.pdf

### Multilingual

Be aware that if you use a multilingual website, you will need to have as many folders as languages and the language code must be part of the folder name.

Eg. for a site in English and Piratish:

> - content
>   - _index.en.md
>   - _index.pir.md
>   - page.en.files
>     - attachment.pdf
>   - page.pir.files
>     - attachment.pdf
>   - page.en.md
>   - page.pir.md

## Examples

### Custom Title, List of Attachments Ending in pdf or mp4

    {{% attachments title="Related files" pattern=".*\.(pdf|mp4)" /%}}

Related files

- adivorciarsetoca00cape.pdf (361 KB)
- Carroll_AliceAuPaysDesMerveilles.pdf (175 KB)
- movieselectricsheep-flock-244-32500-2.mp4 (340 KB)

### Info Styled Box, Descending Sort Order

    {{% attachments style="info" sort="desc" /%}}

Info

- movieselectricsheep-flock-244-32500-2.mp4 (340 KB)
- hugo.txt (20 B)
- hugo.png (17 KB)
- Carroll_AliceAuPaysDesMerveilles.pdf (175 KB)
- BachGavotteShort.mp3 (357 KB)
- adivorciarsetoca00cape.pdf (361 KB)

### With User-Defined Color and Font Awesome Brand Icon

    {{% attachments color="fuchsia" icon="fab fa-hackerrank" /%}}

Attachments

- adivorciarsetoca00cape.pdf (361 KB)
- BachGavotteShort.mp3 (357 KB)
- Carroll_AliceAuPaysDesMerveilles.pdf (175 KB)
- hugo.png (17 KB)
- hugo.txt (20 B)
- movieselectricsheep-flock-244-32500-2.mp4 (340 KB)

### Style, Color, Title and Icons

For further examples for style, color, title and icon, see the `notice` shortcode documentation. The parameter are working the same way for both shortcodes, besides having different defaults.

# Badge

The `badge` shortcode displays little markers in your text with adjustable color, title and icon.

Important Version6.6.6 Captain InfoNew Awesome

## Usage

While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.

    {{% badge %}}Important{{% /badge %}}
    {{% badge style="primary" title="Version" %}}6.6.6{{% /badge %}}
    {{% badge style="red" icon="angle-double-up" %}}Captain{{% /badge %}}
    {{% badge style="info" %}}New{{% /badge %}}
    {{% badge color="fuchsia" icon="fab fa-hackerrank" %}}Awesome{{% /badge %}}

    {{ partial "shortcodes/badge.html" (dict
        "context" .
        "content" "Important"
    )}}
    {{ partial "shortcodes/badge.html" (dict
      "context" .
      "style" "primary"
      "title" "Version"
      "content" "6.6.6"
    )}}
    {{ partial "shortcodes/badge.html" (dict
      "context" .
      "style" "red"
      "icon" "angle-double-up"
      "content" "Captain"
    )}}
    {{ partial "shortcodes/badge.html" (dict
      "context" .
      "style" "info"
      "content" "New"
    )}}
    {{ partial "shortcodes/badge.html" (dict
      "context" .
      "color" "fuchsia"
      "icon" "fab fa-hackerrank"
      "content" "Awesome"
    )}}

### Parameter

Name | Default | Notes
--- | --- | ---
style | `default` | The style scheme used for the badge. - by severity: `info`, `note`, `tip`, `warning` - by brand color: `primary`, `secondary`, `accent` - by color: `blue`, `green`, `grey`, `orange`, `red` - by special color: `default`, `transparent`
color | see notes | The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default. - for severity styles: a nice matching color for the severity - for all other styles: the corresponding color
title | see notes | Arbitrary text for the badge title. Depending on the style there may be a default title. Any given value will overwrite the default. - 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 | 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)
<content> | <empty> | Arbitrary text for the badge.

## Examples

### Style

#### By Severity

    {{% badge style="info" %}}New{{% /badge %}}
    {{% badge style="note" %}}Change{{% /badge %}}
    {{% badge style="tip" %}}Optional{{% /badge %}}
    {{% badge style="warning" %}}Breaking{{% /badge %}}

InfoNew NoteChange TipOptional WarningBreaking

#### By Brand Colors

    {{% badge style="primary" icon="bullhorn" title="Announcement" %}}Mandatory{{% /badge %}}
    {{% badge style="secondary" icon="bullhorn" title="Announcement" %}}Optional{{% /badge %}}
    {{% badge style="accent" icon="bullhorn" title="Announcement" %}}Special{{% /badge %}}

AnnouncementMandatory AnnouncementOptional AnnouncementSpecial

#### By Color

    {{% badge style="blue" icon="palette" title="Color" %}}Blue{{% /badge %}}
    {{% badge style="green" icon="palette" title="Color" %}}Green{{% /badge %}}
    {{% badge style="grey" icon="palette" title="Color" %}}Grey{{% /badge %}}
    {{% badge style="orange" icon="palette" title="Color" %}}Orange{{% /badge %}}
    {{% badge style="red" icon="palette" title="Color" %}}Red{{% /badge %}}

ColorBlue ColorGreen ColorGrey ColorOrange ColorRed

#### By Special Color

    {{% badge style="default" icon="palette" title="Color" %}}Default{{% /badge %}}
    {{% badge style="transparent" icon="palette" title="Color" %}}Transparent{{% /badge %}}

ColorDefault ColorTransparent

### Variants

#### Without Icon and Title Text

    {{% badge %}}6.6.6{{% /badge %}}
    {{% badge style="info" icon=" " title=" " %}}Awesome{{% /badge %}}
    {{% badge style="red" %}}Captain{{% /badge %}}

6.6.6 Awesome Captain

#### Without Icon

    {{% badge title="Version" %}}6.6.6{{% /badge %}}
    {{% badge style="info" icon=" " %}}Awesome{{% /badge %}}
    {{% badge style="red" title="Rank" %}}Captain{{% /badge %}}

Version6.6.6 InfoAwesome RankCaptain

#### Without Title Text

    {{% badge icon="star" %}}6.6.6{{% /badge %}}
    {{% badge style="info" title=" " %}}Awesome{{% /badge %}}
    {{% badge style="red" icon="angle-double-up" %}}Captain{{% /badge %}}

6.6.6 Awesome Captain

#### All Set

    {{% badge icon="star" title="Version" %}}6.6.6{{% /badge %}}
    {{% badge style="info" %}}Awesome{{% /badge %}}
    {{% badge style="red" icon="angle-double-up" title="Rank" %}}Captain{{% /badge %}}

Version6.6.6 InfoAwesome RankCaptain

#### Override for Severity

    {{% badge style="info" icon="rocket" title="Feature" %}}Awesome{{% /badge %}}

FeatureAwesome

### Other

#### With User-Defined Color and Font Awesome Brand Icon

    {{% badge color="fuchsia" icon="fab fa-hackerrank" %}}Awesome{{% /badge %}}

Awesome

#### With Icon Content

You can combine the badge with the `icon` shortcode to create even more stunning visuals.

In this case you need to declare `{{< badge >}}` instead of `{{% badge %}}`. Note, that in this case it is not possible to put markdown in the content.

    {{< badge style="primary" icon="angle-double-up" >}}{{% icon skull-crossbones %}}{{< /badge >}}
    {{< badge style="primary" icon="angle-double-up" >}}{{% icon skull-crossbones %}} Pirate{{< /badge >}}
    {{< badge style="primary" title="Rank" >}}{{% icon skull-crossbones %}}{{< /badge >}}
    {{< badge style="primary" title="Rank" >}}{{% icon skull-crossbones %}} Pirate{{< /badge >}}
    {{< badge style="primary" icon="angle-double-up" title="Rank" >}}{{% icon skull-crossbones %}}{{< /badge >}}
    {{< badge style="primary" icon="angle-double-up" title="Rank" >}}{{% icon skull-crossbones %}} Pirate{{< /badge >}}

Pirate
Rank
Rank Pirate
Rank
Rank Pirate

#### Inside of Text

    Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. {{% badge style="blue" icon="rocket" %}}Awesome{{% /badge %}} Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.

Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Awesome Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.

# Button

The `button` shortcode displays a clickable button with adjustable color, title and icon.

Get Hugo Get Hugo

## Usage

While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.

    {{% button href="https://gohugo.io/" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="warning" icon="dragon" %}}Get Hugo{{% /button %}}

    {{ partial "shortcodes/button.html" (dict
        "context" .
        "href" "https://gohugo.io/"
        "content" "Get Hugo"
    )}}
    {{ partial "shortcodes/button.html" (dict
      "context" .
      "href" "https://gohugo.io/"
      "style" "warning"
      "icon" "dragon"
      "content" "Get Hugo"
    )}}

Once the button is clicked, it opens another browser tab for the given URL.

### Parameter

Name | Default | Notes
--- | --- | ---
href | <empty> | 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: `info`, `note`, `tip`, `warning` - by brand color: `primary`, `secondary`, `accent` - by color: `blue`, `green`, `grey`, `orange`, `red` - by special color: `default`, `transparent`
color | see notes | The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default. - 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)

## Examples

### Style

#### By Severity

    {{% button href="https://gohugo.io/" style="info" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="note" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="tip" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="warning" %}}Get Hugo{{% /button %}}

Get Hugo Get Hugo Get Hugo Get Hugo

#### By Brand Colors

    {{% button href="https://gohugo.io/" style="primary" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="secondary" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="accent" %}}Get Hugo{{% /button %}}

Get Hugo Get Hugo Get Hugo

#### By Color

    {{% button href="https://gohugo.io/" style="blue" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="green" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="grey" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="orange" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="red" %}}Get Hugo{{% /button %}}

Get Hugo Get Hugo Get Hugo Get Hugo Get Hugo

#### By Special Color

    {{% button href="https://gohugo.io/" style="default" %}}Get Hugo{{% /button %}}
    {{% button href="https://gohugo.io/" style="transparent" %}}Get Hugo{{% /button %}}

Get Hugo Get Hugo

### Icon

#### To the Left

    {{% button href="https://gohugo.io/" icon="download" %}}Get Hugo{{% /button %}}

Get Hugo

#### To the Right

    {{% button href="https://gohugo.io/" icon="download" iconposition="right" %}}Get Hugo{{% /button %}}

Get Hugo

#### Override for Severity

    {{% button href="https://gohugo.io/" icon="dragon" style="warning" %}}Get Hugo{{% /button %}}

Get Hugo

### Target

    {{% button href="https://gohugo.io/" target="_self" %}}Get Hugo in same window{{% /button %}}
    {{% button href="https://gohugo.io/" %}}Get Hugo in new Window/Frame (default){{% /button %}}

Get Hugo in same Window/Frame Get Hugo in new Window/Frame (default)

### Other

#### With User-Defined Color and Font Awesome Brand Icon

    {{% button href="https://gohugo.io/" color="fuchsia" icon="fab fa-hackerrank" %}}Hugo{{% /button %}}

Hugo

#### Severity Style with All Defaults

    {{% button href="https://gohugo.io/" style="tip" %}}{{% /button %}}

Tip

#### Button to Internal Page

    {{% button href="/index.html" %}}Home{{% /button %}}

Home

#### Button with JavaScript Action

If your JavaScript action does not change the focus afterwards, make sure to call `this.blur()` in the end to unselect the button.

    {{% button style="primary" icon="bullhorn" href="javascript:alert('Hello world!');this.blur();" %}}Shout it out{{% /button %}}

#### Button within a `form` Element

To use native HTML elements in your Markdown, add this in your `config.toml`

    [markup.goldmark.renderer]
        unsafe = true

    <form action="../../search.html" method="get">
      <input name="search-by-detail" class="search-by" type="search">
      {{% button type="submit" style="secondary" icon="search" %}}Search{{% /button %}}
    </form>

# Children

The `children` shortcode lists the child pages of the current page and its descendants.

- page X
- page 1
- page 2
- page 3

## Usage

While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.

    {{% children sort="weight" %}}

    {{ partial "shortcodes/children.html" (dict
      "context" .
      "sort" "weight"
    )}}

### Parameter

Name | Default | Notes
--- | --- | ---
containerstyle | `ul` | Choose the style used to group all children. It could be any HTML tag name.
style | `li` | Choose the style used to display each descendant. It could be any HTML tag name.
showhidden | `false` | When `true`, child pages hidden from the menu will be displayed as well.
description | `false` | When `true` shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - read more info about summaries on gohugo.io.
depth | `1` | The depth of descendants to display. For example, if the value is `2`, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. `999`.
sort | see notes | The sort order of the displayed list. If not set it is sorted by the `ordersectionsby` setting of the site and the pages frontmatter - `weight`: to sort on menu order - `title`: to sort alphabetically on menu label.

## Examples

### All Default

    {{% children  %}}

- page X
- page 1
- page 2
- page 3

### With Description

    {{% children description="true" %}}

- page X

  This is a plain page test, and the beginning of a YAML multiline description...

- page 1

  This is a demo child page

- page 2

  This is a demo child page with no description. So its content is used as description.

- page 3

  This is a demo child page

### Infinite Depth and Hidden Pages

    {{% children depth="999" showhidden="true" %}}

- page X
- page 1
  - page 1-1
    - page 1-1-1 (hidden)
      - page 1-1-1-1
        - page 1-1-1-1-1 (hidden)
          - page 1-1-1-1-1-1
    - page 1-1-2
      - page 1-1-2-1
      - page 1-1-2-2
    - page 1-1-3
- page 2
- page 3
  - page 3-1
- page 4 (hidden)

### Heading Styles for Container and Elements

    {{% children containerstyle="div" style="h2" depth="3" description="true" %}}

## page X

This is a plain page test, and the beginning of a YAML multiline description...

## page 1

This is a demo child page

### page 1-1

This is a demo child page

#### page 1-1-2

This is a demo child page

#### page 1-1-3

This is a demo child page

## page 2

This is a demo child page with no description. So its content is used as description.

## page 3

This is a demo child page

### page 3-1

This is a plain page test nested in a parent

### Divs for Group and Element Styles

    {{% children containerstyle="div" style="div" depth="3" %}}

page X
page 1
page 1-1
page 1-1-2
page 1-1-3
page 2
page 3
page 3-1

# Subsections of Children

# page X

This is a plain demo child page.

# page 1

This is a demo child page.

## Subpages of this page

- page 1-1

# Subsections of page 1

# page 1-1

This is a demo child page with a hidden child. You can still access the hidden child directly or via the search.

## Subpages of this page

- page 1-1-1 (hidden)
- page 1-1-2
- page 1-1-3

# Subsections of page 1-1

# page 1-1-2

This is a plain demo child page.

## Subpages of this page

- page 1-1-2-1
- page 1-1-2-2

# Subsections of page 1-1-2

# page 1-1-2-1

This is a plain demo child page.

# page 1-1-2-2

This is a plain demo child page.

# page 1-1-3

This is a plain demo child page.

# page 2

This is a demo child page with no description.

So its content is used as description.

# page 3

This is a demo child page.

## Subpages of this page

- page 3-1

# Subsections of page 3

# page 3-1

This is a plain demo child page.

# Expand

The `expand` shortcode displays an expandable/collapsible section of text.

Expand me...
Thank you!
Note

This only works in modern browsers flawlessly. While Internet Explorer 11 has issues in displaying it, the functionality still works.

## Usage

While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.

    {{% expand title="Expand me..." %}}Thank you!{{% /expand %}}

    {{% expand "Expand me..." %}}Thank you!{{% /expand %}}

    {{ partial "shortcodes/expand.html" (dict
      "context" .
      "title" "Expand me..."
      "content" "Thank you!"
    )}}

### Parameter

Name | Position | Default | Notes
--- | --- | --- | ---
title | 1 | `"Expand me..."` | Arbitrary text to appear next to the expand/collapse icon.
open | 2 | `false` | When `true` the content text will be initially shown as expanded.
<content> |  | <empty> | Arbitrary text to be displayed on expand.

## Examples

### All Defaults

    {{% expand %}}Yes, you did it!{{% /expand %}}

Expand me...
Yes, you did it!

### Initially Expanded

    {{% expand title="Expand me..." open="true" %}}No need to press you!{{% /expand %}}

Expand me...
No need to press you!

### Arbitrary Text

    {{% expand title="Show me almost endless possibilities" %}}
    You can add standard markdown syntax:

    - multiple paragraphs
    - bullet point lists
    - _emphasized_, **bold** and even **_bold emphasized_** text
    - [links](https://example.com)
    - etc.

    ```plaintext
    ...and even source code
    ```

    > the possibilities are endless (almost - including other shortcodes may or may not work)
    {{% /expand %}}

Show me almost endless possibilities

You can add standard markdown syntax:

- multiple paragraphs
- bullet point lists
- emphasized, bold and even bold emphasized text
- links
- etc.

    ...and even source code

> the possibilities are endless (almost - including other shortcodes may or may not work)

# Icon

The `icon` shortcode displays icons using the Font Awesome library.

## Usage

While the examples are using shortcodes with positional parameter you are free to also call this shortcode from your own partials.

    {{% icon icon="exclamation-triangle" %}}
    {{% icon icon="angle-double-up" %}}
    {{% icon icon="skull-crossbones" %}}

    {{% icon exclamation-triangle %}}
    {{% icon angle-double-up %}}
    {{% icon skull-crossbones %}}

    {{ partial "shortcodes/icon.html" (dict
        "context" .
        "icon" "exclamation-triangle"
    )}}
    {{ partial "shortcodes/icon.html" (dict
        "context" .
        "icon" "angle-double-up"
    )}}
    {{ partial "shortcodes/icon.html" (dict
        "context" .
        "icon" "skull-crossbones"
    )}}

### Parameter

Name | Position | Default | Notes
--- | --- | --- | ---
icon | 1 | <empty> | 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)
- Increase or decrease size
- Rotate
- Combine with other icons

Check the full documentation on web fonts with CSS for more.

## Examples

### Standard Usage

    Built with {{% icon heart %}} by Relearn and Hugo

Built with by Relearn and Hugo

### Advanced HTML Usage

While the shortcode simplyfies using standard icons, the icon customisation and other advanced features of the Font Awesome library requires you to use HTML directly. Just paste the `<i>` HTML into markup and Font Awesome will load the relevant icon.

    Built with <i class="fas fa-heart"></i> by Relearn and Hugo

Built with by Relearn and Hugo

# Include

The `include` shortcode includes other files from your project inside of the current page.

## Usage

While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials.

    {{% include file="shortcodes/INCLUDE_ME.md" %}}

    {{% include "shortcodes/INCLUDE_ME.md" %}}

    {{ partial "shortcodes/include .html" (dict
      "context" .
      "file" "shortcodes/INCLUDE_ME.md"
    )}}

The included files can even contain Markdown and will be taken into account when generating the table of contents.

### Parameter

Name | Position | Default | Notes
--- | --- | --- | ---
file | 1 | <empty> | The path to the file to be included. Path resolution adheres to Hugo’s build-in `readFile` function
hidefirstheading | 2 | `false` | When `true` and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files.

## Examples

### Arbitrary Content

    {{% include "shortcodes/INCLUDE_ME.md" %}}

You can add standard markdown syntax:

- multiple paragraphs
- bullet point lists
- emphasized, bold and even bold emphasized text
- links
- etc.

    ...and even source code

> the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)

# Math

The `math` shortcode generates beautiful formatted math and chemical formulae using the MathJax library.

$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
Note

This only works in modern browsers.

## Usage

While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable.

You are free to also call this shortcode from your own partials.

Note

To use codefence syntax you have to turn off `guessSyntax` for the `markup.highlight` setting (see the configuration section).

    ```math { align="center" }
    $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
    ```

    {{< math align="center" >}}
    $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
    {{< /math >}}

    {{ partial "shortcodes/math.html" (dict
      "context" .
      "content" "$$left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$"
      "align"   "center"
    )}}

### Parameter

Name | Default | Notes
--- | --- | ---
align | `center` | Allowed values are `left`, `center` or `right`.
<content> | <empty> | Your formuale.

## Configuration

MathJax is configured with default settings. You can customize MathJax’s default settings for all of your files thru a JSON object in your `config.toml` or override these settings per page thru your pages frontmatter.

The JSON object of your `config.toml` / frontmatter is forwarded into MathJax’s configuration object.

See MathJax documentation for all allowed settings.

Note

To use codefence syntax you have to turn off `guessSyntax` for the `markup.highlight` setting.

### Global Configuration File

    [params]
      mathJaxInitialize = "{ \"chtml\": { \"displayAlign\": \"left\" } }"

    [markup]
      [markup.highlight]
        # if `guessSyntax = true`, there will be no unstyled code even if no language
        # was given BUT Mermaid and Math codefences will not work anymore! So this is a
        # mandatory setting for your site if you want to use Math codefences
        guessSyntax = false

### Page’s Frontmatter

    +++
    mathJaxInitialize = "{ \"chtml\": { \"displayAlign\": \"left\" } }"
    +++

## Examples

### Inline Math

    Inline math is generated if you use a single `$` as a delimiter around your formulae: {{< math >}}$\sqrt{3}${{< /math >}}

Inline math is generated if you use a single `$` as a delimiter around your formulae: $\sqrt{3}$

### Blocklevel Math with Right Alignment

    If you delimit your formulae by two consecutive `$$` it generates a new block.

    {{< math align="right" >}}
    $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
    {{< /math >}}

If you delimit your formulae by two consecutive `$$` it generates a new block.

$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$

### Codefence

You can also use codefences.

    ```math
    $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
    ```

$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$

### Chemical Formulae

    {{< math >}}
    $$\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}$$
    {{< /math >}}

$$\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}$$

# Mermaid

The `mermaid` shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the Mermaid library.

graph LR; If --> Then Then --> Else
Note

This only works in modern browsers.

Warning

Due to limitations with Mermaid, it is currently not possible to use Mermaid code fences in an initially collapsed `expand` shortcode. This is a know issue and can’t be fixed by this theme.

## Usage

While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.

You are free to also call this shortcode from your own partials.

Note

To use codefence syntax you have to turn off `guessSyntax` for the `markup.highlight` setting (see the configuration section).

    ```mermaid { align="center" zoom="true" }
    graph LR;
        If --> Then
        Then --> Else
    ```

    {{< mermaid align="center" zoom="true" >}}
    graph LR;
        If --> Then
        Then --> Else
    {{< /mermaid >}}

    {{ partial "shortcodes/mermaid.html" (dict
      "context" .
      "content" "graph LR;\nIf --> Then\nThen --> Else"
      "align"   "center"
      "zoom"    "true"
    )}}

The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.

### Parameter

Name | Default | Notes
--- | --- | ---
align | `center` | 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 the site or the pages frontmatter or `false` if not set at all. - `false`: no pan or zoom - `true`: pan and zoom active
<content> | <empty> | Your Mermaid graph.

## Configuration

Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files thru a JSON object in your `config.toml`, override these settings per page thru your pages frontmatter or override these setting per diagramm thru diagram directives.

The JSON object of your `config.toml` / frontmatter is forwarded into Mermaid’s `mermaid.initialize()` function.

See Mermaid documentation for all allowed settings.

The `theme` setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in `config.toml`, frontmatter or diagram directives.

Note

To use codefence syntax you have to turn off `guessSyntax` for the `markup.highlight` setting.

### Global Configuration File

    [params]
      mermaidInitialize = "{ \"theme\": \"dark\" }"
      mermaidZoom = true

    [markup]
      [markup.highlight]
        # if `guessSyntax = true`, there will be no unstyled code even if no language
        # was given BUT Mermaid and Math codefences will not work anymore! So this is a
        # mandatory setting for your site if you want to use Mermaid codefences
        guessSyntax = false

### Page’s Frontmatter

    +++
    mermaidInitialize = "{ \"theme\": \"dark\" }"
    mermaidZoom = true
    +++

## Examples

### Flowchart with Non-Default Mermaid Theme

    {{< mermaid >}}
    %%{init:{"theme":"forest"}}%%
    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]
    {{< /mermaid >}}

%%{init:{"theme":"forest"}}%% 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!
    {{< /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!

### Class Diagram with Codefence Syntax

    ```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

    {{< mermaid align="right" >}}
    stateDiagram-v2
        open: Open Door
        closed: Closed Door
        locked: Locked Door
        open   --> closed: Close
        closed --> locked: Lock
        locked --> closed: Unlock
        closed --> open: Open
    {{< /mermaid >}}

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

    {{< mermaid >}}
    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"
    {{< /mermaid >}}

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
    {{< /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

### 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
    {{< /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

### Pie Chart without Zoom

    {{< mermaid zoom="false" >}}
    pie title Pets adopted by volunteers
        "Dogs" : 386
        "Cats" : 85
        "Rats" : 15
    {{< /mermaid >}}

pie title Pets adopted by volunteers "Dogs" : 386 "Cats" : 85 "Rats" : 15

### 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
    {{< /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

### Git Graph

    {{< mermaid >}}
    gitGraph
        commit
        commit
        branch develop
        checkout develop
        commit
        commit
        checkout main
        merge develop
        commit
        commit
    {{< /mermaid >}}

gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit

### C4 Diagrams

    {{< mermaid >}}
    C4Context
        title System Context diagram for Internet Banking System
        Enterprise_Boundary(b0, "BankBoundary0") {
        Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
        Person(customerB, "Banking Customer B")
        Person_Ext(customerC, "Banking Customer C", "desc")

        Person(customerD, "Banking Customer D", "A customer of the bank, <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")
    {{< /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")

# 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

While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.

    {{% notice style="primary" title="There may be pirates" icon="skull-crossbones" %}}
    It is all about the boxes.
    {{% /notice %}}

    {{% notice primary "There may be pirates" "skull-crossbones" %}}
    It is all about the boxes.
    {{% /notice %}}

    {{ partial "shortcodes/notice.html" (dict
      "context" .
      "style" "primary"
      "title" "There may be pirates"
      "icon" "skull-crossbones"
      "content" "It is all about the boxes."
    )}}

### Parameter

Name | Position | Default | Notes
--- | --- | --- | ---
style | 1 | `default` | The style scheme used for the box. - by severity: `info`, `note`, `tip`, `warning` - by brand color: `primary`, `secondary`, `accent` - by color: `blue`, `green`, `grey`, `orange`, `red` - by special color: `default`, `transparent`
color |  | see notes | The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default. - for severity styles: a nice matching color for the severity - for all other styles: the corresponding color
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)
<content> |  | <empty> | Arbitrary text to be displayed in box.

## Examples

### By Severity

#### Info with markup

    {{% notice style="info" %}}
    An **information** disclaimer

    You can add standard markdown syntax:

    - multiple paragraphs
    - bullet point lists
    - _emphasized_, **bold** and even ***bold emphasized*** text
    - [links](https://example.com)
    - etc.

    ```plaintext
    ...and even source code
    ```

    > the possibilities are endless (almost - including other shortcodes may or may not work)
    {{% /notice %}}

Info

An information disclaimer

You can add standard markdown syntax:

- multiple paragraphs
- bullet point lists
- emphasized, bold and even bold emphasized text
- links
- etc.

    ...and even source code

> the possibilities are endless (almost - including other shortcodes may or may not work)

#### Note

    {{% notice style="note" %}}
    A **notice** disclaimer
    {{% /notice %}}

Note

A notice disclaimer

#### Tip

    {{% notice style="tip" %}}
    A **tip** disclaimer

Tip

A tip disclaimer

#### Warning

    {{% notice style="warning" %}}
    A **warning** disclaimer
    {{% /notice %}}

Warning

A warning disclaimer

#### Warning with Non-Default Title and Icon

    {{% notice style="warning" title="Here are dragons" icon="dragon" %}}
    A **warning** disclaimer
    {{% /notice %}}

Here are dragons

A warning disclaimer

#### Warning without a Title and Icon

    {{% notice style="warning" title=" " icon=" " %}}
    A **warning** disclaimer
    {{% /notice %}}

A warning disclaimer

### By Brand Colors

#### Primary with Title only

    {{% notice style="primary" title="Primary" %}}
    A **primary** disclaimer
    {{% /notice %}}

Primary

A primary disclaimer

#### Secondary with Icon only

    {{% notice style="secondary" icon="stopwatch" %}}
    A **secondary** disclaimer
    {{% /notice %}}

A secondary disclaimer

#### Accent

    {{% notice style="accent" %}}
    An **accent** disclaimer
    {{% /notice %}}

An accent disclaimer

### By Color

#### Blue without a Title and Icon

    {{% notice style="blue" %}}
    A **blue** disclaimer
    {{% /notice %}}

A blue disclaimer

#### Green with Title only

    {{% notice style="green" title="Green" %}}
    A **green** disclaimer
    {{% /notice %}}

Green

A green disclaimer

#### Grey with Icon only

    {{% notice style="grey" icon="bug" %}}
    A **grey** disclaimer
    {{% /notice %}}

A grey disclaimer

#### Orange with Title and Icon

    {{% notice style="orange" title="Orange" icon="bug" %}}
    A **orange** disclaimer
    {{% /notice %}}

Orange

A orange disclaimer

#### Red without a Title and Icon

    {{% notice style="red" %}}
    A **red** disclaimer
    {{% /notice %}}

A red disclaimer

### By Special Color

#### Default with Positional Parameter

    {{% notice default "Pay Attention to this Note!" "skull-crossbones" %}}
    Some serious information.
    {{% /notice %}}

Pay Attention to this Note!

Some serious information.

#### Transparent with Title and Icon

    {{% notice style="transparent" title="Pay Attention to this Note!" icon="skull-crossbones" %}}
    Some serious information.
    {{% /notice %}}

Pay Attention to this Note!

Some serious information.

### With User-Defined Color and Font Awesome Brand Icon

    {{% notice color="fuchsia" title="Hugo" icon="fab fa-hackerrank" %}}
    Victor? Is it you?
    {{% /notice %}}

Hugo

Victor? Is it you?

# Site param

The `siteparam` shortcode prints values of site params.

## Usage

While the examples are using shortcodes with named parameter you are free to use positional aswell or call this shortcode from your own partials.

    {{% siteparam name="editURL" %}}

    {{% siteparam "editURL" %}}

    {{ partial "shortcodes/siteparam.html" (dict
      "context" .
      "name" "editURL"
    )}}

### Parameter

Name | Position | Default | Notes
--- | --- | --- | ---
name | 1 | <empty> | The name of the site param to be displayed.

## Examples

### `editURL` from `config.toml`

    `editURL` value: {{% siteparam name="editURL" %}}

`editURL` value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/

# Swagger

The `swagger` shortcode uses the RapiDoc library to display your Swagger / OpenAPI Specifications.

Note

This only works in modern browsers.

## Usage

While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.

    {{< swagger src="https://petstore3.swagger.io/api/v3/openapi.json" >}}

    {{ partial "shortcodes/swagger.html" (dict
      "context" .
      "src" "https://petstore3.swagger.io/api/v3/openapi.json"
    )}}

### Parameter

Name | Default | Notes
--- | --- | ---
src | <empty> | The URL to the OpenAPI Specification file. This can be relative to the URL of your page if it is a leaf or branch bundle.

Note

If you want to print out (or generate a PDF) from your Swagger 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.

## Configuration

Swagger is configured with default settings. You can customize Swagger’s default settings for all of your files thru a JSON object in your `config.toml` or override these settings per page thru your pages frontmatter.

The JSON object of your `config.toml` / frontmatter is forwarded into Swagger’s initialization. At the moment, only the `theme` setting is supported.

The `theme` setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in `config.toml` or frontmatter.

### Global Configuration File

    [params]
      swaggerInitialize = "{ \"theme\": \"dark\" }"

## Example

### Using Local File

    {{< swagger src="petstore.json" >}}

# Tabs

The `tabs` shortcode displays arbitrary content in unlimited number of tabs.

This comes in handy eg. for providing code snippets for multiple languages or providing configuration in different formats.

    print("Hello World!")

    echo "Hello World!"

## Usage

While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.

    {{< tabs >}}
    {{% tab name="python" %}}
    ```python
    print("Hello World!")
    ```
    {{% /tab %}}
    {{% tab name="bash" %}}
    ```bash
    echo "Hello World!"
    ```
    {{% /tab %}}
    {{< /tabs >}}

    {{ partial "shortcodes/tabs.html" (dict
      "context" .
      "tabs" (slice
        (dict
          "name" "python"
          "content" ("```python\nprint(\"Hello World!\")\n```" | markdownify)
        )
        (dict
          "name" "bash"
          "content" ("```bash\necho \"Hello World!\"\n```" | markdownify)
        )
      )
    )}}

### Parameter

Name | Default | Notes
--- | --- | ---
groupid | `default` | Arbitrary name of the group the tab view belongs to. Tab views with the same groupid sychronize their selected tab. This sychronization applies to the whole site!
<content> | <empty> | Arbitrary number of tabs defined with the `tab` sub-shortcode.

Note

When using tab views with different content sets, make sure to use a common `groupid` for equal sets of tabs but distinct `groupid` for different sets.

The tab selection is restored automatically based on the `groupid` and if it cannot find a tab item because it came from the `'default'` group on a different page then the first tab is selected instead.

## Examples

### Distinct `groupid`

    {{< tabs groupid="config" >}}
    {{% tab name="json" %}}
    ```json
    {
      "Hello": "World"
    }
    ```
    {{% /tab %}}
    {{% tab name="XML" %}}
    ```xml
    <Hello>World</Hello>
    ```
    {{% /tab %}}
    {{% tab name="properties" %}}
    ```properties
    Hello = World
    ```
    {{% /tab %}}
    {{< /tabs >}}

    {
      "Hello": "World"
    }

    <Hello>World</Hello>

    Hello = World

### Non-Distinct `groupid`

See what happens to this tab view if you select properties tab from the previous example.

    {{< tabs groupid="config" >}}
    {{% tab name="json" %}}
    ```json
    {
      "Hello": "World"
    }
    ```
    {{% /tab %}}
    {{% tab name="XML" %}}
    ```xml
    <Hello>World</Hello>
    ```
    {{% /tab %}}
    {{< /tabs >}}

    {
      "Hello": "World"
    }

    <Hello>World</Hello>

### Nested Tabs

In case you want to nest tabs, the parent tab that contains the subtabs 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.

    {{< tabs groupid="main" >}}
    {{< tab name="Text" >}}
      Simple text is possible here...
      {{< tabs groupid="tabs-example-language" >}}
      {{% tab name="python" %}}
      Python is **super** easy.

      - most of the time.
      - if you don't want to output unicode
      {{% /tab %}}
      {{% tab name="bash" %}}
      Bash is for **hackers**.
      {{% /tab %}}
      {{< /tabs >}}
    {{< /tab >}}

    {{< tab name="Code" >}}
      ...but no markdown
      {{< tabs groupid="tabs-example-language" >}}
      {{% tab name="python" %}}
      ```python
      print("Hello World!")
      ```
      {{% /tab %}}
      {{% tab name="bash" %}}
      ```bash
      echo "Hello World!"
      ```
      {{% /tab %}}
      {{< /tabs >}}
    {{< /tab >}}
    {{< /tabs >}}

Simple text is possible here...

Python is super easy.

- most of the time.
- if you don’t want to output unicode

Bash is for hackers.

...but no markdown

    print("Hello World!")

    echo "Hello World!"