Version 7
See the changelog of this version for a detailed list of changes.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
- overwritten th'
header.html
,menu.html
orfooter.html
partials - self-defined output formats
- self-defined archetype partials 'n
layouts/partials/archetypes
- now becom'n plank designs - 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.
Ye need t' remove th' now obsolete
search
an'searchpage
output format from[outputs.home]
'n yerhugo.toml
, result'n 'n someth'n similar t'hugo.[outputs] home = ['html', 'rss', 'print']
outputs: home: - html - rss - print
{ "outputs": { "home": [ "html", "rss", "print" ] } }
Aft that, yer build will succeed but will most likely 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 yerhugo.toml
.See th' updated documentat'n fer reference.
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 load'n 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' opt'ns an' front matter t' force load'n 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' simplermath=true
ormath.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' yerhugo.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 opt'ns 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
- opt'ns o' th' navigat'n menu
- configur'n breadcrumb, titles an' head'ns o' yer rrrambl'n
- opt'ns fer us'n links
- add'n custom output formats