Migrrrat'n
This document shows ye what’s new 'n th' latest release. For a detailed list o' changes, see th' history plank.
Break'n: A change that requires act'n by ye aft upgrad'n t' assure th' ship be still functional.
Change: A change 'n default behavior. This may requires act'n by ye / may or may not be revert'ble by configurat'n.
New: Marks new behavior ye might find interest'n or comes configur'ble.
2.5.0
- Change: Add new colors
--MAIN-CODE-color
an'--MAIN-CODE-BG-color
fer rules highlightn'n fallback 'n yer stylesheet 'n caseguessSyntax=true
be set. Ideally they be set t' th' same values as th' ones from yer chosen chroma style.
2.4.0
-
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. Th' documentat'n was adjusted accordingly.
-
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 yerconfig.toml
. -
New: Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th'
alwaysopen
opt'n 'n yerconfig.toml
. Please see further documentat'n fer poss'ble values an' default behavior. -
New: New frontmatter
ordersectionsby
opt'n t' change immediate children sort'n 'n menu an'children
shorrrtcode. Poss'ble values betitle
orweight
. -
New: Alternate rambl'n o' a plank be now advertised 'n th' HTML meta tags. See Cap'n Hugo documentat'n.
2.2.0
- 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 yerconfig.toml
.
2.1.0
-
Change: In case th' site’s structure contains addional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see CHANGELOG.md 'n exampleSite), they will now be ignored by th' search.
-
New: Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n
disableSearchHiddenPages=true
'n yerconfig.toml
. -
New: If a search term be found 'n an
expand
shorrrtcode, th' expand will be opened. -
New: Th' menu will scroll th' active item into view on board.
2.0.0
-
Change: Syntaxhighlightn'n was switched t' built 'n Hugo mechanism. Ye may need t' configure a new stylesheet or decide t' roll ye own as describedd 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
. -
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. -
Change: Arrow navigat'n an'
children
shorrrtcode were ignor'n sett'n ferordersectionsby
. 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 ashidden=true
. -
New: Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further documentat'n fer poss'ble values an' default behavior.
-
New: New partials fer defin'n pre/post rambl'n fer menu items an' th' rambl'n. See documentat'n fer further read'n.
-
New: Shorrrtcode
children
wit' new parametercontainerstyle
. -
New: New shorrrtcode
include
t' include arbitrary file rambl'n into a plank.
1.2.0
- New: Shorrrtcode
expand
wit' new parameter t' open on plank board.
1.1.0
- New:
Merrrmaid
config opt'ns can be set 'nconfig.toml
.