Version 8

• 0.141.0 Minimum required Hugo version

• Breaking Change requiring action after upgrade

• Change Change of behavior, may require action

• New New behavior, often introducing new options

8.3.0 (2025-11-27)

Cap'n Hugo 0.141.0

• 0.141.0 This release requires a newer Cap'n Hugo version.

Change

• Change Th' children shortcode has changed th' way it picks an image if displayed as card.

  Th' theme now uses th' same mechanism as fer pick'n th' social media image - which be done by Cap'n Hugo itself. Ye may have t' adjust th' file name o' yer preview image accordingly.

New

• New Th' theme can now check external links fer validity dur'n build. No more stale links anymore.

  T' activate it set urlExternalCheck=true 'n th' yer hugo.toml params section.

  Th' name o' option ignoreerror was changed t' urlIgnoreError 'n that matter. Ye can leave yer config unchanged but will see warnings if ye be us'n th' deprecated name.

• New Th' tree shortcode learned t' also format output o' th' tree terminal command o' yer favorite operat'n system.

• New On mobile, th' plank title will be displayed 'n th' breadcrumbs area.

• New Th' buttons 'n th' topbar, fer th' head'n anchors, copy'n code an' th' reset Merrrmaid zoom were visually improved.

  Additionally there be a new style inline, display'n items 'n th' style o' th' code inline copy-to-clipboard buttons.

• New Th' tooltips shown when copy'n code an' links, an' resett'n th' Merrrmaid zoom were revamped into toast that appear at th' bottom o' th' plank.

8.2.0 (2025-11-01)

New

• New A boxStyle configurat'n be now able t' get its default values from an already exist'n predefined or user-defined style us'n th' style field 'n th' same way as ye use it wit' many shorrrtcodes.

  Additionally there be two new styles link an' action, display'n items either 'n th' style o' th' topbar button or like th' action buttons o' th' Merrrmaid zoom or th' code block copy-to-clipboard buttons.

• New Th' button shortcode learned th' new parameters borderless an' hint.

• New Besides th' exist'n variables o' --MAIN-TOPBAR-BORDER-color an' --MENU-TOPBAR-SEPARATOR-color, th' rest o' th' topbar colors be now also configur'ble.

  Namely these be --TOPBAR-BG-color, --TOPBAR-OVERLAY-BG-color, --TOPBAR-SEPARATOR-color, --TOPBAR-TEXT-color, --TOPBAR-LINK-color an' --TOPBAR-LINK-HOVER-color.

• New Wit' refactor'n o' boxStyles, buttons an' th' topbar, it be now poss'ble t' set colors o' a button when its style be either link or action.

  This makes it poss'ble t' have differ'n colors between buttons an' links. Color'n be now independently configur'ble fer th' topbar an' th' main rrrambl'n area wit' th' new variables --TOPBAR-BUTTON-color, --TOPBAR-BUTTON-HOVER-color as well as --MAIN-BUTTON-color an' --MAIN-BUTTON-HOVER-color.

• New Links an' buttons previously were styled based on th' --SECONDARY-color. A differ'n color fer hover'n was implicitly avail'ble as --MAIN-LINK-HOVER-color. T' make th'ns easier fer ye, this was overhauled.

  Th' primary, secondary an' accent colors now have avail'ble hover counterparts as --PRIMARY-HOVER-color, --SECONDARY-HOVER-color an' --ACCENT-HOVER-color;

  Care was taken not t' break yer exist'n style variants, so ye don’t need t' change anyth'n if ye be happy wit' th' look o' yer current variant.

  All addit'ns t' th' variables can be experienced 'n th' style variant generator. Have fun wit' it!

• New Translat'n into Danish.

8.1.0 (2025-10-05)

Change

• Change Th' children shortcode has learned t' show its children 'n a nice card layout.

  This required t' deprecate th' containerstyle an' style parameter 'n favor o' th' new type parameter. Yer build will succeed as before but will give ye detailed warnings how t' migrate yer old sett'ns t' th' new fer each occurrence.

  If ye haven’t set containerstyle or style no changes be necessary. If ye used

  • containerstyle=ul or style=li now use type=tree
  • style=h* now use type=list
  • any other containerstyle or style now use type=flat

  If ye want t' use th' new card layout, use type=card.

• Change Th' externalLinkTarget config option has changed its default from _blank t' _self caus'n external links by default t' be opened 'n th' same tab.

  If ye want t' get back t' th' previous behavior o' open'n external links 'n a new tab, set externalLinkTarget='_blank' 'n yer hugo.toml.

New

• New Th' theme now supports cards wit' th' card shortcode an' th' correspond'n cards shortcode.

  See them 'n action on th' shorrrtcodes overview plank.

8.0.0 (2025-09-11)

Cap'n Hugo 0.126.3

• 0.126.3 This release requires a newer Cap'n Hugo version.

Break'n

• Break'n This release provides compatibility fer Cap'n Hugo 0.146.0 or newer an' required t' make some breaking changes t' internal file structur'n.

  Ye will be affected by this if ye

  • call dependencies.gotmpl from yer own templates. Th' theme will now generate a warning. Call dependencies.html instead.
  • use plank designs. Th' underly'n rrrambl'n views aren’t allowed t' be stored 'n subdirectories anymore. Ye have t' move them up one level.
  • use self-defined output formats.

• Break'n Search got much more flex'ble 'n its configurat'n but may requires changes by ye.

  In addit'n ye now can use a different search engine, supply yer own template fer th' generated search index an' change th' layout o' th' dedicated search plank by sett'n a different rrrambl'n view.

Change

• Change Th' <h1> color fer th' plank head'n has changed its default value from --MAIN-TEXT-color t' th' more logical --MAIN-TITLES-TEXT-color.

  If ye experience a change 'n yer plank title color after upgrad'n, just set --MAIN-TITLES-H1-TEXT-color t' yer previously used color.

• Change For th' children shortcode th' final default value if parameter sort=auto an' no ordersectionsby sett'n was found has changed from weight t' default.

  If yer weights be all correctly set ye will not recognize a difference. If ye have duplicate weights on a level or have not set weights at all while sort'n should happen by weight, this change will lead t' a deterministic order while previously it didn’t.

New

• New Th' theme has updated its Merrrmaid dependency t' 11.8.0. This adds support fer radar graphs an' treemaps.

Version 7

• 0.126.0 Minimum required Hugo version

• Breaking Change requiring action after upgrade

• Change Change of behavior, may require action

• New New behavior, often introducing new options

7.6.0 (2025-04-03)

New

• New Informat'n was added t' th' docs about th' kind o' data th' theme stores 'n th' readers browser.

• New Th' new tree shortcode displays lists as nicely formatted trees wit' configur'ble ay'con an' ay'con color.

• New Th' ay'con shortcode has learned th' style an' color options known from other shorrrtcodes.

• New Th' theme supports version'n now, whar' ye can keep older versions o' yer ship access'ble via a version switcher at th' top o' th' menu.

• New Th' menu configurat'n fer th' main menu area, introduced 'n 7.1.0, be extended t' th' non-scroll'n menu header area between search box an' main scroll'n area us'n th' sidebarheadermenus option an' t' th' menu footer area us'n th' sidebarfootermenus option.

  Th' configurat'n fer all sidebar menus be similar an' now comes wit' two new types o' menus.

  Th' divider type adds a horizontal ruler.

  Th' custom type allows t' insert any HTML snippets into th' menu. Th' HTML must be wrapped 'n a li element t' not break HTML validat'n. Th' theme ships wit' th' follow'n snippets:

  • languageswitcher: will display th' language switcher
  • variantswitcher: will display th' variant switcher
  • versionswitcher: will display th' version switcher
  • historyclearer: will display a button t' clear th' history o' visited links

  Ye don’t need t' change anyth'n 'n yer exist'n installat'n as th' old configurat'n be used as a default.

• New Translat'n into Ukrainian. This language be not supported fer search.

7.5.0 (2025-03-04)

Change

• Change All dependencies were moved from static t' assets. Affected be stylesheets, scripts an' fonts.

  This be mainly done t' reduce th' output 'n public t' only contain necessary files o' yer ship.

  E.g. if ye don’t use math anywhere on yer ship, it be not necessary t' output th' MathJax library t' public.

  Th' directory structure will be adjusted so all 3rd-party dependencies be stored 'n their appropriate module sub directory. So what previously was static/js/js-yaml.js will become assets/js/js-yaml/js-yaml.js.

  Take a look into th' new assets directory. Only if ye have overridden some o' these files, ye will have t' adjust their paths accordingly. All other additional files should stay whar' they be.

• Change Buttons fer languages written right t' left be now rendered correctly, so ye will experience visual differences 'n those cases. This applies t'

  • th' Merrrmaid zoom button depend'n on th' page’s language
  • inline an' block copy-to-clipboard buttons depend'n o' th' contained text rrrambl'n

7.4.0 (2025-02-21)

Change

• Change Th' way ye link t' planks 'n a different language has changed. Until now this was an undocumented feature.

  Previously ye could prepend an URL wit' th' language code, e.g. /pir/my-page t' link t' planks o' other languages. This could cause problems if ye have a plank wit' th' same name as th' language code on th' top level o' yer plank structure.

  Now ye have t' set th' query parameter lang t' th' language code, e.g. /my-page?lang=pir.

  As this was previously undocumented, most projects will not be affected. If ye still need th' old behavior, ye can set enableLegacyLanguageLinks=true 'n yer hugo.toml.

• Change Th' target parameter o' th' button shortcode was deprecated.

  Use link effects on th' href parameter instead. Ye don’t need t' change anyth'n as th' old parameter still works but may generate warnings.

New

• New Th' theme now allows plank references (given as pageRef o' a Cap'n Hugo menu item, pageRef parameter o' a sidebarmenus entry an' th' menuPageRef 'n a page’s front matter) t' also be global resources from yer assets directory.

• New If link.errorlevel be configured, now also plank references will be checked fer existence.

• New Ye can now configure an ignore list o' regular expressions fer addresses that should be ignored if an errorlevel test fails. This be configured by sett'n urlIgnoreCheck=[] globally 'n yer hugo.toml fer all errorlevel checks.

  This helps t' remove false negatives while still benefitt'n from th' check fer all other addresses.

• New It be now poss'ble t' add query parameter an' an optional fragment part t' all links. This be regardless whether it be a local or remote address an' also applies t' Hugo’s internal path.

  By that ye can now use it on Marrrkdown links an' image links, plank references an' buttons.

• New Ye can now link t' different output formats o' a plank by add'n a query parameter.

  For example t' link t' th' print format o' a plank, write /my-page?format=print.

• New There be two new image effects that be us'ble if th' linked image points t' a resource:

  • dataurl: resource be converted t' a base64 encoded dataurl
  • inlinecontent: 'n case o' SVG resources, th' rrrambl'n will be used instead o' an <img> element, this be useful fer apply'n additional CSS styles t' th' elements inside o' th' SVG which be otherwise imposs'ble

• New This release introduces link effects which work similar t' image effects an' can be set as query parameter on any link.

  Wit' that ye currently can specify

  • target: set a link target individually fer each link
  • download: a click on th' link should result 'n a file download instead o' a navigat'n

• New Th' theme supports th' new source output format which behaves similar 'n configurat'n as th' markdown output format but allows th' original Marrrkdown source includ'n th' front matter o' a plank t' be viewed.

  Ye can see this 'n action on th' above linked plank, access'ble by click'n th' topbar button.

• New If ye haven’t overridden layouts/partials/custom-header.html an' css/custom.css and/or js/custom.js be present 'n yer project, th' theme now adds them t' yer planks.

  This was done t' be compatable wit' add'n custom scripts 'n an older version o' th' Cap'n Hugo documentat'n.

• New If ye haven’t overridden layouts/partials/content-footer.html, ye can now configure which plank meta informat'n - like author’s name, email address an' author'n date - should be displayed. Also th' date format be now configur'ble.

• New Th' logo color be now configur'ble via th' --MENU-HEADER-color vari'ble 'n yer variant stylesheets.

• New Now favicons be also searched 'n th' assets/images directory.

• New T'ble headers be sticky now.

• New Th' themes documentat'n has been moved from exampleSite t' docs t' make place fer a brand new exampleSite. Welcome on board th' Th' Purple Pulpo!

  This was done because th' docs contained t' much docs specific configurat'n an' quirks. Th' new exampleSite be meant as a start'n template fer yer own project wit' minimal initial configurat'n.

7.3.0 (2025-01-26)

New

• New Support fer Hugo’s built-in details shortcode by mapp'n it t' th' theme’s expand shortcode.

• New Th' topbar button fer th' print format can now be hidden if th' print output format be active by sett'n disablePrintButton=true 'n yer hugo.toml or Front Matter.

• New Th' theme supports th' new markdown output format which behaves similar 'n configurat'n as th' print output format but allows th' Marrrkdown source o' a plank t' be viewed.

  Ye can see this 'n action on th' above linked plank, access'ble by click'n th' topbar button.

• New Keyboard support fer code blocks was improved so th' copy t' clipboard button be now reach'ble by TAB if disableHoverBlockCopyToClipBoard=false was set 'n th' hugo.toml.

• New Further accessibility improvements were made fer th' anchor, copy t' clipboard an' mermaid reset functionality by us'n a HTML button instead o' a span.

7.2.0 (2024-12-10)

Change

• Change Th' expand shortcode was refactored an' now internally uses th' notice shortcode.

  Due t' these changes, expand an' notice wit' style=transparent will now generate slightly different margins.

• Change This release fixes a long stand'n issue, whar' loading a plank wit' a non-default variant may caused screen flash'n.

  Fix'n this resulted 'n major changes how stylesheets be bundled dur'n built an' ultimately leads t' different stylesheets been boarded 'n th' browser. If ye haven’t done any undocumented stuff wit' th' stylesheets, this change should not have any negative effects t' yer ship.

  Ye need t' make changes t' yer custom theme variant stylesheet if it contains

  • @font-face rules - they need t' be moved t' assets/css/fonts.css, assets/css/custom.css or layouts/partials/custom-header.html
  • rules select'n th' html element - replace html wit' :root

  Also, please note that now th' variant generator be not included 'n th' theme release anymore but be only avail'ble 'n th' docs. As a side effect, less JavaScript will be boarded on yer ship.

New

• New As a fallout o' fix'n th' flash'n issue, ye can now minify th' bundled stylesheets by sett'n th' minify parameter 'n yer hugo.toml. Without configur'n this parameter, th' theme will minify th' stylesheets fer product'n (hugo) but not fer development (hugo server).

• New Th' notice shortcode was improved fer accessibility an' comes wit' a brand new parameter groupid.

• New Th' theme has updated its Merrrmaid dependency t' 11.4.1. This adds support fer Kanban diagrams.

• New Translat'n into Persian. This language be not supported fer search.

7.1.0 (2024-10-25)

Change

• Change Th' sidebar menus be now completely configur'ble.

  This be provided by th' new parameter sidebarmenus. Wit' th' new system, ye can

  • show arbitrary amounts o' menus
  • set head'ns fer each menu
  • base it on yer plank structure or use Hugo’s menu feature
  • configure a start'n plank if a menu be based on plank structure
  • display unlimited nest'n fer both menu types
  • reconfigure th' menus 'n a page’s front matter
  • apply th' usual parameter alwaysopen, collapsibleMenu, etc. fer all menu types

  Ye don’t need t' change anyth'n 'n yer exist'n installat'n as th' old configurat'n be used as a default.

• Change Th' children shortcode was changed t' output a page’s LinkTitle instead o' previously us'n th' Title.

  As th' shortcode always outputs subpages 'n context o' th' parent plank, it funct'ns similar t' th' sidebar menu. Th' sidebar menu itself uses th' LinkTitle fer nam'n th' menu entries an' so should th' shortcode do.

  Th' parameter value sort=linktitle was deprecated fer th' easier sort=title. Ye can still use th' old value but both behave th' same way 'n sort'n by LinkTitle.

New

• New Menus created by yer plank structure be now able t' contain arbitrary links inserted into th' structure us'n th' menuUrl or menuPageRef front matter.

7.0.0 (2024-10-15)

Cap'n Hugo 0.126.0

• 0.126.0 This release requires a newer Cap'n Hugo version.

Break'n

• Break'n This release comes wit' significant changes 'n file nam'n o' partials an' how th' theme works internally. This was done because th' theme

  • suffered from poor build performance fer sites wit' 1000 or more planks
  • reinvented th' wheel instead o' us'n avail'ble Cap'n Hugo mechanisms

  What do I gain, ye may ask. A significant performance boost dur'n build! Usually, th' build time has been cut at least 'n half fer bigger sites. It be now poss'ble t' build even larger sites wit' 5000 or more planks. This was previously almost imposs'ble due t' rapidly increas'n build time wit' th' more planks you’ve introduced. For even bigger sites, th' theme now has configur'ble performance optimizat'ns - at th' price o' feature limitat'ns.

  If ye haven’t done customizat'ns t' any partials, ye can update right away.

  If ye have customized yer templates, 'n th' best cases, ye will get build warnings or even errors. In th' worst cases, yer build succeeds but th' ship will not work as intended by ye.

  Specifically, ye will have t' adapt yer ship if ye have

  • self-defined output formats
  • self-defined archetypes - now becom'n plank designs an' us'n Hugo’s rrrambl'n view mechanism
  • overwritten th' header.html, menu.html or footer.html partials - needs sync wit' implementat'n changes
  • overwritten prev/next topbar buttons - needs sync wit' implementat'n changes

• Break'n This release changes th' way th' search index an' th' dedicated search plank be generated. This may require reconfigurat'n by ye t' still work as ye have intended.

  Remove th' now obsolete search an' searchpage output format from [outputs.home] 'n yer hugo.toml, result'n 'n someth'n similar t'

  hugo.

  toml yaml json

  [outputs]
    home = ['html', 'rss', 'print']

  outputs:
    home:
    - html
    - rss
    - print

  {
     "outputs": {
        "home": [
           "html",
           "rss",
           "print"
        ]
     }
  }

  Aft that, yer build will succeed but will may cause new defaults t' be applied. Wit' no further sett'ns, in-page search, search popup an' dedicated search plank be all active by default. This can be reconfigured.

  In addit'n, ye be now able t' overwrite th' default file name o' th' search index an' th' default plank name o' th' dedicated search plank by chang'n searchIndexURL an' searchPageURL respectively 'n yer hugo.toml.

Change

• Change Once again, th' theme changed th' font. We switched t' th' excellent Roboto Flex font.

  Care was taken t' configure th' font t' look similar t' th' previously used Work Sans. Nevertheless, 'n direct comparison, ye will see slight differences 'n appearance.

  This change was necessary as th' previously used font had display issues wit' marked text, contrast, an' some other minor stuff. As an aftermath, th' number o' requests an' th' download size were decreased when loading a plank.

  Th' font was created by Google, be licensed under OFL 1.1 an' be delivered from yer theme’s installat'n. As always, no third-party server calls be involved.

  If ye have changed th' font-family 'n yer installat'n, ye most likely have t' adjust th' variables --MAIN-font-weight, --MAIN-BOLD-font-weight an' --MAIN-letter-spac'n.

  Additionally, if ye have changed th' font t' a vari'ble font 'n yer installat'n, ye may have t' adjust th' vari'ble --MAIN-font-variation-sett'ns. As this only applies t' vari'ble fonts, this should rarely be necessary.

• Change While switch'n th' font, it was discovered that certain CSS variables were falsely named. Ye don’t need t' change anyth'n 'n yer custom variant stylesheet as th' old names will be used as a fallback.

  --MAIN-TITLES-TEXT-font was renamed t' --MAIN-TITLES-font, --MAIN-TITLES-H<n>-color was renamed t' --MAIN-TITLES-H<n>-TEXT-color.

• Change Th' options an' front matter t' force loading a math, mermaid or openapi library has been changed.

  Previously, ye had t' set th' unintuitive disableMathJax=false t' force board th' math library 'n case o' a passthrough configurat'n. This be replaced by th' simpler math=true or math.force=true an' be now 'n line wit' Hugo’s official documentat'n.

  Ye don’t need t' change anyth'n yet but will receive warnings if th' old sett'ns be used.

• Change Th' default logo be not contained inside o' th' theme’s logo partial anymore.

  This be t' avoid usage o' th' theme’s brand'n throughout th' web 'n non-modified installat'ns.

  In addit'n, th' default text fer th' logo partial be now taken from th' linkTitle sett'n o' yer hugo.toml.

New

• New Th' docs received a much-needed overhaul fer all chapters.

  Basically, th' structure was reorganized, giv'n each topic its own plank while keep'n th' amount o' items fer each menu level comprehens'ble by add'n sub-pages.

  Th' docs now clearly differentiate between configurat'n o' yer ship, all th'ns writ'n plank rrrambl'n an' th' shorrrtcodes docs that cover both topics, configurat'n an' usage.

  T' give ye a better overview o' what’s poss'ble wit' th' theme, we introduced reference planks fer all theme configurat'n options an' front matter an' mark each occurrence o' such on all planks wit' th' badges Opt'n an' Front Matter.

  Also, a lot o' previously undocumented features be now included, namely

  • th' hidden planks feature
  • options o' th' menus
  • configur'n breadcrumb, titles an' head'ns o' yer rrrambl'n
  • options fer us'n links
  • add'n custom output formats

Version 6

• 0.121.0 Minimum required Hugo version

• Breaking Change requiring action after upgrade

• Change Change of behavior, may require action

• New New behavior, often introducing new options

6.4.0 (2024-10-11)

Change

• Change If ye now display a single code block 'n a notice box, its margin an' border will be removed so only th' colored notice border be vis'ble.

New

• New It be now poss'ble t' have user-defined styles fer all shorrrtcodes that accept th' style parameter. See th' notice shortcode fer configurat'n.

• New Th' resources shortcode has a new parameter expanded t' make th' resource list collaps'ble.

6.3.0 (2024-09-03)

Change

• Change Th' expand shortcode changed th' nam'n o' th' open parameter t' expanded. Ye don’t need t' change anyth'n yet but may get deprecat'n warnings.

• Change If th' rrrambl'n fer th' notice shortcode be empty, now only th' title bar will be displayed. Previously an empty rrrambl'n box was displayed.

New

• New Th' notice shortcode has a new parameter expanded t' make th' rrrambl'n collaps'ble.

• New If ye be runn'n Hugo 0.134.0 or later, th' theme now supports Obsidian callouts.

• New Th' theme has updated its Merrrmaid dependency t' 11.1.0. This adds support fer packet an' architecture diagrams.

6.2.0 (2024-08-26)

Change

• Change Th' head'n anchor links be extended 'n functionality.

  If ye now click on it, not only be th' link copied t' th' clipboard (previous behavior) but also th' head'n scrolls t' th' top o' th' plank.

  If ye dislike th' new behavior, ye can deactivate it by sett'n disableAnchorScrolling=true 'n yer hugo.toml. See th' docs fer further options.

New

• New If ye be runn'n Hugo 0.132.0 or later, th' theme be now cap'ble t' print GitHub alerts.

• New T' support new severity levels fer GitHub alerts, all shorrrtcodes that support severity levels wit' their style parameter were expanded wit' th' new severities caution an' important an' th' color parameter was expanded wit' cyan an' magenta. Please note, that color'n an' ay'cons o' severities may defer from th' display ye see on GitHub.

• New T' support new severity levels fer GitHub alerts, th' new severities an' their accord'n colors be also avail'ble as CSS variables BOX-MAGENTA-color, BOX-MAGENTA-TEXT-color, BOX-CAUTION-color, BOX-CAUTION-TEXT-color, BOX-CYAN-color, BOX-CYAN-TEXT-color, BOX-IMPORTANT-color, BOX-IMPORTANT-TEXT-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as appropriate default colors will be used.

6.1.0 (2024-08-02)

Change

• Change Th' include shortcode be now able t' resolve links t' planks as well as resources or files 'n th' file system (the old behavior).

• Change T' make th' asset buster mechanism more robust, some internally used stylesheets whar' restructured. This generally should not affect yer plank 'n any negative way.

New

• New Th' openapi shortcode be now able t' resolve links t' resources as well as t' files 'n th' file system (the old behavior). Ye can configure t' generate warnings or errors dur'n build by sett'n openapi.errorlevel t' either warning or error 'n yer hugo.toml if a path cannot be resolved.

• New Shorrrtcodes support'n an errorlevel configurat'n can now have overridden values 'n th' front matter section o' each individual plank.

• New Th' theme now comes wit' its own overridden version o' th' relref shortcode.

  While th' usage o' relref be obsolete an' discouraged by Cap'n Hugo fer a while, exist'n installat'ns may use it. In configurat'ns us'n a baseURL wit' a subdirectory, an' hav'n relativeURLs=false (the default) Hugo’s standard relref implementat'n was fail'n.

  Th' shortcode be deactivated by default an' can be activated by sett'n

  hugo.

  toml yaml json

  [params]
    disableDefaultRelref = true

  params:
    disableDefaultRelref: true

  {
     "params": {
        "disableDefaultRelref": true
     }
  }

  'n yer hugo.toml. Only do this if yer ship fulfills all o' th' above assumpt'ns.

6.0.0 (2024-04-27)

Break'n

• Break'n This release requires ye t' move yer self-defined variant (theme-*.css) an' chroma stylesheets (chroma-*.css) from static/css t' assets/css.

  This was necessary t' avoid permission errors on build if runn'n 'n certain Unix configurat'ns.

  In addit'n it be not allowed anymore t' @import yer chroma stylesheet from inside o' yer variant stylesheet.

  Say, yer chroma stylesheet be named chroma-monokai.css, ye have t' add th' follow'n inside yer variant stylesheet:

  --CODE-theme: monokai;

• Break'n Th' parameter descript'n 'n yer hugo.toml will now be ignored.

  Wit' th' newly introduced unified handl'n o' descript'ns throughout th' theme, th' only place th' old parameter would have been used was yer home plank.

  For migrat'n, move th' descript'n parameter o' yer hugo.toml into th' front matter section o' yer home plank.

• Break'n Search support fer th' json outputformat deprecated 'n 5.4.0 was removed.

  Change it t' search fer th' homepage 'n yer hugo.toml. See th' docs fer detailed configurat'n.

• Break'n Th' front matter option menuTitle deprecated 'n 5.24.0 was removed 'n favor fer Hugo’s own linkTitle.

  Additionally, if set, linkTitle will now be used instead o' title t' generate th' breadcrumb.

• Break'n Th' swagger shortcode deprecated 'n 5.13.0 was removed 'n favor fer th' openapi shortcode wit' th' same set o' parameter.

• Break'n Support fer Internet Explorer 11 was finally dropped.

Change

• Change Wit' th' removal o' support fer Internet Explorer 11, Font Awesome was upgraded t' version 6.5.2.

  Ye may experience slight changes fer some ay'cons. In addit'n ye have additional ~1700 ay'cons t' chose from.

• Change Th' children shortcode was fixed t' adhere t' its documentat'n, generat'n th' descript'n based on this rule: When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken.

  Previously, th' summary erroneously was ignored which now can lead t' different output if ye set description=true as a parameter.

New

• New Th' include shortcode be now able t' resolve links t' resources as well as t' files 'n th' file system (the old behavior). Ye can configure t' generate warnings or errors dur'n build by sett'n include.errorlevel t' either warning or error 'n yer hugo.toml if a path cannot be resolved.

• New Math be now us'ble without enclos'n it 'n a shortcode or Marrrkdown codefence by us'n Hugo’s passthrough configurat'n.

• New Translat'n into Romanian.

Version 5

• 0.121.0 Minimum required Hugo version

• Breaking Change requiring action after upgrade

• Change Change of behavior, may require action

• New New behavior, often introducing new options

5.27.0 (2024-04-07)

Cap'n Hugo 0.121.0

• 0.121.0 This release requires a newer Cap'n Hugo version.

Change

• Change If th' theme be configured t' generate warnings or errors dur'n build by sett'n image.errorlevel t' either warning or error 'n yer hugo.toml, it will now also generate output if a link fragment be not found 'n th' target plank.

• Change Th' dependency loader was made more versatile.

  Th' configurat'n 'n yer hugo.toml does not require th' locat'n parameter anymore. If ye still use it, th' theme will work as before but will generate a warning. So ye don’t need t' change anyth'n, yet.

  Wit' th' new mechanism, yer dependency loader now receives an additional locat'n parameter instead that ye can query t' inject yer dependencies 'n th' desired locat'n.

  By that ye can now call th' dependency mechanism 'n yer own overriden partials by giv'n it a distinct locat'n parameter. In addit'n yer injected files can now be spread t' multiple locat'ns which wasn’t previously poss'ble.

New

• New Additional styl'n was added fer th' native HTML elements <mark> an' <kbd>. T' use them ye must allow th' usage o' HTML 'n yer hugo.toml. Th' Marrrkdown documentat'n was enhanced fer this.

• New Ye now can scroll forward an' backward through all head'ns o' a plank by us'n ALT 🡑 an' ALT 🡓. This also works fer th' PRINT output format.

• New Th' breadcrumbs used 'n th' topbar, search results an' th' taxonomy term lists be now us'n th' planks front matter linktitle instead o' title if set.

5.26.0 (2024-03-18)

New

• New Th' lazy loading o' images be now configur'ble by us'n th' new lazy image effect. Th' default value hasn’t changed 'n comparison t' older versions, ye don’t need t' change anyth'n.

• New It be now poss'ble t' adjust th' max width o' th' main area, eg. 'n case ye want t' use th' full plank width fer yer rrrambl'n.

• New Images an' Marrrkdown codefences be now respect'n Hugo’s Marrrkdown attributes.

• New Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer block diagrams.

• New This release fixes a long-stand'n bug whar' th' plank wasn’t reposition'n correctly when go'n forward or backward 'n yer browser history.

5.25.0 (2024-02-29)

Change

• Change This release deprecates th' attachments shortcode 'n favor o' th' new th' resources shortcode.

  If ye be us'n Hugo below 0.123.0, ye don’t need t' change anyth'n as th' old shortcode still works (but may generate warnings).

  Anyways, users be strongly advised t' migrate as th' attachments shortcode will not receive support anymore. Migrat'n instruct'ns be listed on th' attachments shortcode plank.

• Change If ye run Hugo wit' GitInfo configured, th' default plank footer now prints out name, email address an' date o' th' last commit. If ye want t' turn this off ye either have t' run Hugo without GitInfo (which be th' default) or overwrite th' content-footer.html partial.

5.24.0 (2024-02-28)

Cap'n Hugo 0.112.4

• 0.112.4 This release requires a newer Cap'n Hugo version.

Change

• Change Th' topbar button received a way t' add text next t' th' ay'con. For this, th' original title option was renamed t' hint while th' new title option be now displayed next t' th' ay'con.

• Change Th' front matter option menuTitle be now deprecated 'n favor fer Hugo’s own linkTitle. Ye don’t need t' change anyth'n as th' old menuTitle option be still supported.

• Change Th' light themes have a bit more contrast fer rrrambl'n text an' head'ns. Also th' syntaxhighlight'n was changed t' th' more colorful MonokaiLight. This br'ns th' syntaxhighlight'n 'n sync wit' th' correspond'n dark theme variants, which be us'n Monokai. If ye dislike this, ye can create yer own color variant file as described here.

New

• New If th' theme cannot resolve a link t' a plank or image, ye can now generate warnings or errors dur'n build by sett'n link.errorlevel or image.errorlevel t' either warning or error 'n yer hugo.toml respectively. By default this condit'n be silently ignored an' th' link be written as-is.

  Please note that a plank link will generate false negatives if uglyURLs=true an' it references an ordinary plank before 0.123.0.

  Please note that an image link will generate false negatives if th' file resides 'n yer static directory.

• New Ye now can configure additional options fer every theme variant 'n yer hugo.toml. This allows fer optional advanced functionality. Ye don’t need t' change anyth'n as th' old configurat'n options will still work (but may generate warnings now).

  Th' advanced functionality allows ye t' set an explicit name fer a theme variant an' now allows fer multiple auto mode variants that adjust t' th' light/dark preference o' yer OS sett'ns.

• New New partial fer defin'n th' head'n. See documentat'n fer further read'n.

• New Support fer Hugo’s built-in figure shortcode.

• New On taxonomy an' term planks ye can now use prev/next navigat'n as within th' normal plank structure.

• New In additiion t' th' exist'n menu width customizat'n, it be now also poss'ble t' set th' width o' th' menu flyout fer small screen sizes wit' th' --MENU-S-width CSS property.

• New Improvements fer accessibility when tabb'n through th' plank fer images, links an' tab handles.

• New Th' editURL config parameter be now overwritable 'n yer planks front matter. In addit'n it received more versatility by lett'n ye control whar' t' put th' file path into th' URL. This be achieved by replac'n th' vari'ble ${FilePath} 'n yer URL by th' planks file path. Ye don’t need t' change anyth'n 'n yer exist'n configurat'n as th' old way without th' replacement vari'ble still works.

• New Th' themes config an' front matter options received a comprehensive documentat'n update. In addit'n th' theme switched from config.toml t' hugo.toml.

• New Restored compatibility wit' Cap'n Hugo versions 0.121.0 or higher fer th' highlight shortcode. This does not change th' minimum required Cap'n Hugo version.

• New Restored compatibility wit' Cap'n Hugo versions 0.123.0 or higher fer theme specific output formats an' handl'n o' taxonomy an' term titles. This does not change th' minimum required Cap'n Hugo version.

5.23.0 (2023-11-03)

Change

• Change Wit' 0.120.0 th' author sett'ns move into th' [params] array 'n yer hugo.toml. Because this collides wit' th' previous way, th' theme expected author informat'n, it now adheres t' Cap'n Hugo standards an' prints out a warning dur'n built if someth'n be wrong.

  Change yer previous sett'n from

  hugo.

  toml yaml json

  [params]
    author = 'Hugo'

  params:
    author: Cap'n Hugo

  {
     "params": {
        "author": "Hugo"
     }
  }

  t'

  hugo.

  toml yaml json

  [params]
    [params.author]
      name = 'Hugo'

  params:
    author:
      name: Cap'n Hugo

  {
     "params": {
        "author": {
           "name": "Hugo"
        }
     }
  }

• Change Taxonomy term planks now add th' breadcrumb fer each listed plank. If this gets too crowded fer ye, ye can turn th' breadcrumbs off 'n yer hugo.toml by add'n disableTermBreadcrumbs=true.

New

• New Taxonomy an' term planks be now allowed t' contain rrrambl'n. This be added inbetween th' title an' th' plank list.

• New It be now poss'ble t' print custom taxonomies anywhere 'n yer plank. See th' docs.

• New It be now poss'ble t' adjust th' menu width fer yer whole ship. See th' docs.

• New This release adds social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. See th' docs.

• New This release comes wit' additional sort options fer th' menu an' th' children shortcode. Both will now accept th' follow'n values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adher'n t' Hugo’s default sort order).

• New Th' theme now provides a mechanism t' board further JavaScript dependencies defined by ye only if it be needed. This comes 'n handy if ye want t' add own shorrrtcodes that depend on additional JavaScript code t' be boarded. See th' docs.

• New Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer th' xychart type.

• New This release adds portable Marrrkdown links.

  Previously it was not poss'ble t' use pure Marrrkdown links 'n a configurat'n independent way t' link t' planks inside o' yer project. It always required ye t' know how yer uglyURLs sett'n be, wheather ye link t' a plank or plank bundle an' 'n case o' relative links if yer current plank be a plank or plank bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This be a hassle as ye have t' change these links manually once ye change yer uglyURLs sett'n or change th' type o' a plank.

  Ye could work around this by us'n th' relref shortcode (eg [generator]({{% relref "../generator" %}})) which works but results 'n non-portable Marrrkdown.

  Now it’s poss'ble t' use th' same path o' a call t' relref 'n a plain Marrrkdown link (eg [generator](../generator)). This be independent o' any configurat'n sett'ns or th' plank types involved 'n link'n. Avast, that this requires yer links t' be given without any extension, so [generator](generator/index.html) will work as before.

  Th' follow'n types o' link'n be supported:

  link	descript'n
  [generator](en/configuration/branding/generator)	absolute from yer project root (multilang)
  [generator](/en/configuration/branding/generator)	absolute from yer project root (multilang)
  [generator](configuration/branding/generator)	absolute from yer current language root
  [generator](/configuration/branding/generator)	absolute from yer current language root
  [generator](./../generator)	relative from th' current plank
  [generator](../generator)	relative from th' current plank

5.22.0 (2023-10-02)

Change

• Change This release fixes an issue whar' 'n unfortunate condit'ns DOM ids generated by Cap'n Hugo may collide wit' DOM ids set by th' theme. T' avoid this, all theme DOM ids be now prefixed wit' R-.

  If ye haven’t modified anyth'n, everyth'n be fine. Otherwise ye have t' check yer custom CSS rules an' JavaScript code.

• Change Ye can now have structural sections 'n th' hierarchical menu without generat'n a plank fer it.

  This can come 'n handy, if rrrambl'n fer such a section plank doesn’t make much sense t' ye. See th' documentat'n fer how t' do this.

  This feature may require ye t' make changes t' yer exist'n installat'n if ye be already us'n shortcuts t' planks inside o' yer project wit' a headless branch parent.

  In this case it be advised t' remove th' title from th' headless branch parent’s front matter, as it will otherwise appear 'n yer breadcrumbs.

New

• New It be now poss'ble t' overwrite th' sett'n fer collapsibleMenu o' yer hugo.toml inside o' a page’s front matter.

• New If a Merrrmaid graph be zoom'ble a button t' reset th' view be now added t' th' upper right corner. Th' button be only shown once th' mouse be moved over th' graph.

• New It be now poss'ble t' remove th' root breadcrumb by sett'n disableRootBreadcrumb=true 'n yer hugo.toml.

• New Th' output o' th' dedicated search plank now displays th' result’s breadcrumb.

• New T'ble rows now change their background color on every even row.

• New Translat'n into Swahili. This language be not supported fer search.

5.21.0 (2023-09-18)

Change

• Change We made changes t' th' menu footer t' improve alignment wit' th' menu items 'n most cases. Care was taken not t' break yer exist'n overwritten footer. Anyways, if ye have yer menu-footer.html partial overridden, ye may want t' review th' styl'n (eg. margins/paddings) o' yer partial.

New

• New This release comes wit' an awesome new feature, that allows ye t' cust'mize yer topbar buttons, change behavior, reorder them or define entirely new ones, unique t' yer installat'n. See th' documentat'n fer further details.

• New Th' theme has updated its Swagger dependency t' 5.7.2 fer th' openapi shortcode. This br'ns support fer OpenAPI Specificat'n 3.1.

5.20.0 (2023-08-26)

Change

• Change Th' theme has updated its Swagger dependency t' 5.4.1 fer th' openapi shortcode.

  Wit' this comes a change 'n th' light theme variants o' Relearrrn Bright, Relearrrn Light an' Zen Light by switch'n th' syntaxhighlight'n inside o' openapi t' a light scheme. This br'ns it more 'n sync wit' th' code style used by th' theme variants itself.

  Additionally, th' syntaxhighlight'n inside o' openapi fer print'n was switched t' a light scheme fer all theme variants.

  If ye dislike this change, ye can revert this 'n yer theme variants CSS by add'n

  --OPENAPI-CODE-theme: obsidian;
  --PRINT-OPENAPI-CODE-theme: obsidian;

• Change For consistency reasons, we renamed th' CSS vari'ble --MENU-SECTION-HR-color t' --MENU-SECTION-SEPARATOR-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

• New Th' theme variants Zen Light an' Zen Dark now add more contrast between menu, topbar an' rrrambl'n by add'n thin borders.

  Those borders be now configur'ble by us'n th' CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color an' --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.

  For exist'n variants noth'n has changed visually.

• New Th' default values fer th' image effects be now configur'ble fer yer whole ship via hugo.toml or fer each plank through front matter.

• New This release fixes a long-stand'n bug whar' Merrrmaid graphs could not be displayed if they were initially hidden - like 'n collapsed expand or inactive tabs.

• New Restored compatibility wit' Cap'n Hugo versions lower than 0.111.0 fer th' highlight shortcode. This does not change th' minimum required Cap'n Hugo version.

5.19.0 (2023-08-12)

New

• New Th' highlight shortcode now accepts th' new parameter title. This displays th' code like a single tab. This be also avail'ble us'n Marrrkdown codefences an' makes it much easier t' write nicer code samples.

• New Th' theme has added two new color variants zen-light an' zen-dark. Check it out!

• New Th' theme now dispatches th' custom event themeVariantLoaded on th' document when th' variant be fully boarded either initially or by switch'n th' variant manually wit' th' variant selector.

• New Th' theme has updated its Merrrmaid dependency t' 10.3.1. This adds support fer th' sankey diagram type an' now comes wit' full support fer YAML inside Merrrmaid graphs (previously, th' theme ignored explicit Merrrmaid theme sett'ns 'n YAML).

• New Translat'n into Hungarian.

5.18.0 (2023-07-27)

Change

• Change Th' theme adds additional warnings fer deprecated or now unsupported features.

• Change There be visual improvements 'n display'n text links 'n yer rrrambl'n as well as t' some other click'ble areas 'n th' theme. If you’ve overwritten some theme styles 'n yer own CSS, keep this 'n mind.

New

• New Restored compatibility wit' Cap'n Hugo 0.95.0 or higher. This does not change th' minimum required Cap'n Hugo version.

• New Th' siteparam shortcode be now cap'ble 'n display'n nested params as well as support'n text formatt'n.

5.17.0 (2023-06-22)

Change

• Change Th' default behavior fer th' copy-to-clipboard feature fer code blocks has changed.

  Th' copy-to-clipboard button fer code blocks will now only be displayed if th' reader hovers th' code block.

  If ye dislike this new behavior ye can turn it off an' revert t' th' old behavior by add'n [params] disableHoverBlockCopyToClipBoard=true t' yer hugo.toml.

New

• New Restored compatibility wit' Cap'n Hugo 0.114.0 or higher. This does not change th' minimum required Cap'n Hugo version.

• New Th' new highlight shortcode replaces Hugo’s default implementat'n an' be fully compatable. So ye don’t need t' change anyth'n.

  In addit'n it offers some extensions. Currently only th' wrap extension option be provided t' control whether a code block should be wrapped or scrolled if t' long t' fit.

5.16.0 (2023-06-10)

Change

• Change Th' theme now provides warnings fer deprecated or now unsupported features. Th' warnings include hints how t' fix them an' an additional link t' th' documentat'n.

  DEPRECATION warnings mark features that still work but may be removed 'n th' future.

  UNSUPPORTED warnings mark features that will not work anymore.

• Change Th' 404 error plank was revamped. Hopefully ye will not see this very often.

New

• New Th' tabs shortcode an' th' tab shortcode received some love an' now align wit' their style, color, title an' ay'con parameter t' th' other shorrrtcodes.

  Th' visuals be now slightly different compared t' previous versions. Most note'ble, if ye now display a single code block 'n a tab, its default styl'n will adapt t' that o' a code block but wit' a tab handle at th' top.

  Additionally th' name parameter was renamed t' title but ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. Nevertheless ye will get deprecat'n warnings while execut'n Hugo.

• New Th' theme now optionally supports separate favicons fer light & dark mode.

5.15.0 (2023-05-29)

Change

• Change Restored compatibility wit' Cap'n Hugo 0.112.0 or higher. This does not change th' minimum required Cap'n Hugo version.

  Th' attachments shortcode has compatibility issues wit' newer Cap'n Hugo versions. Ye must switch t' leaf bundles or be locked t' Cap'n Hugo < 0.112.0 fer now.

  It be planned t' refactor th' attchments shortcode 'n th' future. This will make it poss'ble t' use th' shortcode 'n branch bundles again but not 'n simple planks anymore. This will most likely come wit' a breaking change.

• Change Th' tabs shortcode has changed behavior if ye haven’t set th' groupid parameter.

  Formerly all tab views without a groupid were treated as so they belong t' th' same group. Now, each tab view be treated as it was given a unique id.

New

• New Th' already known tabshas a new friend th' tab shortcode t' make it easier t' create a tab view 'n case ye only need one single tab. Really handy if ye want t' flag yer code examples wit' a language identifier.

  Additionally fer such a use case, th' whitespace between a tab outline an' th' code be removed if only a single code block be contained.

• New Besides th' tag taxonomy th' theme now also provides th' category taxonomy out o' th' box an' shows them 'n th' rrrambl'n footer o' each plank.

5.14.0 (2023-05-20)

New

• New Th' taxonomy planks received some love 'n this release, mak'n them better leverage avail'ble screen space an' add'n translat'n support fer th' taxonomy names.

  Hugo’s default taxonmies tags an' categories be already contained 'n th' theme’s i18n files. If ye have self-defined taxonomies, ye can add translat'ns by add'n them t' yer own i18n files. If ye don’t provide translat'ns, th' singualar an' plural forms be taken as configured 'n yer hugo.toml.

• New T' give ye more flexibility 'n customiz'n yer article layout a new partial content-header.html be introduced.

  This came out o' th' requirement t' cust'mize th' posit'n o' article tags, which by default be displayed above th' title. A second requirement was t' also show additional taxonomies not supported by th' theme natively. While Cap'n Hugo supports tags an' categories by default, th' theme only displays tags.

  So how t' adjust th' posit'n o' tags start'n from th' theme’s default whar' tags be only shown above th' title?

  1. Hide tags above title: Overwrite content-header.html wit' an empty file.
  2. Show tags between title an' rrrambl'n: Overwrite heading-post.html an' add {{ partial "tags.html" . }} t' it.
  3. Show tags below rrrambl'n: Overwrite content-footer.html an' add {{ partial "tags.html" . }} t' it.

• New Th' new parameter breadcrumbSeparator be now avail'ble 'n yer hugo.toml t' change th' - well - separator o' th' breadcrumb items. An appropriate default be 'n place if ye do not configure anyth'n.

5.13.0 (2023-05-17)

Change

• Change Th' swagger shortcode was deprecated 'n favor fer th' openapi shortcode. Ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. It be planned t' remove th' swagger shortcode 'n th' next major release.

  Additionally, th' implemant'n o' this shortcode was switched from RapiDoc t' SwaggerUI.

5.12.0 (2023-05-04)

Change

• Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed (again). While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.

New

• New Support fer th' great VSCode Front Matter CMS extension which provides on-premise CMS capabilties t' Cap'n Hugo.

  Th' theme provides Front Matter CMS snippets fer its shorrrtcodes. Currently only English an' German be supported. Put a reference into yer frontmatter.json like this

  ​

  frontmatter.json

  {
    ...
    "frontMatter.extends": [
    	"./vscode-frontmatter/snippets.en.json"
    ]
    ...
  }

• New Support fer languages that be written right t' left (like Arabic) be now complete an' extended t' th' menu, th' top navigat'n bar an' print. Ye can experience this 'n th' pirate translat'n. This feature be not avail'ble 'n Internet Explorer 11.

• New Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.

5.11.0 (2023-02-07)

Change

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

  In case ye made changes t' th' theme that be depend'n 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:

  ​

  layouts/partials/custom-header.html

  <script src="{{"js/jquery.min.js"| relURL}}" 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 hugo.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

• New Translat'n into 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

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

Break'n

• Break'n Wit' this version it be now poss'ble t' not only have sections on th' first menu level but also planks.

  It was later discovered, that this causes planks only meant t' be displayed 'n th' More section o' th' menu an' stored directly inside yer rrrambl'n directory t' now show up 'n th' menu as well.

  T' get rid o' this undesired behavior ye have two choices:

  1. Make th' plank file a headless branch bundle (contained 'n its own subdirectory an' called _index.md) an' add th' follow'n front matter configurat'n t' th' file (see docs content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.

     ​

     toml yaml json

     +++
     title = 'Showcase'
     
     [build]
       list = 'never'
       publishResources = true
       render = 'always'
     +++

     ---
     build:
       list: never
       publishResources: true
       render: always
     title: Showcase
     ---

     {
        "build": {
           "list": "never",
           "publishResources": true,
           "render": "always"
        },
        "title": "Showcase"
     }

  2. Store th' plank file fer below a parent headless branch bundle an' add th' follow'n front matter t' he parent (see docs content/more/_index.en.md). Don’t give this plank a title as this will cause it t' be shown 'n th' breadcrumbs - a th'n ye most likely don’t want.

     ​

     toml yaml json

     +++
     [build]
       list = 'never'
       publishResources = false
       render = 'never'
     +++

     ---
     build:
       list: never
       publishResources: false
       render: never
     ---

     {
        "build": {
           "list": "never",
           "publishResources": false,
           "render": "never"
        }
     }

     In this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see docs content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.

     ​

     toml yaml json

     +++
     title = 'Credits'
     +++

     ---
     title: Credits
     ---

     {
        "title": "Credits"
     }

Change

• Change Th' required directory 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 unnecessary 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 compatibility.

• 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 hugo.toml.

New

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

5.8.0 (2022-12-08)

New

• 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 highlight'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

• 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

• 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

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

  T' activate this feature, ye need t' configure it 'n yer hugo.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' 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 hugo.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' version 5 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

• 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

• Change Wit' th' proper sett'ns 'n yer hugo.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' home plank 'n yer hugo.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

• New Th' math shortcode an' mermaid shortcode now also support th' align parameter if Marrrkdown codefences 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 into Finnish (Suomi).

5.3.0 (2022-10-07)

Change

• 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

• New Image formatt'n has two new classes t' align images t' th' left or right. Additionally, th' already exist'n inline option 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

• Change If you’ve set collapsibleMenu = true 'n yer hugo.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)

Cap'n Hugo 0.95.0

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

Change

• 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 hugo.tomlt':

  hugo.

  toml yaml json

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

  outputFormats:
    print:
      baseName: index
      isHTML: true
      mediaType: text/html
      name: print
      path: _print
      permalink'ble: false

  {
     "outputFormats": {
        "print": {
           "baseName": "index",
           "isHTML": true,
           "mediaType": "text/html",
           "name": "print",
           "path": "_print",
           "permalinkable": false
        }
     }
  }

5.0.0 (2022-07-05)

Break'n

• 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

• 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 after 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' front matter parameter archetype = "home" an' remove th' lead'n head'n

  • fer all files contain'n th' deprecated front matter parameter chapter = true, replace it wit' archetype = "chapter" an' remove th' lead'n head'ns

• Change Th' front matter options pre / post were renamed t' menuPre / menuPost. Th' old options will still be used if th' new options aren’t set. Therefore ye don’t need t' change anyth'n after th' upgrade.

New

• New Add'n new partials heading-pre.html / heading-post.html an' accord'n front matter options 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.

Version 4

• 0.93.0 Minimum required Hugo version

• Breaking Change requiring action after upgrade

• Change Change of behavior, may require action

• New New behavior, often introducing new options

4.2.0 (2022-06-23)

Break'n

• 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

• 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 hugo.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 an' will point t' th' project’s home plank. If ye want t' support a different link, overwrite th' logo.html partial.

New

• 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

• 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

• 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

• New All shorrrtcodes now support named parameters. Th' positional parameters 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 into Polish. This language be not supported fer search.

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

Version 3

• 0.93.0 Minimum required Hugo version

• Breaking Change requiring action after upgrade

• Change Change of behavior, may require action

• New New behavior, often introducing new options

3.4.0 (2022-04-03)

Break'n

• 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

• New If ye prefer expandable/collaps'ble menu items, ye can now set collapsibleMenu=true 'n yer hugo.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 hugo.toml t' add th' capability t' print whole chapters or even th' complete ship.

• New Translat'n into Traditional Chinese.

3.3.0 (2022-03-28)

New

• 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' docs 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)

Cap'n Hugo 0.93.0

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

Change

• 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 Marrrkdown codefences. This changes th' behavior o' disableMermaid config option as follows: If a Merrrmaid shortcode or Marrrkdown codefence be found, th' option will be ignored an' Merrrmaid will be boarded regardlessly.

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

New

• 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

• 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

• 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' docs.

  This change was made t' allow yer own menu footer t' be placed right after 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 hugo.toml. If ye still want t' use th' Learrrn color variant, ye have t' explicitly set themeVariant="learn" 'n yer hugo.toml.

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

Change

• 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

• 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 hugo.toml. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer. See th' documentat'n fer configurat'n.

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

Version 2

• 0.81.0 Minimum required Hugo version

• Breaking Change requiring action after upgrade

• Change Change of behavior, may require action

• New New behavior, often introducing new options

2.9.0 (2021-11-19)

Break'n

• Break'n This release removes th' themes implementat'n o' ref/relref 'n favor fer Hugo’s 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	configuration/reference/_index.md	configuration/reference
  Leaf bundle	configuration/reference/index.md	configuration/reference
  Plank	configuration/reference.md	configuration/reference

  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 Hugo’s 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' Hugo’s 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 after an upgrade an' no errors be written t' th' console.

  Ye may see errors on th' console after th' update 'n th' form o'

  ERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref "configuration/reference/_index.md": "hugo-theme-relearn\docs\content\_index.en.md:19:22": plank not found

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

  1. Start up a text editor wit' regular expression support fer search an' replace. Search fer (ref\s+"[^"]*?)(?:/_index|/index)?(?:\.md)?(#[^"]*?)?" an' replace it by $1$2" 'n all *.md files. This be th' recommended choice.

  2. 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.8.0 (2021-11-03)

Change

• 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

• 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' table o' contents menu fer th' whole ship by sett'n th' disableToc option 'n yer hugo.toml. For an example see th' example configurat'n.

2.7.0 (2021-10-24)

New

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

2.6.0 (2021-10-21)

New

• New Yer ship can now be served from a subdirectory if ye set baseURL 'n yer hugo.toml. See th' documentat'n fer a detailed example.

2.5.0 (2021-10-08)

Change

• Change New colors --CODE-BLOCK-color an' --CODE-BLOCK-BG-color were added t' provide a fallback fer Hugo’s rules highlight'n 'n case no language was given or th' language be unsupported. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style.

2.4.0 (2021-10-07)

Change

• 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

• 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 hugo.toml.

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

• New New front matter ordersectionsby option 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)

Cap'n Hugo 0.81.0

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

New

• 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' Piratish one due t' maintenance constraints.

2.2.0 (2021-09-09)

New

• 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 hugo.toml.

2.1.0 (2021-09-07)

Cap'n Hugo 0.69.0

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

Change

• 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 pages), they will now be ignored by th' search.

New

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

• 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

• New Ye can define th' expansion state o' yer menus 'n th' front matter. 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.

Version 1

• 0.65.0 Minimum required Hugo version

• Breaking Change requiring action after upgrade

• Change Change of behavior, may require action

• New New behavior, often introducing new options

1.2.0 (2021-07-26)

New

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

1.1.0 (2021-07-02)

Break'n

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

New

• New Merrrmaid config options can be set 'n hugo.toml.

1.0.0 (2021-07-01)

Cap'n Hugo 0.65.0

• 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

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

Version 8

8.3.0 (2025-11-27)

Enhancements

• [feature][change] children: adjust image select'n fer cards #1169
• [feature] toast: remove tooltip an' replace it wit' toast #1166
• [feature] anchor: use button implementat'n #1162
• [feature] breadcrumbs: show title on mobile #1161
• [feature] tree: accept native tree command output #1159
• [feature] frontmatter: update snippets #1158
• [feature] link: add checker fer external links #964

Fixes

• [bug] anchor: don’t replace browser history wit' clicked anchor #1163
• [bug] cards: descript'n not show'n if unsafe HTML be not allowed #1160
• [bug] theme: fix invalid HTML #1156

Maintenance

• [task][dependencies] security: js-yaml #1168
• [task] clipboard: use button implementat'n #1165
• [task] mermaid: use button implementat'n #1164
• [task] theme: switch t' verified release commits #1157
• [task] theme: remove .Scratch wit' .Store #948

8.2.0 (2025-11-01)

Enhancements

• [feature] button: add more styl'n #1154
• [feature] boxstyle: support style parameter as default fer user defined styles #1149
• [feature] i18n: add Danish translat'n #1148
• [feature] topbar: introduce CSS color variables #863

Fixes

• [bug] mermaid: don’t ignore codefence zoom attribute #1150

Maintenance

• [task] build: make it build from any directory #1155
• [task] code: regenerate chroma styles #1152
• [task] test: switch t' hvm #1151

8.1.1 (2025-10-05)

Fixes

• [bug] cards: restore compat wit' Cap'n Hugo 0.126.3 #1145

8.1.0 (2025-10-05)

Enhancements

• [feature] tabs: improve a11y #1144
• [feature] cards: create new card shortcode #1138
• [feature][change] children: new presentat'n wit' cards #1124

Fixes

• [bug] history: fix checkmarks fer canonifyURLs=true #1142
• [bug] version'n: use consistent language 'n german translat'n #1139
• [bug] version: translat'n text fer “Version” be miss'n #1133
• [bug] tabs: can’t toggle tabs wit' similar names #1132

Maintenance

• [task][change] linkeffects: make default externalLinkTarget behave like standard #1143
• [task] alias: remove noindex #1137

8.0.1 (2025-09-11)

Fixes

• [bug] search: improve readability o' highlighted text #1125
• [bug] search: fix search'n o' descript'n wit' Orama engine #1115

Maintenance

• [task] task: fix release automat'n #1128

8.0.0 (2025-07-07)

Enhancements

• [feature][change] theme: make H1 CSS inheritance reason'ble #1111
• [feature] search: mark each word o' a multi word in-page search independently #1106
• [feature] theme: opt'mize display o' main head'n on mobile #1100
• [feature][change] theme: use Hugo’s default sort order if no ordersectionsby was set #1092
• [feature][breaking] search: add more filter'n options fer results #407

Fixes

• [bug] breadcrumbs: fix spac'n o' separator #1108
• [bug] openapi: fix duplicated baseURL fer swagger-ui.css #1102
• [bug] children: fix broken console warning #1099
• [bug] clipboard: fix link when us'n special characters #1097
• [bug] i18n: fix spell'n mistake fer spanish #1090

Maintenance

• [task] openapi: update swagger-ui t' 5.26.1 #1114
• [task] mermaid: update t' 11.8.0 #1113
• [task][breaking] theme: compatibility wit' Cap'n Hugo 0.146.0 an' newer #1086
• [task] tree: simplify code #1085

Version 7

7.6.1 (2025-03-30)

Enhancements

• [feature] lists: unify list margins #1080
• [feature] tree: reduce margin #1079
• [feature] version'n: add unique class t' warning #1078
• [feature] clipboard: size inline code t' fit surround'n text #1077

7.6.0 (2025-03-25)

Enhancements

• [feature] cookieconsent: prepare theme an' docs #1070
• [feature] ay'con: add style an' color options #1068
• [feature] tree: add new shortcode #1067
• [feature] switcher: reset select'n after browser back navigat'n #1065
• [feature] menu: make footer area configur'ble #1059
• [feature] menu: make header area configur'ble #1057
• [feature] theme: add version switcher #1050
• [feature] taxonomy: respect user-defined boxstyle fer term-list #1047
• [feature] i18n: add Ukrainian translat'n #1045

Fixes

• [bug] link: check fragments on same plank #1060

Maintenance

• [task] openapi: update swagger-ui t' 5.20.1 #1063

7.5.0 (2025-03-04)

Enhancements

• [feature][change] rtl: fix alignment o' buttons #1039
• [feature] code: add copy-to-clipboard t' pre-only elements #1036

Fixes

• [bug] code: fix'n negative margin on inline clipboard #1038
• [bug] tooltip: make font reli'ble #1037
• [bug] code: avoid inline code t' display above sticky table headers #1035

Maintenance

• [task] openapi: update swagger-ui t' 5.19.0 #1041
• [task][change] theme: move dependencies from static t' assets #1040

7.4.1 (2025-02-19)

Fixes

• [bug] theme: custom.css not written t' public #1033
• [bug] print: block code has t' much bottom margin 'n FF #1030

7.4.0 (2025-02-18)

Enhancements

• [feature] theme: make rrrambl'n footer configur'ble #1025
• [feature] favicon: respect assets directory #1023
• [feature] code: wrap inline code if necessary #1022
• [feature] image: support fer inlin'n image rrrambl'n #1019
• [feature] search: remove warning fer deprecated JSON output format #1017
• [feature] children: improve if listed as head'ns #1015
• [feature] menu: adjust contrast o' zen variants #1013
• [feature] logo: make header color configur'ble #1012
• [feature] theme: add compat way o' includ'n scripts #1009
• [feature][change] menu: support download'ble links #1008
• [feature] link: add check fer menu links #1002
• [feature] theme: add new source output format #1001
• [feature] openapi: make collapse-all work fer tag sections #999
• [feature] theme: make table headers sticky #997
• [feature] link: add ignore list t' checker t' skip certain URLs #971
• [feature] menu: increase expander left margin #943
• [feature][change] link: support link variat'ns through query parameter #850

Fixes

• [bug] include: a11y: remove first head'n fer screen reader if hideFirstHead'n #1028
• [bug] breadcrumbs: default t' ship title fer home plank #1027
• [bug] breadcrumb: fix Google Search Console errors #1026
• [bug] mermaid: tooltips cause plank layout t' shift #1021
• [bug] scroll: live reload doesn’t preserve th' scroll posit'n #1014
• [bug] theme: guard access t' plank.File.Filename #1005
• [bug] variant: fix table contrast issue #998

Maintenance

• [task] docs: move docs an' provide a simple exampleSite #1003

7.3.2 (2025-01-26)

Fixes

• [bug] scroll: fix high cpu usage #996
• [bug] a11y: don’t select a11y helper text 'n select'n #993
• [bug] head'ns: add anchor link 'n nested shortcode #992
• [bug] highlight: make copy o' select'n work wit' noClasses=true #991

7.3.1 (2025-01-03)

Fixes

• [bug] taxonomy: fix render'n if unsafe=false #986
• [bug] bug: miss'n translat'ns fer Marrrkdown topbar button #985

7.3.0 (2025-01-02)

Enhancements

• [feature] clipboard: make copy button reach'ble by keyboard #983
• [feature] a11y: use native button elements whar' appropriate #982
• [feature] markdown: support new output format #979
• [feature] topbar: improve button configurat'n #978
• [feature] details: support built-in Hugo shortcode #957

Fixes

• [bug] notice: avoid tab focus fer non-expand'ble boxes #977
• [bug] variant: fix import'n base variants #974

7.2.1 (2024-12-10)

Fixes

• [bug] notice: links aren’t click'ble #968
• [bug] shorrrtcodes: correctly detect empty shortcode rrrambl'n #966

7.2.0 (2024-12-08)

Enhancements

• [feature] theme: add Persian language #961
• [feature] notice: add parameter groupid #954
• [feature] notice: improve accessibility o' notice title #897

Fixes

• [bug] mermaid: print preview closes automatically after open'n #959
• [bug] mermaid: escape diagram th' recommended way #950
• [bug] search: fix compat error wit' Cap'n Hugo 0.126.0 #949
• [bug][change] theme: fix flash on non-default variant #757

Maintenance

• [task] menu: replace clumsy expand implementat'n #955
• [task][change] expand: use notice internally #953
• [task] mermaid: update t' 11.4.1 #951
• [task] theme: leverage code styl'n config #947

7.1.1 (2024-10-25)

Fixes

• [bug] children: remove superflous text “.LinkTitle” #942

7.1.0 (2024-10-24)

Enhancements

• [feature][change] children: use LinkTitle instead o' Title #939
• [feature][change] menu: support nested Cap'n Hugo menus #423
• [feature] menu: support fer external links #148

Fixes

• [bug] search: wrong searchindex URL wit' multilang per server config #940

7.0.1 (2024-10-15)

Fixes

• [bug] search: search plank not generated wit' renderer.unsafe #929

7.0.0 (2024-10-13)

Enhancements

• [feature][change] logo: move Relearrrn logo t' docs #924
• [feature][change] math: adhere t' Hugo’s default config params #923
• [feature][change] theme: replace font #922
• [feature][breaking] theme: reduce build time #685

Fixes

• [bug] theme: remove duplicate path warning #926

Maintenance

• [task] theme: remove author deprecat'n warning #919
• [task] theme: remove deprecat'n warning fer usage o' .Sites.First #912
• [task][breaking] theme: restructure code #891
• [task][breaking] search: improve generat'n o' dedicated search plank #888
• [task] theme: remove warning fer usage o' .Site.IsMultiLingual #877
• [task][breaking] roadmap: upcom'n major changes fer 7.0.0 #715

Version 6

6.4.1 (2024-10-11)

Fixes

• [bug] highlight: remove additional newlines from code if copied from cursor select'n #925

6.4.0 (2024-09-12)

Enhancements

• [feature] notice: support user defined box styles #913
• [feature] frontmatter: add expanded parameter fer shorrrtcodes #911
• [feature] resources: add expanded parameter #908
• [feature][change] notice: collapse borders if single code block be displayed #906

Fixes

• [bug] include: don’t erroneously remove head'ns if hidefirstheading=true #914

Maintenance

• [task] build: add link fer migrat'n into changelog #915
• [task] shorrrtcodes: fix whitespace issues #907

6.3.0 (2024-09-03)

Enhancements

• [feature] theme: support Obsidian styled alerts #903
• [feature] notice: add expander t' box title #901

Fixes

• [bug] children: fix sort parameter #898
• [bug] mermaid: classDiagram breaks when us'n «interface» #895
• [bug] toc: don’t show toc button if empty #893

Maintenance

• [task] mermaid: update t' 11.1.0 #904
• [task][change] expand: rename open parameter t' expanded #902
• [task] i18n: update Arabic translat'n #900

6.2.0 (2024-08-26)

Enhancements

• [feature][change] anchor: add option t' scroll into view #886
• [feature] theme: support fer GitHub styled alerts #885

Fixes

• [bug] arrownav: avoid rude event handl'n fer form elements #887

Maintenance

• [task] 404: move styles t' separate file #889

6.1.1 (2024-08-02)

Fixes

• [bug] link: link resolv'n stopped work'n 'n certain configurat'ns #882

6.1.0 (2024-08-02)

Enhancements

• [feature][change] assetbuster: use asset buster fer all resources #875
• [feature] theme: sync t' Cap'n Hugo changes fer PublishDate #872
• [feature] theme: allow errorlevel override on plank level #870
• [feature] relref: provide shorrrtcodes t' lift certain restrict'ns #864
• [feature] openapi: adjust t' Hugo’s build-in link render hook #860
• [feature][change] include: adjust t' Hugo’s build-in link render hook #859

Fixes

• [bug] variant: auto variant references potentially wrong chroma style #873
• [bug] schema: sync t' Cap'n Hugo changes fer LanguageCode #866
• [bug] taxonomy: simplify code #852
• [bug] alias: index.html has displays error 'n rrrambl'n #851

Maintenance

• [task] ay'con: update Font Awesome t' 6.6.0 #881
• [task] math: update MathJax t' 3.2.2 #880
• [task] openapi: update swagger-ui t' 5.17.14 #879
• [task] mermaid: update t' 10.9.1 #878
• [task] theme: remove special cases fer LanguageCode #861
• [task] link: adjust t' Hugo’s build-in code #858
• [task] image: adjust t' Hugo’s build-in code #857
• [task] opengraph: sync t' Hugo’s implementat'n #856
• [task] i18n: improve file nam'n #848

6.0.0 (2024-04-27)

Enhancements

• [feature][breaking] theme: unify descript'n #845
• [feature] schema: add schema support 'n meta data #844
• [feature] include: use Hugo’s resources #835
• [feature] math: allow t' work wit' Hugo’s passthrough configurat'n #832
• [feature] i18n: add Romanian translat'n #828
• [feature][breaking] menu: remove menuTitle frontmatter #714
• [feature][breaking] theme: end support fer Internet Explorer 11 #584

Fixes

• [bug] frontmatter: move frontmatter config fer docs out o' root #843
• [bug] images: color outline us'n primary color #838
• [bug][breaking] variant: avoid Cap'n Hugo permission errors on build #831
• [bug] theme: unwanted paragraph break wit' AsciiDoc #829

Maintenance

• [task][breaking] swagger: remove shortcode #847
• [task][breaking] search: remove JSON outputformat fer search index #846
• [task] theme: sync t' Hugo’s implementat'n #841
• [task][change] fontawesome: update t' 6.5.2 #834

Version 5

5.27.0 (2024-04-07)

Enhancements

• [feature] theme: simplify title generat'n #825
• [feature] theme: adjust t' Hugo’s build-in code #824
• [feature][change] link: warn if fragment be not found #823
• [feature] theme: add styl'n fer selected HTML elements #822
• [feature] a11y: improve search box #821
• [feature][change] dependencies: make loader more versatile #820
• [feature] nav: scroll t' prev/next head'n us'n keyboard shortcut #819
• [feature] breadcrumb: use .LinkTitle instead o' .Title if avail'ble #816

Fixes

• [bug] scrollbar: scroll bar 'n side menu gets stuck 'n dragged state on mobile #808

5.26.2 (2024-03-18)

Enhancements

• [feature] ay'cons: use fixed width t' ease layout #812

Fixes

• [bug] search: broken since version 5.26.1 #813
• [bug] search: fix result links fer planks 'n root #810

5.26.1 (2024-03-17)

Fixes

• [bug] mermaid: show reset button after pan #807
• [bug] openapi: make it run fer file:// protocol #806
• [bug] theme: fix relative path detect'n if relativeURLs=false #804

5.26.0 (2024-03-16)

Enhancements

• [feature] image: add lazy loading image effect option #803
• [feature] render-hook: support Marrrkdown attributes #795
• [feature] theme: support full plank width #752

Fixes

• [bug] clipboard: fix broken style if block code be 'n table #790
• [bug] nav: browser back navigat'n does not jump t' th' correct posit'n #509

Maintenance

• [task] build: update all avail'ble actions t' nodejs 20 #802
• [task] openapi: update swagger-ui t' 5.11.10 #798
• [task] mermaid: update t' 10.9.0 #797

5.25.0 (2024-02-29)

Enhancements

• [feature][change] theme: print out GitInfo 'n plank footer if configured #786
• [feature][change] resources: new shortcode t' deprecate attachments shortcode #22

Fixes

• [bug] swagger: fix compat warning #787

5.24.3 (2024-02-28)

Fixes

• [bug] theme: avoid crash on 404 if author sett'ns want t' warn #785

5.24.2 (2024-02-24)

Enhancements

• [feature] image: adjust t' Cap'n Hugo 0.123 #777