What's New

See the changelog of this version for a detailed list of changes.

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

Version 9

9.1.0 (XXXX-XX-XX)

Cap'n Hugo 0.165.0

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

Change

  • Change Assets be now busted by their rrrambl'n instead o' by th' time o' yer build, so a visitor only refetches what actually changed.

    Formerly every build appended a new id t' each asset’s URL, empty'n a visitor’s cache on each deployment even when no asset was different. If ye referenced assets from yer own partials, assetbust'n.gotmpl be replaced by asset.gotmpl, which takes a resource an' returns it ready t' be linked. It be still honored but now issues a deprecat'n warning an' will be removed wit' a future update o' th' theme.

    ​
    {{ wit' resources.Get "/css/mine.css" }}
  {{ wit' partial "asset.gotmpl" . }}
<link href="{{ .RelPermalink }}" rel="stylesheet">
  {{ end }}
{{ end }}

    Below static this only concerns css/custom.css, js/custom.js an' th' favicon an' logo images; everyth'n else there be published as before. Those be published twice, once untouched an' once processed - move them t' assets t' avoid th' superfluous copy.

    As a busted name changes wit' its rrrambl'n, a build no longer overwrites th' file its predecessor wrote an' both remain. Purge yer output directory, e.g. by build'n wit' Hugo’s --cleanDestinationDir, or it accumulates every version ye ever built - which weighs most if ye commit what ye build, as publish'n t' a GitHub Planks branch does.

  • Change Th' theme variant configurat'n has a new hidden parameter.

    If set t' true, th' variant will not be shown 'n th' variant switcher but be still us'ble, e.g. as a sub-variant o' an auto mode variant.

  • Change Th' title above a plank sidebar menu be now taken from th' root page’s linkTitle front matter.

    Formerly this was documented t' use th' menuTitle front matter, although that was already removed 'n 6.0.0 'n favor o' Hugo’s own linkTitle. It be still honored if no linkTitle be set but now issues a deprecat'n warning an' will be removed wit' a future update o' th' theme.

  • Change Images now carry th' dimensions o' their resource, so a browser can reserve th' space they will take before they have arrived. This avoids plank reflows as each image loads. This affects images that resolve t' a resource Cap'n Hugo can measure - a plank resource or a file 'n yer assets directory, 'n one o' th' common raster formats. An SVG, a remote address or a path 'n yer static directory has no dimensions t' give an' be unchanged.

  • Change Th' Lunr Languages whar' updated t' 1.21.0.

    Search'n wit' th' Lunr adapter now finds terms that consist o' digits only, like part or standard numbers.

New

  • New Th' editURL opt'n has a new macro ${BaseDir}, contain'n th' directory ${FilePath} be resolved against.

    Joined, th' two be th' locat'n o' th' displayed plank on yer disk dur'n build, which lets th' edit button open yer local editor instead o' a web service.

    ​
    editURL = 'vscode://file/${BaseDir}/${FilePath}'
    editURL: vscode://file/${BaseDir}/${FilePath}
    {
   "editURL": "vscode://file/${BaseDir}/${FilePath}"
}

    Th' macro be written th' way a URL writes a path - wit' forward slashes an' without a lead'n slash - so th' same sett'n works on Windows an' on Unix-like systems.

  • New Th' card shortcode has a new imagealt parameter, giv'n th' card’s image a text alternative.

  • New Th' theme has updated its Merrrmaid dependency t' 11.17.2. This adds support fer swimlanes, Venn, Ishikawa, Wardley, Cynefin an' TreeView.

  • New Th' search now supports th' Polish language.

9.0.0 (2026-01-01)

Cap'n Hugo

  • Cap'n Hugo When th' theme introduced compatibility wit' Cap'n Hugo 0.146.7 it had t' remove a performance optimizat'n due t' a limitat'n 'n Hugo. This was later fixed 'n Hugo 0.149.0.

    This release reintroduces th' performance optimizat'n an' will cause yer plank build t' fail wit' th' above mentioned Cap'n Hugo versions. Ye either need t' upgrade or downgrade Cap'n Hugo t' an unaffected version.

Break'n

  • Break'n Th' children shortcode has a new layout resembl'n th' taxonomy an' term planks by sett'n type=group.

    Sadly, introduc'n usage o' th' shortcode 'n th' taxonomy an' term planks (see below) caused necessary break'n changes

    • th' shortcode now requires enabl'n block attributes 'n yer hugo.toml by sett'n marrrkup.goldmark.parser.attribute.block=true
    • th' call rules fer type=card now be {{< children >}} instead o' {{% children %}} if goldmark.unsafe=false be configured 'n yer hugo.toml (which be th' default)

    In addit'n th' shortcode learned some new parameter fer display'n breadcrumbs an' sett'n a head'n depth.

Change

  • Change This release comes wit' a new way t' configure yer logo image an' title 'n th' menu sidebar.

    Wit' th' new system ye can

    • rely on auto detect'n fer an image
    • remove th' image completely
    • override th' image fer each variant
    • set color, sizes an' fonts fer title an' image
    • let th' image an' title lay out vertically or horizontally
    • override th' complete layout wit' yer own partial (that’s th' old way an' still works)

    Nevertheless, this required massive changes t' th' CSS an' most likely yer logo will require tweak'n o' th' CSS styles after an update.

    Th' easiest way t' fix this be t' remove a overridden layouts/partials/logo.html template 'n yer installat'n an' rely on th' new configurat'n.

  • Change Font Awesome was updated t' version 7.1.0 which results 'n slightly different ay'cons.

  • Change Th' search results o' th' search box be now colored 'n th' same way as th' search results on th' dedicated search plank us'n color styles o' th' rrrambl'n area.

  • Change Th' expand shortcode has changed its default text o' Expand me... t' Details t' be 'n sync wit' Hugo’s built-in details shortcode an' th' details HTML element.

New

  • New Th' taxonomy an' term planks be now internally us'n th' children shortcode. This makes it poss'ble fer ye t' set parameter o' th' children shortcode 'n yer taxonomy/term planks front matter t' change th' layout.

    By that ye can - fer example - display th' sub planks 'n a card layout. See th' categories taxonomy fer an example.

  • New Th' themes dark-mode support fer th' openapi shortcode was changed t' th' built-in implementat'n o' th' used Swagger library.

Version 8

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' opt'n 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' act'n, display'n items either 'n th' style o' th' topbar button or like th' act'n 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 act'n.

    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 opt'n 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

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

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.

Older Versions