# Basics :: Cap'n Hugo Relearrrn Theme
Documentation for Hugo Relearn Theme
Author: Sören Weber

T' chapterrr 1

# Basics

Arrr! Pirrrates

Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.

Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.

# Subsct'ns o' Basics

# What's New

Arrr! Pirrrates

Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.

This document shows ye what’s new 'n th' latest release. For a detailed list o' changes, see th' history plank.

0.95.0 Th' minimum required Cap'n Hugo version.

Break'n A change that requires act'n by ye aft upgrad'n t' assure th' ship be still functional.

Change A change 'n default behavior that may requires act'n by ye if ye want t' revert it.

New Marks new behavior ye might find interest'n or comes configur'ble.

## 5.11.0 (2023-02-06)

- Change Th' theme removed th' popular jQuery library from its distribut'n.

  In case ye made changes t' th' theme that be dependend on this library ye can place a copy o' jQuery into yer `static/js` directory an' board it from yer own `layouts/partials/custom-header.html` like this:

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

- Change Merrrmaid diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.

  Th' default sett'n o' `on`, 'n effect since 1.1.0, changed back t' `off` as there was interference wit' scroll'n on mobile an' big planks.

- Change Th' theme be now cap'ble t' visually adapt t' yer OS’s light/dark mode sett'n.

  This be also th' new default sett'n if ye haven’t configured `themeVariant` 'n yer `config.toml`.

  Additionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new `themeVariantAuto` parameter.

  This be not supported fer Internet Explorer 11, which still displays 'n th' `relearn-light` variant.

- Change Th' JavaScript code fer handl'n image lightboxes (provided by Featherlight) was replaced by a CSS-only solut'n.

  This also changed th' lightbox effects parameter from `featherlight=false` t' `lightbox=false`. Nevertheless ye don’t need t' change anyth'n as th' old name will be used as a fallback.

- Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' `expand` shortcode was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.

- New Translat'n fer Czech. This language be not supported fer search.

- New GitHub releases be also now tagged fer th' main version (eg. `1.2.x`), major version (eg. `1.x`) an' th' latest (just `x`) release mak'n it easier fer ye t' pin th' theme t' a certain version.

## 5.10.0 (2023-01-25)

- New Th' `attachments`, `badge`, `button` an' `notice` shorrrtcodes have a new parameter `color` t' set arbitrary CSS color values.

  Additionally th' `--ACCENT-color` brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.

## 5.9.0 (2022-12-23)

- Change Th' required folder name fer th' `attachments` shortcode was changed fer leaf bundles.

  Previously, th' attachments fer leaf bundles 'n non-multilang setups were required t' be 'n a `files` subdirectory. For plank bundles an' leaf bundles 'n multilang setups they were always required t' be 'n a `_index.<LANGCODE>.files` or `index.<LANGCODE>.files` subdirectory accordingly.

  This added unnessessary complexity. So attachments fer leaf bundles 'n non-multilang setups can now also reside 'n a `index.files` directory. Although th' old `files` directory be now deprecated, if both directories be present, only th' old `files` directory will be used fer compatiblity.

- Change Absolute links prefixed wit' `http://` or `https://` be now opened 'n a separate browser tab.

  Ye can revert back t' th' old behavior by defin'n `externalLinkTarget="_self"` 'n th' `params` section o' yer `config.toml`.

- New Th' theme now supports Hugo’s module system.

## 5.8.0 (2022-12-08)

- New Th' new `badge` shortcode be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.

- New Th' new `ay'con` shortcode simplyfies th' usage o' ay'cons. This can even be combined wit' also new `badge` shortcode.

- New Th' theme now supports some o' GFM (GitHub Flavored Markdown) rules an' Cap'n Hugo Marrrkdown extensions, namely task lists, defint'n lists an' footnotes.

- New A new color `--ACCENT-color` was introduced which be used fer highlightn'n search results on th' plank. In case ye simply don’t care, ye don’t need t' change anyth'n 'n yer variant stylesheet as th' old `yellow` color be still used as default.

## 5.7.0 (2022-11-29)

- Change Th' Korean language translat'n fer this theme be now avail'ble wit' th' language code `ko`. Formerly th' country code `kr` was used instead.

- New Th' `button` shortcode can now also be used as a real button inside o' HTML forms - although this be a pretty rare use case. Th' documentat'n was updated accordingly.

- New Th' search now supports th' Korean language.

## 5.6.0 (2022-11-18)

- New This release introduces an additional dedicated search plank. On this plank, displayed search results have more space mak'n it easier scann'n thru large number o' results.

  T' activate this feature, ye need t' configure it 'n yer `config.toml` as a new outputformat `SEARCHPAGE` fer th' home plank. If ye don’t configure it, no dedicated search plank will be access'ble an' th' theme works as before.

  Ye can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.

- New Keyboard handl'n fer th' TOC an' search was improved.

  Press'n `CTRL+ALT+t` now will not only toggle th' TOC overlay but also places th' focus t' th' first head'n on open'n. Subsequently this makes it poss'ble t' easily select head'ns by us'n th' `TAB` key.

  Th' search received its own brand new keyboard shortcut `CTRL+ALT+f`. This will focus th' cursor inside o' th' the search box so ye can immediately start yer search by typ'n.

- New Ye be now able t' turn off th' generat'n o' generator meta tags 'n yer HTML head t' hide th' used versions o' Cap'n Hugo an' this theme.

  T' configure this 'n yer `config.toml` make sure t' set Hugo’s `disableHugoGeneratorInject=true` an' also `[params] disableGeneratorVersion=true`, otherwise Cap'n Hugo will generate a meta tag into yer home plank automagically.

- New Creat'n o' yer project gets a little bit faster wit' this release.

  This addresses increased build time wit' th' 5.x releases. Th' theme now heavily caches partial results lead'n t' improved performance. T' further increase performance, unnecessary parts o' th' plank be now skipped fer creat'n o' th' print output (eg. menus, navigat'n bar, etc.).

## 5.5.0 (2022-11-06)

- Change Th' way images be processed has changed. Now images be lazy boarded by default which speeds up plank board on slow networks and/or big planks an' also th' print preview.

  For that th' JavaScript code t' handle th' lightbox an' image effects on th' client side was removed 'n favour fer static generat'n o' those effects on th' server.

  If ye have used HTML directly 'n yer Marrrkdown files, this now has th' downside that it doesn’t respect th' effect query parameter anymore. In this case ye have t' migrate all yer HTML `img` URLs manually t' th' 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 Wit' th' proper sett'ns 'n yer `config.toml` yer plank be now serv'ble from th' local file system us'n `file://` URLs.

  Please note that th' searchbox will only work fer this if ye reconfigure yer outputformat fer th' homepage 'n yer `config.toml` from `JSON` t' `SEARCH`. Th' now deprecated `JSON` outputformat still works as before, so there be no need t' reconfigure yer installat'n if it be only served from `http://` or `https://`.

- Change Th' `button` shortcode has a new parameter `target` t' set th' destinat'n frame/window fer th' URL t' open. If not given, it defaults t' a new window/tab fer external URLs or be not set at all fer internal URLs. Previously even internal URLs whar' opened 'n a new window/tab.

- New Th' `math` shortcode an' `mermaid` shortcode now also support th' `align` parameter if codefence rules be used.

- New Support fer languages that be written right t' left (like Arabic). This be only implemented fer th' rrrambl'n area but not th' navigat'n sidebar. This feature be not avail'ble 'n Internet Explorer 11.

- New Translat'n fer Finnish (Suomi).

## 5.3.0 (2022-10-07)

- Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Th' functionality o' th' new implementat'n does not work wit' old browsers (Internet Explorer 11).

- New Image formatt'n has two new classes t' align images t' th' `left` or `right`. Additionally, th' already exist'n `inline` opt'n be now documented.

- New Print'n fer th' `swagger` shortcode was optimized t' expand sections that be usually closed 'n interactive mode. This requires print support t' be configured.

## 5.2.0 (2022-08-03)

- Change If you’ve set `collapsibleMenu = true` 'n yer `config.toml`, th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus.

## 5.1.0 (2022-07-15)

- 0.95.0 This release requires a newer Cap'n Hugo version.

- Change Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a `index.print.html` t' th' default URL.

  Ye can revert this behavior by overwrit'n th' PRINT output format sett'n 'n yer `config.toml`t':

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

## 5.0.0 (2022-07-05)

- Break'n Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case you’ve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate `*.js` file (if not already) an' add th' `defer` keyword t' th' `script` element. Eg.

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

- Change Th' way archetypes be used t' generate output has changed. Th' new systems allows ye, t' redefine exist'n archetypes or even generate yer own ones.

  Yer exist'n markdown files will still work like before an' therefore ye don’t need t' change anyth'n aft th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:

  - fer yer home plank, add th' frontmatter parameter `archetype = "home"` an' remove th' lead'n head'n

  - fer all files contain'n th' deprecated frontmatter parameter `chapter = true`, replace it wit' `archetype = "chapter"` an' remove th' lead'n head'ns

- Change Th' frontmatter opt'ns `pre` / `post` were renamed t' `menuPre` / `menuPost`. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n aft th' upgrade.

- New Add'n new partials `heading-pre.html` / `heading-post.html` an' accord'n frontmatter opt'ns `headingPre` / `headingPost` t' modify th' way yer page`s main head'n gets styled.

- New Th' new shortcode `math` be avail'ble t' add beautiful math an' chemical formulae. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.

## 4.2.0 (2022-06-23)

- Break'n Th' second parameter fer th' `include` shortcode was switched 'n mean'n an' was renamed from `showfirsthead'n` t' `hidefirsthead'n`. If ye haven’t used this parameter 'n yer shortcode, th' default behavior hasn’t changed an' ye don’t need t' change anyth'n.

  If you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.

- Change Previously, if th' `tabs` shortcode could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.

- Change Th' `landingPageURL` was removed from `config.toml`. Ye can safely remove this as well from yer configurat'n as it be not used anymore. Th' theme will detect th' land'n plank URL automatically.

- New All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.

## 4.1.0 (2022-06-12)

- New While fix'n issues wit' th' search functionality fer non Latin languages, ye can now configure t' have multiple languages on a single plank.

## 4.0.0 (2022-06-05)

- Break'n Th' `custom_css` config parameter was removed from th' configurat'n. If used 'n an exist'n installat'n, it can be achieved by overrid'n th' `custom-header.html` template 'n a much more generic manner.

- Break'n Because anchor hover color was not configur'ble without introduc'n more complexity t' th' variant stylesheets, we decided t' remove `--MAIN-ANCHOR-color` instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' anchors now get their colors from `--MAIN-LINK-color` an' `--MAIN-ANCHOR-HOVER-color` respectively.

- New All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.

  This applies t' `expand`, `include`, `notice` an' `siteparam`.

- New Th' `button` shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.

- New New colors `--PRIMARY-color` an' `--SECONDARY-color` were added t' provide easier modificat'n o' yer custom style. Shorrrtcodes wit' a color style can now have `primary` or `secondary` as additional values.

  These two colors be th' default fer other, more specific color variables. Ye don’t need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.

- New Translat'n fer Polish. This language be not supported fer search.

- New Th' documentat'n fer all shorrrtcodes were revised.

## 3.4.0 (2022-04-03)

- Break'n If ye had previously overwritten th' `custom-footer.html` partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial `content-footer.html`. `custom-footer.html` was never meant t' contain HTML other than additional styles an' JavaScript.

- New If ye prefer expandable/collaps'ble menu items, ye can now set `collapsibleMenu=true` 'n yer `config.toml`. This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.

- New Ye can activate print support 'n yer `config.toml` t' add th' capability t' print whole chapters or even th' complete ship.

- New Translat'n fer Traditional Chinese.

## 3.3.0 (2022-03-28)

- New Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishes between `--MAIN-font` fer all rrrambl'n text an' `--CODE-font` fer inline or block code. There be additional overrides fer all head'ns. See th' theme variant generator o' th' exampleSite fer all avail'ble variables.

- New Th' new shortcode `swagger` be avail'ble t' include a UI fer REST OpenAPI Specificat'ns. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.

## 3.2.0 (2022-03-19)

- 0.93.0 This release requires a newer Cap'n Hugo version.

- Change In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shortcode or be us'n Merrrmaid codefences. This changes th' behavior o' `disableMermaid` config opt'n as follows: If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.

  Th' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shortcode or codefence be involved an' th' library be not boarded by default. In this case ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' be boarded. See th' theme variant generator o' th' exampleSite fer an example.

- New Additional color variant vari'ble `--MERMAID-theme` t' set th' variant’s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.

## 3.1.0 (2022-03-15)

- New `attachment` an' `notice` shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all Font Awesome 5 Free ay'cons.

## 3.0.0 (2022-02-22)

- Break'n We made changes t' th' menu footer. If ye have yer `menu-footer.html` partial overridden, ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' `menu-footer.html` partial that be com'n wit' th' exampleSite.

  This change was made t' allow yer own menu footer t' be placed right aft th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' Clear history functionality).

- Break'n We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.

  This change will only affect yer installat'n if you’ve not set th' `themeVariant` parameter 'n yer `config.toml`. If ye still want t' use th' Learrrn color variant, ye have t' explicitly set `themeVariant="learn"` 'n yer `config.toml`.

  Avast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.

- Change Due t' a bug, that we couldn’t fix 'n a general manner fer color variants, we decided t' remove `--MENU-SEARCH-BOX-ICONS-color` an' introduced `--MENU-SEARCH-color` instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.

- Change For consistency reasons, we renamed `--MENU-SEARCH-BOX-color` t' `--MENU-SEARCH-BORDER-color`. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.

- New Wit' this release ye be now cap'ble t' define yer own dark mode variants.

  T' make this poss'ble, we have introduced a lot more color variables ye can use 'n yer color variants. Yer old variants will still work an' don’t need t' be changed as appropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.

  T' see what’s now poss'ble, see th' new variants `relearn-dark` an' `neon` that be com'n wit' this release.

- New T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive theme variant generator. This feature will not work wit' Internet Explorer 11.

- New Ye can now configure multiple color variants 'n yer `config.toml`. In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer. See th' documentat'n fer configurat'n.

  Avast, that th' new variant switch will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant switcher will not be displayed wit' Internet Explorer 11.

## 2.9.0 (2021-11-19)

- Break'n This release removes th' themes implementat'n o' `ref`/`relref` 'n favor fer Hugos standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.

  In a standard compliant form ye must not link t' th' `*.md` file but t' its logical name. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:

  Type | Non-Standard | Standard
  --- | --- | ---
  Branch bundle | `basics/configuration/_index.md` | `basics/configurat'n`
  Leaf bundle | `basics/configuration/index.md` | `basics/configurat'n`
  Plank | `basics/configurat'n.md` | `basics/configurat'n`

  If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but Cap'n Hugo got ye covered as well.

  Also, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugos implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can reconfigure th' error handl'n o' Hugos implementat'n.

  In th' best case yer usage o' th' old implementat'n be already standard compliant an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started `hugo server` aft an upgrade an' no errors be written t' th' console.

  Ye may see errors on th' console aft th' update 'n th' 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": plank not found

  In this case, ye must apply one o' two opt'ns:

  1. Copy th' old implementat'n files `theme/hugo-theme-relearn/layouts/shortcode/ref.html` an' `theme/hugo-theme-relearn/layouts/shortcode/relref.html` t' yer own projects `layouts/shortcode/ref.html` an' `layouts/shortcode/relref.html` respectively. This be not recommended as yer project will still rely on non-standard behavior afterwards.

  2. Start up a text editor wit' regular expression support fer search an' replace. Apply th' follow'n conversions 'n th' given order on all `*.md` files. This be th' recommended choice.

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

## 2.8.0 (2021-11-03)

- Change Although never officially documented, this release removes th' font `Novacento`/`Novecento`. If ye use it 'n an overwritten CSS please replace it wit' `Work Sans`. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer Czech.

- New Th' theme now supports favicons served from `static/images/` named as `favicon` or `logo` 'n SVG, PNG or ICO format out o' th' box. An overridden partial `layouts/partials/favicon.html` may not be necessary anymore 'n most cases.

- New Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' `disableToc` opt'n 'n yer `config.toml`. For an example see th' example configurat'n.

## 2.7.0 (2021-10-24)

- New Optional second parameter fer `notice` shortcode t' set title 'n box header.

## 2.6.0 (2021-10-21)

- New Yer ship can now be served from a subfolder if ye set `baseURL` an' `canonifyURLs=true` 'n yer `config.toml`. See th' documentat'n fer a detailed example.

## 2.5.0 (2021-10-08)

- Change New colors `--CODE-BLOCK-color` an' `--CODE-BLOCK-BG-color` were added t' provide a fallback fer Hugos rules highlight'n 'n case `guessSyntax=true` be set. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style.

## 2.4.0 (2021-10-07)

- Change Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.

- New Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n `disableTagHiddenPages=true` 'n yer `config.toml`.

- New Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' `alwaysopen` opt'n 'n yer `config.toml`. Please see further documentat'n fer poss'ble values an' default behavior.

- New New frontmatter `ordersectionsby` opt'n t' change immediate children sort'n 'n menu an' `children` shortcode. Poss'ble values be `title` or `weight`.

- New Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See Cap'n Hugo documentat'n.

## 2.3.0 (2021-09-13)

- 0.81.0 This release requires a newer Cap'n Hugo version.

- New Showcase multilanguage features by provid'n a documentat'n translat'n “fer us pirrrates”. There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.

## 2.2.0 (2021-09-09)

- New Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n `disableSeoHiddenPages=true` 'n yer `config.toml`.

## 2.1.0 (2021-09-07)

- 0.69.0 This release requires a newer Cap'n Hugo version.

- Change In case th' site’s structure contains additional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see `CHANGELOG.md` 'n th' exampleSite), they will now be ignored by th' search.

- New Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n `disableSearchHiddenPages=true` 'n yer `config.toml`.

- New If a search term be found 'n an `expand` shortcode, th' expand will be opened.

- New Th' menu will scroll th' active item into view on board.

## 2.0.0 (2021-08-28)

- Change Rules highlight'n was switched t' th' built 'n Hugo mechanism. Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n

- Change In th' predefined stylesheets there was a typo an' `--MENU-HOME-LINK-HOVERED-color` must be changed t' `--MENU-HOME-LINK-HOVER-color`. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.

- Change `--MENU-HOME-LINK-color` an' `--MENU-HOME-LINK-HOVER-color` were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.

- Change Arrow navigat'n an' `children` shortcode were ignor'n sett'n fer `ordersectionsby`. This be now changed an' may result 'n different sort'n order o' yer sub planks.

- Change If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.

- Change A plank without a `title` will be treated as `hidden=true`.

- New Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further documentat'n fer poss'ble values an' default behavior.

- New New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See documentat'n fer further read'n.

- New Shortcode `children` wit' new parameter `containerstyle`.

- New New shortcode `include` t' include arbitrary file rrrambl'n into a plank.

## 1.2.0 (2021-07-26)

- New Shortcode `expand` wit' new parameter t' open on plank board.

## 1.1.0 (2021-07-02)

- Break'n Merrrmaid diagrams can now be panned an' zoomed. This isn’t configur'ble yet.

- New `Merrrmaid` config opt'ns can be set 'n `config.toml`.

## 1.0.0 (2021-07-01)

- 0.65.0 Th' requirement fer th' Cap'n Hugo version o' this theme be th' same as fer th' Learrrn theme version 2.5.0 on 2021-07-01.

- New Initial fork o' th' Learrrn theme based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' `Relearrrn` an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see this comment 'n th' Learrrn issues.

# Requirrrements

Arrr! Pirrrates

Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.

Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.

Just download at least version 0.95.0 o' th' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac).

# Installat'n

Arrr! Pirrrates

Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.

Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this great documentat'n fer beginners.

## Create yer project

Cap'n Hugo provides a `new` command t' create a new website.

    hugo new ship <new_project>

## Install th' theme

Install th' Relearrrn theme by follow'n this documentat'n us'n Hugo’s module system.

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

Alternatively, ye can download th' theme as .zip file an' extract it 'n th' `themes` directory

### From Git

If ye install th' theme from yer git repository or GitHub, ye have several opt'ns.

If ye use th' `head` o' th' `main` branch, ye be us'n th' development version. Usually it be fully functional but can break from time t' time. We try t' fix newly introduced bugs 'n this version as soon as poss'ble.

Additionally ye can checkout one o' th' tagged versions. These tagged versions correspond t' an official releases from th' GitHub repository.

Besides th' usual version tags (eg `1.2.3`) there be also tags fer th' main version (eg. `1.2.x`), major version (eg. `1.x`) an' th' latest (just `x`) released version mak'n it easier fer ye t' pin th' theme t' a certain version.

## Basic configurat'n

When build'n th' website, ye can set a theme by us'n `--theme` opt'n. However, we suggest ye modify th' configurat'n file (`config.toml`) an' set th' theme as th' default. Ye can also add th' `[outputs]` section t' en'ble th' search functionality.

    # Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo
    theme = "hugo-theme-relearn"

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

## Create yer first chapter plank

Chapters be planks that contain other child planks. It has a special layout style an' usually just contains a chapter name, th' title an' a brief abstract o' th' section.

    ### Chapter 1

    # Basics

    Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.

renders as

Th' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command

    hugo new --kind chapter basics/_index.md

By open'n th' given file, ye should see th' property `chapter=true` on top, mean'n this plank be a chapter.

By default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property `draft: true` from th' metadata.

## Create yer first rrrambl'n planks

Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:

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

Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' `title` value 'n th' beginn'n o' th' files.

## Launch'n th' website locally

Launch by us'n th' follow'n command:

    hugo serve

Go t' `http://localhost:1313`

Ye should notice three th'ns:

1. Ye have a left-side Basics menu, contain'n two submenus wit' names equal t' th' `title` properties 'n th' previously created files.
2. Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns.
3. When ye run `hugo serve`, when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat!

## Build th' website

When yer ship be ready t' deploy, run th' follow'n command:

    hugo

A `public` folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.

Avast

This website can be automatically published an' hosted wit' Netlify (Read more about Automated HUGO deployments wit' Netlify). Alternatively, ye can use GitHub planks.

# Configurrrat'n

Arrr! Pirrrates

Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.

## Global ship parameters

On top o' Cap'n Hugo global configurat'n, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer `config.toml` (here, values be default).

Avast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n.

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

## Serv'n yer plank from a subfolder

If yer ship be served from a subfolder, eg. `https://example.com/mysite/`, ye have t' set th' follow'n lines t' yer `config.toml`

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

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

## Serv'n yer plank from th' filesystem

If ye want yer plank served from th' filesystem by us'n URLs start'n wit' `file://` you’ll need th' follow'n configurat'n 'n yer `config.toml`:

    relativeURLs = true

Th' theme will append an additional `index.html` t' all branch bundle links by default t' make th' plank be serv'ble from th' file system. If ye don’t care about th' file system an' only serve yer plank via a webserver ye can also generate th' links without this change by add'n this t' yer `config.toml`

    [params]
      disableExplicitIndexURLs = true

Avast

If ye want t' use th' search feature from th' file system us'n an older installat'n o' th' theme make sure t' change yer outputformat fer th' homepage from th' now deprecated `JSON` t' `SEARCH` as seen below.

## Activate search

If not already present, add th' follow'n lines 'n th' same `config.toml` file.

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

This will generate a search index file at th' root o' yer public folder ready t' be consumed by th' Lunr search library. Avast that th' `SEARCH` outputformat was named `JSON` 'n previous releases but was implemented differently. Although `JSON` still works, it be now deprecated.

### Activate dedicated search plank

Ye can add a dedicated search plank fer yer plank by add'n th' `SEARCHPAGE` outputformat t' yer home plank by add'n th' follow'n lines 'n yer `config.toml` file.

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

Ye can access this plank by either click'n on th' magnifier glass or by typ'n some search term an' press'n `ENTER` inside o' th' menu’s search box .

## Activate print support

Ye can activate print support t' add th' capability t' print whole chapters or even th' complete ship. Just add th' `PRINT` output format t' yer home, section an' plank 'n yer `config.toml` as seen below:

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

This will add a little printer ay'con 'n th' top bar. It will switch th' plank t' print preview when clicked. Ye can then send this plank t' th' printer by us'n yer browser’s usual print functionality.

Avast

Th' result'n URL will not be configured ugly 'n terms o' Hugo’s URL handl'n even if you’ve set `uglyURLs=true` 'n yer `config.toml`. This be due t' th' fact that fer one mime type only one suffix can be configured.

Nevertheless, if you’re unhappy wit' th' result'n URLs ye can manually redefine `outputFormats.PRINT` 'n yer own `config.toml` t' yer lik'n.

## MathJax

Th' MathJax configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See Math fer additional documentat'n.

### Example

MathJax be globally disabled. By default it won’t be boarded by any plank.

On plank “Physics” ye coded some JavaScript fer a dynamic formulae. Ye can set th' MathJax parameters locally t' board mathJax on this plank.

Ye also can dis'ble MathJax fer specific planks while globally enabled.

## Merrrmaid

Th' Merrrmaid configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See Merrrmaid fer additional documentat'n.

### Example

Merrrmaid be globally disabled. By default it won’t be boarded by any plank.

On plank “Architecture” ye coded some JavaScript t' dynamically generate a class diagram. Ye can set th' Merrrmaid parameters locally t' board mermaid on this plank.

Ye also can dis'ble Merrrmaid fer specific planks while globally enabled.

## Home Button Configurat'n

If th' `disableLandingPageButton` opt'n be set t' `false`, a Home button will appear on th' left menu. It be an alternative fer click'n on th' logo. T' edit th' appearance, ye will have t' configure two parameters fer th' 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 be not configured fer a specific language, they will get their default values:

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

Th' home button be go'n t' look like this:

# Customizat'n

Arrr! Pirrrates

Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.

Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials

In `themes/hugo-theme-relearn/layouts/partials/`, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don’t change th' code directly. Instead follow this plank. You’d create a new partial 'n th' `layouts/partials` folder o' yer local project. This partial will have th' priority.

This theme defines th' follow'n partials :

- `header.html`: th' header o' th' plank. See output-formats
- `footer.html`: th' footer o' th' plank. See output-formats
- `body.html`: th' body o' th' plank. Th' body may contain o' one or many articles. See output-formats
- `article.html`: th' output fer a single article, can contain elements around yer rrrambl'n. See output-formats
- `menu.html`: left menu. Not meant t' be overwritten
- `search.html`: search box. Not meant t' be overwritten
- `custom-header.html`: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Don’t forget t' include `style` HTML tag directive 'n yer file.
- `custom-footer.html`: custom footer 'n plank. Meant t' be overwritten when add'n JavaScript. Don’t forget t' include `javascript` HTML tag directive 'n yer file.
- `favicon.html`: th' favicon
- `heading-pre.html`: side-wide configurat'n t' prepend t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s `headingPre` sett'n into account.
- `heading-post.html`: side-wide configurat'n t' append t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s `headingPost` sett'n into account.
- `logo.html`: th' logo, on top left hand corner
- `meta.html`: HTML meta tags, if ye want t' change default behavior
- `menu-pre.html`: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsibility t' take th' page’s `menuPre` sett'n into account.
- `menu-post.html`: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsibility t' take th' page’s `menuPost` sett'n into account.
- `menu-footer.html`: footer o' th' the left menu
- `toc.html`: t'ble o' contents
- `rrrambl'n.html`: th' rrrambl'n plank itself. This can be overridden if ye want t' display page’s meta data above or below th' rrrambl'n.
- `content-footer`: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye don’t like it.

## Change th' logo

Create a new file 'n `layouts/partials/` named `logo.html`. Then write any HTML ye want. Ye could use an `img` HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!

Avast

Th' size o' th' logo will adapt automatically

## Change th' favicon

If yer favicon be a SVG, PNG or ICO, just drop off yer image 'n yer local `static/images/` folder an' name it `favicon.svg`, `favicon.png` or `favicon.ico` respectively.

If no favicon file be found, th' theme will lookup th' alternative filename `logo` 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.

If ye need t' change this default behavior, create a new file 'n `layouts/partials/` named `favicon.html`. Then write someth'n like this:

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

## Change th' colors

Th' Relearrrn theme lets ye choose between some predefined color variants 'n light or dark mode, but feel free t' add one yourself!

Ye can preview th' shipped variants by chang'n them 'n th' variant selector at th' bottom o' th' menu.

### Single variant

Set th' `themeVariant` value wit' th' name o' yer theme file. That’s it!

    [params]
      themeVariant = "relearn-light"

In th' above example yer theme file has t' be named `theme-relearn-light.css`

### Multiple variants

Ye can also set multiple variants. In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer.

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

Smarrrt Arrrse

If ye want t' switch th' rules highlight'n theme together wit' yer color variant, generate a rules highlight'n stylesheet an' configure yer installat'n accord'n t' Hugo’s documentat'n, an' `@import` this stylesheet 'n yer color variant stylesheet. For an example, take a look into `theme-relearn-light.css` an' `config.toml` o' th' exampleSite.

### Adjust t' OS Sett'ns

Ye can also cause th' ship t' adjust t' yer OS sett'ns fer light/dark mode. Just set th' `themeVariant` t' `auto`. That’s it.

If you’ve set multiple variants, ye can drop `auto` at any posit'n, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.

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

If ye don’t configure anyth'n else, th' theme will use `relearn-light` fer light mode an' `relearn-dark` fer dark mode.

If ye don’t like that, ye can set `themeVariantAuto`. Th' first element be th' variant fer light mode, th' second fer dark mode

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

Avast

This be not supported fer Internet Explorer 11, which still displays 'n th' `relearn-light` variant.

### Roll yer own

If ye be not happy wit' th' shipped variants ye can either copy an' rename one o' th' shipped files from `themes/hugo-theme-relearn/static/css` t' `static/css`, edit them afterwards t' yer lik'n 'n a text editor an' configure th' `themeVariant` parameter 'n yer `config.toml` or just use th' interactive variant generator.

### Output formats

Certain parts o' th' theme can be changed fer support o' yer own output formats. Eg. if ye define a new output format `PLAINTEXT` 'n yer `config.toml`, ye can add a file `layouts/partials/header.plaintext.html` t' change th' way, th' plank header should look like fer that output format.

# Stylesheet generrrat'r

Arrr! Pirrrates

Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.

This interactive tool may help ye t' generate yer own color variant stylesheet.

T' get started, first select a color variant from th' variant switch that fits ye best as a start'n point.

Th' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.

Th' arrowed lines reflects how colors be inherited thru different parts o' th' theme if th' descendent isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.

T' better understand this select th' `neon` variant an' modify th' different head'n colors. There, colors fer th' head'n `h2`, `h3` an' `h4` be explicitly set. `h5` be not set an' inherits its value from `h4`. `h6` be also not set an' inherits its value from `h5`.

Once you’ve changed a color, th' variant switch will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can change planks an' even close th' browser without los'n yer changes.

Once ye be satisfied, ye can download th' new variants file an' copy it into yer site’s `static/css` directory. Afterwards ye have t' adjust th' `themeVariant` parameter 'n yer `config.toml` t' yer chosen file name.

Eg. if yer new variants file be named `theme-my-custom-variant.css`, ye have t' set `themeVariant='my-custom-variant'` t' use it.

Avast

This only works 'n modern browsers.

## Variant generator

Graph

# Historrry

Arrr! Pirrrates

Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.

# Changelog

## 5.11.1 (2023-02-06)

### Fixes

- [bug] variant: include miss'n `theme-auto.css` 'n distribut'n #467

## 5.11.0 (2023-02-05)

### Enhancements

- [feature] i18n: add Czech translat'n #455
- [feature][change] lightbox: switch t' CSS-only solut'n #451
- [feature][change] variant: add support fer `prefers-color-scheme` #445
- [feature][change] expand: refactor fer a11y #339
- [feature][change] mermaid: make zoom configur'ble #144

### Fixes

- [bug] swagger: avoid errors when us'n invalid rapi-doc fragment ids #465
- [bug] search: fix oddities 'n keyboard handl'n #463
- [bug] badge: fix text color fer IE11 #462
- [bug] mermaid: rerender graph if search term be present an' variant be switched #460
- [bug] tags: show tag on planks when tag has space #459
- [bug] edit: remove do'ble slash on root plank link #450

### Maintenance

- [task] build: add mov'n version tags #453
- [task][change] theme: remove jQuery #452
- [task] build: check fer release notes before release #448

## 5.10.2 (2023-01-25)

### Fixes

- [bug] nav: fix breadcrumb fer huge installat'ns #446

## 5.10.1 (2023-01-25)

### Fixes

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

## 5.10.0 (2023-01-25)

### Enhancements

- [feature] shorrrtcodes: support fer accent color #440
- [feature] shorrrtcodes: add color parameter whar' applic'ble #438
- [feature] theme: announce translat'ns as alternate links #422

### Fixes

- [bug] nav: fix breadcrumbs fer deeply nested sections #442
- [bug] theme: improve whitespac'n 'n tables #441

## 5.9.4 (2023-01-23)

### Fixes

- [bug] variant: fix search ay'con an' text color #437

## 5.9.3 (2023-01-22)

### Fixes

- [bug] nav: fix left/right navigat'n fer horizontal scroll'n #435
- [bug] theme: allow planks on top level #434

### Maintenance

- [task] build: switch t' wildcard version o' act'ns #428

## 5.9.2 (2022-12-30)

### Fixes

- [bug] search: apply dependency scripts fer Hindi an' Japanese #427

## 5.9.1 (2022-12-23)

### Enhancements

- [feature] theme: make external link target configur'ble #426

## 5.9.0 (2022-12-23)

### Enhancements

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

### Fixes

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

## 5.8.1 (2022-12-11)

### Fixes

- [bug] theme: fix alias fer home plank if defaultContentLanguageInSubdir=true #414

## 5.8.0 (2022-12-08)

### Enhancements

- [feature] ay'con: add new shortcode #412
- [feature] theme: style an' document markdown extensions #411
- [feature] badge: add new shortcode #410
- [feature] theme: add accent color #409

### Fixes

- [bug] theme: fix spac'n fer tag flyout 'n FF #413

## 5.7.0 (2022-11-29)

### Enhancements

- [feature] button: refactor fer a11y #372

### Fixes

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

### Maintenance

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

## 5.6.6 (2022-11-23)

### Enhancements

- [feature] search: make build an' js forgiv'n against config errors #400

### Fixes

- [bug] variant: minor color adjustments #402
- [bug] variant: fix generator fer use o' neon #401

## 5.6.5 (2022-11-19)

### Fixes

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

## 5.6.4 (2022-11-19)

### Fixes

- [bug] theme: make alias planks us'ble by file:// protocol #398

## 5.6.3 (2022-11-19)

### Fixes

- [bug] theme: be compat'ble wit' Cap'n Hugo >= 0.95.0 #397

## 5.6.2 (2022-11-19)

### Fixes

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

## 5.6.1 (2022-11-19)

### Fixes

- [bug] theme: fix image distort'n #395

## 5.6.0 (2022-11-18)

### Enhancements

- [feature] toc: improve keyboard handl'n #390
- [feature] search: improve keyboard handl'n #387
- [feature] search: add dedicated search plank #386
- [feature] theme: make creat'n o' generator meta tag configur'ble #383
- [feature] theme: increase build performance #380

### Fixes

- [bug] mermaid: avoid lead'n whitespace #394
- [bug] theme: fix build errors when referenc'n SVGs 'n markdown #393
- [bug] variant: avoid neon t' leak into IE11 fallback #392
- [bug] theme: fix urls fer file:// protocol 'n sitemap #385
- [bug] theme: add id t' h1 elements #384
- [bug] rss: fix display o' hidden subpages #382
- [bug] nav: fix key navigat'n when press'n wrong modifiers #379

### Maintenance

- [task] mermaid: update t' version 9.2.2 #391

## 5.5.3 (2022-11-10)

### Fixes

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

## 5.5.2 (2022-11-08)

### Fixes

- [bug] theme: fix typo 'n 404.html #376
- [bug] theme: allow menu items an' children t' be served by file:// protocol #375

## 5.5.1 (2022-11-07)

### Fixes

- [bug] theme: fix overflow'n issue wit' anchors an' tooltips #364

## 5.5.0 (2022-11-06)

### Enhancements

- [feature][change] theme: opt'mize plank board fer images #304

### Fixes

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

## 5.4.3 (2022-11-05)

### Enhancements

- [feature] history: refactor fer a11y #341

### Fixes

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

## 5.4.2 (2022-11-05)

### Maintenance

- [task] build: change set-output t' 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 pass'n o' parameters wit' codefence rules #363
- [feature] i18n: add Finnish translat'n #361
- [feature] mermaid: allow pass'n o' parameters wit' codefence rules #360
- [feature] i18n: support RTL #357
- [feature][change] button: add opt'n fer target #351
- [feature][change] theme: allow t' 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 translat'n #343
- [feature] theme: opt'n t' align images #327

## 5.3.0 (2022-10-07)

### Enhancements

- [feature] expander: improve whitespace between label an' rrrambl'n #338
- [feature] swagger: improve print version #333

### Fixes

- [bug] print: fix links o' subsections #340
- [bug] theme: remove W3C validator errors #337
- [bug] children: remove unused `plank` parameter from docs #336
- [bug] print: remove menu placeholder 'n Firefox #335
- [bug] swagger: fix download button overflow #334
- [bug][change] a11y: remove WCAG errors whar' applic'ble #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 planks overwrite font-size #328

## 5.2.2 (2022-08-23)

### Fixes

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

## 5.2.1 (2022-08-05)

### Enhancements

- [feature] i18n: improve Japanese translat'n #318

### Fixes

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

### Maintenance

- [task] task: bump Cap'n Hugo minimum requirement t' 0.95 #319

## 5.2.0 (2022-08-03)

### Enhancements

- [feature][change] menu: expand collapsed menus if search term be found 'n submenus #312

### Fixes

- [bug] print: switch mermaid an' 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 t' light #313
- [bug] mermaid: header be show'n up 'n FF #311

## 5.1.1 (2022-07-15)

### Fixes

- [bug] tags: don’t count tags if plank be hidden #310

## 5.1.0 (2022-07-15)

### Enhancements

- [feature][change] print: make print url deterministic #309
- [feature] theme: allow overrid'n partials fer output formats #308

## 5.0.3 (2022-07-07)

### Fixes

- [bug] ie11: no styles aft rework o' archetypes #306

## 5.0.2 (2022-07-07)

### Fixes

- [bug] theme: board CSS if JS be disabled #305

## 5.0.1 (2022-07-07)

### Enhancements

- [feature][break'n] theme: opt'mize load'n o' js an' css #303

## 5.0.0 (2022-07-05)

### Enhancements

- [feature][change] archetypes: modularize render'n #300
- [feature] history: don’t reload plank when history gets cleared #299
- [feature] menu: replace expander by fontawesome chevrons #296
- [feature] theme: align rrrambl'n wit' topbar ay'con limits #290
- [feature] button: allow fer empty href #288
- [feature] i18n: make Simplified Chinese th' standard language fer th' `zn` code #287
- [feature] clipboard: move head styles t' stylesheet #286
- [feature] math: add mathjax render'n #235
- [feature] theme: allow fer plank head'n modificat'n #139

### Fixes

- [bug] favicon: fix URL if ship resides 'n subfolder #302
- [bug] code: show copy-to-clipboard marker fer blocklevel code #298
- [bug] menu: make active expander vis'ble on hover #297
- [bug] print: dis'ble arrow navigat'n #294
- [bug] print: add miss'n plank break aft index or section #292
- [bug] theme: use more space on wide screens #291
- [bug] theme: fix size o' chapter head'n #289

### Maintenance

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

## 4.2.5 (2022-06-23)

### Fixes

- [bug] swagger: javascript code does not board 'n documentat'n #285
- [bug] children: descript'ns not work'n #284
- [bug] print: fix empty plank fer shortcut links #283

## 4.2.4 (2022-06-23)

### Fixes

- [bug] theme: fix url fer logo an' home button #282

## 4.2.3 (2022-06-23)

### Fixes

- [bug][break'n] include: second parameter be ignored #281

## 4.2.2 (2022-06-23)

No changelog fer this release.

## 4.2.1 (2022-06-23)

No changelog fer this release.

## 4.2.0 (2022-06-23)

### Enhancements

- [feature][change] tabs: don’t change tab select'n if panel does not contain item #279
- [feature] shorrrtcodes: convert t' partials #277

### Fixes

- [bug] swagger: avoid builtin syntax-highlightn'n #280
- [bug] search: fix console message fer miss'n lunr translat'ns #278
- [bug] tabs: fix wrapp'n when hav'n many tabs #272

## 4.1.1 (2022-06-18)

### Fixes

- [bug] notice: fix layout when rrrambl'n starts wit' head'n #275

## 4.1.0 (2022-06-12)

### Enhancements

- [feature] i18n: support multilang rrrambl'n #271

## 4.0.5 (2022-06-12)

### Fixes

- [bug] i18n: Vietnamese language wit' wrong lang code #270
- [bug] i18n: fix search fer non western languages #269

## 4.0.4 (2022-06-07)

### Enhancements

- [feature] theme: improve keyboard navigat'n fer scroll'n #268

### Fixes

- [bug] swagger: adjust font-size fer method buttons #267
- [bug] menu: hide expander when only hidden subpages #264
- [bug] theme: make compat'ble wit' Cap'n Hugo 0.100.0 #263

### Maintenance

- [task] swagger: update rapidoc t' 9.3.2 #266
- [task] mermaid: update t' 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 plank on CTRL+f #242

## 4.0.1 (2022-06-05)

No changelog fer this release.

## 4.0.0 (2022-06-05)

### Enhancements

- [feature] shorrrtcodes: add named parameter if miss'n #260
- [feature][break'n] theme: remove –MAIN-ANCHOR-color from stylesheet #256
- [feature] i18n: add Italian translat'n #254
- [feature] attachments: support fer brand colors #252
- [feature] notice: support fer brand colors #251
- [feature][break'n] config: remove custom_css #248
- [feature] theme: use proper file extension fer page-meta.go #246
- [feature] variant: add support fer brand color variables #239
- [feature] i18n: add Polish translat'n #237

### Fixes

- [bug] shorrrtcodes: accept boolean parameters if given as str'n #261
- [bug] print: adjust button an' tab size #259
- [bug] print: show Merrrmaid if requested 'n frontmatter #255
- [bug] theme: adjust thin scrollbar slider #244
- [bug] mobile: fix broken scrollbar #243
- [bug] theme: fix display o' tooltip fer head'n 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 translat'n #233
- [feature] menu: expand/collapse menu items without navigat'n #231
- [feature] print: add opt'n t' print whole chapter #230
- [feature][break'n] theme: apply user supplied rrrambl'n footer below rrrambl'n #229

### Fixes

- [bug] theme: scroll t' head'n on initial board #232

## 3.3.0 (2022-03-28)

### Enhancements

- [feature] theme: add CSS font variables #227
- [feature] swagger: add support fer oas/swagger documentat'n #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 th' title plank #224
- [bug] theme: align rrrambl'n scrollbar t' th' right on big screens #223

## 3.2.0 (2022-03-19)

### Enhancements

- [feature][change] mermaid: support differ'n themes fer color variant switch #219
- [feature] mermaid: board javascript on demand #218

### Maintenance

- [task] mermaid: update t' 8.14.0 #220

## 3.1.1 (2022-03-16)

### Enhancements

- [feature] i18n: add Korean translat'n #217

## 3.1.0 (2022-03-15)

### Enhancements

- [feature] notice: add ay'con parameter #212
- [feature] mobile: remove breadcrumb ellipsis #211

### Fixes

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

## 3.0.4 (2022-02-24)

### Enhancements

- [feature] theme: improve font load'n #201
- [feature][change] variant: fix inconsistent color vari'ble nam'n #200

### Fixes

- [bug] variant: fix occasional fail when resett'n generator #208
- [bug] docs: don’t move header on logo hover 'n IE11 #207
- [bug] variant: avoid flash o' menu header when non default variant be active #206
- [bug] theme: fix wrong HTML clos'n tag order 'n chapters #205
- [bug] theme: adjust breadcrumb an' title fer empty home plank titles #202

## 3.0.3 (2022-02-23)

### Enhancements

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

### Fixes

- [bug] theme: remove Cap'n Hugo build warning if plank be not file based #197
- [bug] tags: adhere t' titleSeparator #196
- [bug] theme: hide footer divider an' variant selector 'n 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 accord'n t' style #192

### Fixes

- [bug] theme: revert fontawsome t' version 5 fer IE11 compat #191

## 3.0.0 (2022-02-22)

### Enhancements

- [feature] variant: build a variant generator #188
- [feature] nav: only show toc if th' plank has head'ns #182
- [feature][break'n] theme: change default colors t' Relearrrn defaults #181
- [feature] variant: add a variant selector #178
- [feature][break'n] menu: rework footer UX #177
- [feature] theme: support fer dark mode #175
- [feature] docs: use light rules highlightn'n theme #174
- [feature] notice: tweak dull colors #173
- [feature] theme: rework header UX #151

### Fixes

- [bug] search: remove additional X 'n filled out search box 'n 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 fer ay'cons 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 navigat'n respect ordersectionsby configurat'n #170

## 2.9.4 (2022-02-06)

### Fixes

- [bug] exampleSite: fix links 'n official documentat'n #168

## 2.9.3 (2022-02-06)

### Fixes

- [bug] menu: invalid URL when th' shortcut be an internal link #163

## 2.9.2 (2021-11-26)

### Enhancements

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

### Fixes

- [bug] theme: fix select'n o' *.ico files as favicons #160

## 2.9.1 (2021-11-22)

### Fixes

- [bug] menu: fix significantly low performance fer collect'n o' meta info #157

## 2.9.0 (2021-11-19)

### Fixes

- [bug][break'n] relref: fix inconsistent behavior #156
- [bug] search: make dropdown stick t' search field when scroll'n #155
- [bug] menu: align long text properly #154
- [bug] copyToClipBoard: add miss'n right border fer inline code if `disableInlineCopyToClipBoard=true` #153
- [bug] menu: show hidden sibl'n planks reliably #152
- [bug] menu: br'n active item 'n sight fer large menus #149

## 2.8.3 (2021-11-09)

### Fixes

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

## 2.8.2 (2021-11-08)

### Fixes

- [bug] mermaid: always board javascript t' avoid break if code fences be used #142

## 2.8.1 (2021-11-04)

### Fixes

- [bug] search: don’t break JS 'n multilang setup if search be disabled #140

## 2.8.0 (2021-11-03)

### Enhancements

- [feature] toc: make disableTOC globally avail'ble via config.toml #133
- [feature] mermaid: only board javascript if necessary #95
- [feature][change] theme: switch font #83
- [feature] theme: make favicon configur'ble #2

### Fixes

- [bug] mermaid: assert that window.mermaid be actually mermaid #136
- [bug] menu: remove usage o' Hugos UniqueID #131
- [bug] theme: reduce margin fer children shortcode #130
- [bug] theme: left-align h3 'n chapters #129
- [bug] theme: align copy link t' 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 fer malicioius image URLs #117

## 2.5.0 (2021-10-08)

### Enhancements

- [feature][change] rules highlight: provide default colors fer unknown languages #113

### Fixes

- [bug] security: fix XSS fer 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 translat'n #109
- [feature][change] theme: simplify stylesheet fer color variants #107
- [feature] hidden planks: remove from RSS feed, JSON, taxonomy etc #102
- [feature] theme: announce alternative rrrambl'n 'n header #101
- [feature] menu: frontmatter opt'n t' change sort predicate #98
- [feature] menu: add default sett'n fer 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 be used #105
- [bug] theme: fix sticky header t' remove horizontal scrollbar #82

### Maintenance

- [task] chore: update fontawesome #94

## 2.3.2 (2021-09-20)

### Fixes

- [bug] docs: rename history pirate translat'n #91

## 2.3.1 (2021-09-20)

### Fixes

- [bug] docs: rename english pirate translat'n t' avoid crash on render'n #90

## 2.3.0 (2021-09-13)

### Fixes

- [bug] theme: fix usage o' 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 planks from sitemap an' SEO index'n #85

### Fixes

- [bug] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs #86

### Maintenance

- [task] theme: switch from data-vocabulary t' 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: dis'ble search 'n hidden planks #76
- [feature] search: improve readablility o' index.json #75
- [feature] search: increase performance #74
- [feature] search: improve search context preview #73

### Fixes

- [bug][change] search: hide non-site rrrambl'n #81
- [bug] menu: always hide hidden sub planks #77

## 2.0.0 (2021-08-28)

### Enhancements

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

### Fixes

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

### Maintenance

- [task] docs: include changelog 'n exampleSite #33

## 1.2.0 (2021-07-26)

### Enhancements

- [feature] theme: adjust copy-to-clipboard #29
- [feature] attachments: adjust style between notice boxes an' attachments #28
- [feature] theme: adjust blockquote contrast #27
- [feature] expand: add opt'n t' open on plank board #25
- [feature] expand: rework styl'n #24
- [feature] attachments: sort output #23
- [feature] notice: make restyl'n o' notice boxes more robust #20
- [feature] notice: fix contrast issues #19
- [feature] notice: align box colors t' common standards #18
- [feature] notice: use distinct ay'cons fer notice box type #17

### Fixes

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

### Maintenance

- [task] dependency: upgrade jquery t' 3.6.0 #30

## 1.1.1 (2021-07-04)

### Maintenance

- [task] theme: prepare fer new hugo theme registrat'n #13

## 1.1.0 (2021-07-02)

### Enhancements

- [feature] mermaid: expose opt'ns 'n config.toml #4

### Fixes

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

### Maintenance

- [task] mermaid: update t' 8.10.2 #7

## 1.0.1 (2021-07-01)

### Maintenance

- [task] Prepare fer hugo showcase #3

## 1.0.0 (2021-07-01)

### Maintenance

- [task] Fork project #1