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

#

# 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