nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 01:33:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
hugo-theme-relearn/searchindex.pir.js
McShelby 949b0e416d deploy: 247eccdb65
2024-10-25 06:33:51 +00:00

2565 lines
578 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

var relearn_searchindex = [
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "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",
"description": "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",
"tags": [],
"title": "Version 5.27",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/27/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nChange Th' dependency loader was made more versatile.\nTh' 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.\nWit' 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.\nBy 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.\nNew New Additional styl'n was added fer th' native HTML elements \u003cmark\u003e an' \u003ckbd\u003e. T' use them ye must allow th' usage o' HTML 'n yer hugo.toml. Th' Marrrkdown documentat'n was enhanced fer this.\nNew 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.\nNew 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.",
"description": "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.",
"tags": [],
"title": "Version 5.27",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/27/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "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 load'n image effect opt'n #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 t'ble #790 [bug] nav: browser back navigat'n does not jump t' th' correct posit'n #509 Maintenance [task] build: update all avail'ble act'ns t' nodejs 20 #802 [task] openapi: update swagger-ui t' 5.11.10 #798 [task] mermaid: update t' 10.9.0 #797",
"description": "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",
"tags": [],
"title": "Version 5.26",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/26/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.26.0 (2024-03-18) New New Th' lazy load'n 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.\nNew 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.\nNew Images an' Marrrkdown codefences be now respect'n Hugo’s Marrrkdown attributes.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer block diagrams.\nNew 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.",
"description": "5.26.0 (2024-03-18) New New Th' lazy load'n 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.",
"tags": [],
"title": "Version 5.26",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/26/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "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",
"description": "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",
"tags": [],
"title": "Version 5.25",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/25/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.25.0 (2024-02-29) Change Change This release deprecates th' attachments shortcode 'n favor o' th' new th' resources shortcode.\nIf 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).\nAnyways, 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.\nChange 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.",
"description": "5.25.0 (2024-02-29) Change Change This release deprecates th' attachments shortcode 'n favor o' th' new th' resources shortcode.",
"tags": [],
"title": "Version 5.25",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/25/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "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 Fixes [bug] link: resolve fragments #775 5.24.1 (2024-02-18) Enhancements [feature] link: make resolut'n report'n configur'ble #774 5.24.0 (2024-02-17) Enhancements [feature] theme: compatibility wit' Cap'n Hugo 0.123 #771 [feature] topbar: support editURL 'n frontmatter #764 [feature] menu: use –MENU-WIDTH-S t' adjust mobile flyout #761 [feature] figure: support built-in shortcode #746 [feature] theme: make head'n a template #744 [feature] taxonomy: make arrow nav browse through terms #742 [feature] theme: switch from config.toml t' hugo.toml #741 [feature] button: make non-interactive if used as mock #740 [feature][change] topbar: allow text fer button #739 [feature] theme: run hugo demo ship without warning #736 [feature] menu: make swipe handler passive #735 [feature] i18n: support standard Cap'n Hugo opt'ns #733 [feature] a11y: show tab focus on images #730 [feature] a11y: improve discover'n links on keyboard navigat'n #726 [feature][change] variant: increase contrast fer light themes #722 [feature] theme: break build if minimum Cap'n Hugo version be not matched #719 [feature] taxonomy: hum'nize term on miss'n term title #713 Fixes [bug] taxonomy: display translated title #772 [bug] highlight: fix codefence rules 'n Hugo \u003e= 0.121.0 #749 [bug] link: fix links t' planks contain'n dots 'n their name #748 [bug] image: get resource images if link be prefixed wit' ./ #747 [bug] theme: switch dependency colors on OS color scheme change #745 [bug] clipboard: fix O(n²) buttons #738 [bug] button: fix whitespac'n 'n FF #737 [bug] i18n: fix warning messages fer zh-CN #732 [bug] mermaid: fix zoom button #725 [bug] theme: fix JS errors on hugo --minifiy #724 [bug] include: fix whitespac'n 'n codefences #723",
"description": "5.24.3 (2024-02-28) Fixes [bug] theme: avoid crash on 404 if author sett'ns want t' warn #785",
"tags": [],
"title": "Version 5.24",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/24/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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 opt'n was renamed t' hint while th' new title opt'n be now displayed next t' th' ay'con.\nChange Th' front matter opt'n menuTitle be now deprecated 'n favor fer Hugo’s own linkTitle. Ye don’t need t' change anyth'n as th' old menuTitle opt'n be still supported.\nChange 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.\nNew New If th' theme can not 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.\nPlease note that a plank link will generate false negatives if uglyURLs=true an' it references an ordinary plank before 0.123.0.\nPlease note that an image link will generate false negatives if th' file resides 'n yer static directory.\nNew Ye now can configure additional opt'ns 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 opt'ns will still work (but may generate warnings now).\nTh' 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.\nNew New partial fer defin'n th' head'n. See documentat'n fer further read'n.\nNew Support fer Hugo’s built-in figure shortcode.\nNew On taxonomy an' term planks ye can now use prev/next navigat'n as within th' normal plank structure.\nNew 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-WIDTH-S CSS property.\nNew Improvements fer accessibility when tabb'n through th' plank fer images, links an' tab handles.\nNew Th' editURL config parameter be now overwrit'ble '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.\nNew Th' themes config an' front matter opt'ns received a comprehensive documentat'n update. In addit'n th' theme switched from config.toml t' hugo.toml.\nNew 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.\nNew 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.",
"description": "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 opt'n was renamed t' hint while th' new title opt'n be now displayed next t' th' ay'con.",
"tags": [],
"title": "Version 5.24",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/24/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.23.2 (2023-11-03) Enhancements [feature] taxonomy: improve taxonomy plank #712 [feature] taxonomy: warn on miss'n term title #709 Fixes [bug] taxonomy: fix sort'n o' terms on rrrambl'n planks #710 5.23.1 (2023-10-30) Enhancements [feature] taxonomy: improve term plank #705 Fixes [bug] variant: fix typo 'n chroma-learn.css #708 [bug] links: ignore local markdown links link'n t' files wit' extension #707 5.23.0 (2023-10-29) Enhancements [feature] taxonomy: allow fer rrrambl'n on term planks #701 [feature] theme: write full file path on warnings #699 [feature] theme: show anchor link an' copy t' clipboard button on mobile #697 [feature][change] config: adjust t' changes 'n Hugo 0.120 #693 [feature] variants: add more contrast t' neon #692 [feature] mermaid: only show zoom reset button if zoomed #691 [feature] menu: add additional sort opt'ns #684 [feature] theme: add social media meta informat'n #683 [feature] theme: simplify additional JS dependencies #682 [feature] links: warn if ref/relref be used falsly #681 [feature] menu: make width configur'ble #677 [feature] tabs: use color fer link o' inactive tabs #675 [feature] taxonomy: modularize term list generat'n #671 [feature] theme: remove warnings wit' hugo --printI18nWarn'ns #670 [feature] theme: implement port'ble link'n #377 Fixes [bug] links: extra space before link text #700 [bug] mermaid: reset zoom correctly #690 [bug] theme: fix mobile layout fer width=48rem #676 [bug] frontmatter: resemble documented shortcode style #672 [bug] taxonomy: display terms 'n planks if removePathAccents=true #669 Maintenance [task] mermaid: update mermaid t' 10.6.0 #703 [task] openapi: update swagger-ui t' 5.9.1 #702",
"description": "5.23.2 (2023-11-03) Enhancements [feature] taxonomy: improve taxonomy plank #712 [feature] taxonomy: warn on miss'n term title #709 Fixes [bug] taxonomy: fix sort'n o' terms on rrrambl'n planks #710",
"tags": [],
"title": "Version 5.23",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/23/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nChange yer previous sett'n from\nhugo. toml yaml json [params] author = 'Hugo' params: author: Cap'n Hugo { \"params\": { \"author\": \"Hugo\" } } t'\nhugo. 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.\nNew New Taxonomy an' term planks be now allowed t' contain rrrambl'n. This be added inbetween th' title an' th' plank list.\nNew It be now poss'ble t' print custom taxonomies anywhere 'n yer plank. See th' docs.\nNew It be now poss'ble t' adjust th' menu width fer yer whole ship. See th' docs.\nNew This release adds social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. See th' docs.\nNew This release comes wit' additional sort opt'ns 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).\nNew 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.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer th' xychart type.\nNew This release adds port'ble Marrrkdown links.\nPreviously 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.\nYe could work around this by us'n th' relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results 'n non-port'ble Marrrkdown.\nNow 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.\nTh' follow'n types o' link'n be supported:\nlink 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",
"description": "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.",
"tags": [],
"title": "Version 5.23",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/23/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.22.1 (2023-10-02) Enhancements [feature] i18n: add Swahili translat'n #666 [feature] math: hide unrendered math #663 [feature] tabs: improve a11y by remov'n duplicate hidden title #662 [feature] mermaid: improve zoom UX #659 Fixes [bug] variant: fix sidebar-flyout borders color fer zen #667 [bug] clipboard: fix RTL locat'n o' tooltip #661 [bug] clipboard: ignore RTL fer code #660 [bug] expand: fix aria-controls #658 [bug] theme: fix id generat'n fer markdownified titles #657 [bug] mermaid: avoid graph bomb'n on hugo –minify #656 [bug] mermaid: fix width fer some graphs #655 5.22.0 (2023-09-26) Enhancements [feature] mermaid: add pan\u0026zoom reset #651 [feature] markdown: add interlace color fer tables #648 [feature] search: add breadcrumb t' dedicated search results #647 [feature][change] menu: optionally dis'ble index planks fer sections #642 Fixes [bug] variants: restore generator zoom #650 [bug] clipboard: malused Fontawesome style #649 [bug][change] theme: avoid id collisions between head'ns an' theme #646 [bug] theme: remove HTML validat'n errors #644 [bug] breadcrumb: remove superflous whitespace between items #643",
"description": "5.22.1 (2023-10-02) Enhancements [feature] i18n: add Swahili translat'n #666 [feature] math: hide unrendered math #663 [feature] tabs: improve a11y by remov'n duplicate hidden title #662 [feature] mermaid: improve zoom UX #659 Fixes [bug] variant: fix sidebar-flyout borders color fer zen #667 [bug] clipboard: fix RTL locat'n o' tooltip #661 [bug] clipboard: ignore RTL fer code #660 [bug] expand: fix aria-controls #658 [bug] theme: fix id generat'n fer markdownified titles #657 [bug] mermaid: avoid graph bomb'n on hugo –minify #656 [bug] mermaid: fix width fer some graphs #655",
"tags": [],
"title": "Version 5.22",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/22/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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-.\nIf ye haven’t modified anyth'n, everyth'n be fine. Otherwise ye have t' check yer custom CSS rules an' JavaScript code.\nChange Ye can now have structural sections 'n th' hierarchical menu without generat'n a plank fer it.\nThis 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.\nThis 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.\nIn 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.\nNew New It be now poss'ble t' overwrite th' sett'n fer collapsibleMenu o' yer hugo.toml inside o' a page’s front matter.\nNew 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.\nNew It be now poss'ble t' remove th' root breadcrumb by sett'n disableRootBreadcrumb=true 'n yer hugo.toml.\nNew Th' output o' th' dedicated search plank now displays th' result’s breadcrumb.\nNew T'ble rows now change their background color on every even row.\nNew Translat'n into Swahili. This language be not supported fer search.",
"description": "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-.",
"tags": [],
"title": "Version 5.22",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/22/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.21.0 (2023-09-18) Enhancements [feature] topbar: make buttons configur'ble #639 [feature][change] menu: fix footer padd'n #637 Fixes [bug] breadcrumb: don’t ignore spaces fer separator #636 [bug] theme: fix snyk code issues #633 [bug] images: apply image effects t' lightbox images #631 Maintenance [task] openapi: update t' swagger 5.7.2 #641",
"description": "5.21.0 (2023-09-18) Enhancements [feature] topbar: make buttons configur'ble #639 [feature][change] menu: fix footer padd'n #637 Fixes [bug] breadcrumb: don’t ignore spaces fer separator #636 [bug] theme: fix snyk code issues #633 [bug] images: apply image effects t' lightbox images #631 Maintenance [task] openapi: update t' swagger 5.7.2 #641",
"tags": [],
"title": "Version 5.21",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/21/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nNew 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.",
"description": "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.",
"tags": [],
"title": "Version 5.21",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/21/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.20.0 (2023-08-26) Enhancements [feature][change] theme: support fer colored borders between menu an' rrrambl'n #626 [feature] image: allow opt'n t' apply image effects globally #623 [feature][change] openapi: switch t' light syntaxhighlight'n whar' applic'ble #621 [feature] images: document usage o' images wit' links #576 Fixes [bug] highlight: fix render'n fer Cap'n Hugo \u003c 0.111 #630 [bug] search: remove link underline on dedicated search plank #627 [bug] highlight: don’t switch t' block view if hl_inline=true #618 [bug] variant: minor adjustments t' zen variants #617 [bug] mermaid: lazy render graph if it be initially hidden #187 Maintenance [task] openapi: update t' swagger 5.4.1 #620",
"description": "5.20.0 (2023-08-26) Enhancements [feature][change] theme: support fer colored borders between menu an' rrrambl'n #626 [feature] image: allow opt'n t' apply image effects globally #623 [feature][change] openapi: switch t' light syntaxhighlight'n whar' applic'ble #621 [feature] images: document usage o' images wit' links #576 Fixes [bug] highlight: fix render'n fer Cap'n Hugo \u003c 0.111 #630 [bug] search: remove link underline on dedicated search plank #627 [bug] highlight: don’t switch t' block view if hl_inline=true #618 [bug] variant: minor adjustments t' zen variants #617 [bug] mermaid: lazy render graph if it be initially hidden #187 Maintenance [task] openapi: update t' swagger 5.4.1 #620",
"tags": [],
"title": "Version 5.20",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/20/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.20.0 (2023-08-26) Change Change Th' theme has updated its Swagger dependency t' 5.4.1 fer th' openapi shortcode.\nWit' 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.\nAdditionally, th' syntaxhighlight'n inside o' openapi fer print'n was switched t' a light scheme fer all theme variants.\nIf ye dislike this change, ye can revert this 'n yer theme variants CSS by add'n\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.\nNew New Th' theme variants Zen Light an' Zen Dark now add more contrast between menu, topbar an' rrrambl'n by add'n thin borders.\nThose 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.\nFor exist'n variants noth'n has changed visually.\nNew 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.\nNew 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.\nNew 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.",
"description": "5.20.0 (2023-08-26) Change Change Th' theme has updated its Swagger dependency t' 5.4.1 fer th' openapi shortcode.",
"tags": [],
"title": "Version 5.20",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/20/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.19.0 (2023-08-12) Enhancements [feature] highlight: add title parameter #616 [feature] variant: signal variant switch as event #614 [feature] variant: add zen variant 'n light an' dark #613 [feature] i18n: add Hungarian translat'n #604 [feature] mermaid: update t' 10.3.0 #601 Fixes [bug] siteparam: avoid halt if param be a map/slice #611 [bug] mermaid: fix broken zoom since update t' v10 #608 [bug] mermaid: variant generator diagram does not respond t' events #607 [bug] print: avoid chroma leak fer relearn-dark #605 Maintenance [task] mermaid: update t' 10.3.1 #610",
"description": "5.19.0 (2023-08-12) Enhancements [feature] highlight: add title parameter #616 [feature] variant: signal variant switch as event #614 [feature] variant: add zen variant 'n light an' dark #613 [feature] i18n: add Hungarian translat'n #604 [feature] mermaid: update t' 10.3.0 #601 Fixes [bug] siteparam: avoid halt if param be a map/slice #611 [bug] mermaid: fix broken zoom since update t' v10 #608 [bug] mermaid: variant generator diagram does not respond t' events #607 [bug] print: avoid chroma leak fer relearn-dark #605 Maintenance [task] mermaid: update t' 10.3.1 #610",
"tags": [],
"title": "Version 5.19",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/19/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nNew Th' theme has added two new color variants zen-light an' zen-dark. Check it out!\nNew 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.\nNew 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).\nNew Translat'n into Hungarian.",
"description": "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.",
"tags": [],
"title": "Version 5.19",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/19/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.18.0 (2023-07-27) Enhancements [feature][change] shorrrtcodes: add more deprecat'n warnings #598 [feature][change] shorrrtcodes: change context parameter t' plank if called as partial #595 [feature] siteparam: support nested parameters an' text formatt'n #590 [feature][change] a11y: improve when tabb'n through links #581 Fixes [bug] openapi: inherit RTL sett'n from Cap'n Hugo rrrambl'n #600 [bug] 404: fix display 'n RTL #597 [bug] highlight: fix posit'n o' copy-to-clipboard button 'n RTL #594 [bug] openapi: fix spell'n #593 [bug] search: fix typo 'n output format #591 [bug] tabs: fix tab select'n by groupid #582 [bug] theme: restore compat wit' Cap'n Hugo 0.95.0 #580 [bug][change] theme: improve display o' links #577",
"description": "5.18.0 (2023-07-27) Enhancements [feature][change] shorrrtcodes: add more deprecat'n warnings #598 [feature][change] shorrrtcodes: change context parameter t' plank if called as partial #595 [feature] siteparam: support nested parameters an' text formatt'n #590 [feature][change] a11y: improve when tabb'n through links #581 Fixes [bug] openapi: inherit RTL sett'n from Cap'n Hugo rrrambl'n #600 [bug] 404: fix display 'n RTL #597 [bug] highlight: fix posit'n o' copy-to-clipboard button 'n RTL #594 [bug] openapi: fix spell'n #593 [bug] search: fix typo 'n output format #591 [bug] tabs: fix tab select'n by groupid #582 [bug] theme: restore compat wit' Cap'n Hugo 0.95.0 #580 [bug][change] theme: improve display o' links #577",
"tags": [],
"title": "Version 5.18",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/18/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.18.0 (2023-07-27) Change Change Th' theme adds additional warnings fer deprecated or now unsupported features.\nChange 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.\nNew New Restored compatibility wit' Cap'n Hugo 0.95.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' siteparam shortcode be now cap'ble 'n display'n nested params as well as support'n text formatt'n.",
"description": "5.18.0 (2023-07-27) Change Change Th' theme adds additional warnings fer deprecated or now unsupported features.",
"tags": [],
"title": "Version 5.18",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/18/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.17.1 (2023-06-22) Enhancements [feature][change] highlight: make copy t' clipboard appear on hover #574 5.17.0 (2023-06-22) Enhancements [feature] highlight: add configur'ble line breaks #169 Fixes [bug] theme: support Cap'n Hugo 0.114.0 #573 [bug] taxonomy: fix number tags #570 [bug] highlight: improve copy t' clipboard #569",
"description": "5.17.1 (2023-06-22) Enhancements [feature][change] highlight: make copy t' clipboard appear on hover #574",
"tags": [],
"title": "Version 5.17",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/17/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.17.0 (2023-06-22) Change Change Th' default behavior fer th' copy-to-clipboard feature fer code blocks has changed.\nTh' copy-to-clipboard button fer code blocks will now only be displayed if th' reader hovers th' code block.\nIf 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.\nNew New Restored compatibility wit' Cap'n Hugo 0.114.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' new highlight shortcode replaces Hugo’s default implementat'n an' be fully compat'ble. So ye don’t need t' change anyth'n.\nIn addit'n it offers some extensions. Currently only th' wrap extension opt'n be provided t' control whether a code block should be wrapped or scrolled if t' long t' fit.",
"description": "5.17.0 (2023-06-22) Change Change Th' default behavior fer th' copy-to-clipboard feature fer code blocks has changed.",
"tags": [],
"title": "Version 5.17",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/17/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.16.2 (2023-06-10) Enhancements [feature] theme: revamp 404 plank #566 5.16.1 (2023-06-09) Enhancements [feature] theme: add deprecat'n warnings #565 Fixes [bug] mermaid: allow fer YAML frontmatter inside o' graph #564 [bug] alias: fix redirect URLs 'n case o' empty BaseURL #562 5.16.0 (2023-06-08) Enhancements [feature] tabs: add title an' ay'con opt'n #552 [feature] shorrrtcodes: add style opt'n t' mimic code box color scheme #551 [feature] tabs: support color opt'ns #550 [feature] favicon: add light \u0026 dark opt'n fer OS’s preferred color scheme #549 Fixes [bug] ay'con: remove whitespace on start #560 [bug] shorrrtcodes: avoid superflous margin at start an' end o' rrrambl'n #558 [bug] expand: fix html encod'n o' finish'n rrrambl'n tag #557 [bug] ay'con: fix ouput “raw HTML omitted” wit' goldmark config unsafe=false #555",
"description": "5.16.2 (2023-06-10) Enhancements [feature] theme: revamp 404 plank #566 5.16.1 (2023-06-09) Enhancements [feature] theme: add deprecat'n warnings #565 Fixes [bug] mermaid: allow fer YAML frontmatter inside o' graph #564 [bug] alias: fix redirect URLs 'n case o' empty BaseURL #562",
"tags": [],
"title": "Version 5.16",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/16/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nDEPRECATION warnings mark features that still work but may be removed 'n th' future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange Th' 404 error plank was revamped. Hopefully ye will not see this very often.\nNew 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.\nTh' 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.\nAdditionally 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.\nNew Th' theme now optionally supports separate favicons fer light \u0026 dark mode.",
"description": "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.",
"tags": [],
"title": "Version 5.16",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/16/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.15.2 (2023-05-29) Enhancements [feature] taxonomy: add support fer category default taxonomy #541 Fixes [bug] attachments: work fer Cap'n Hugo \u003c 0.112 #546 5.15.1 (2023-05-25) Fixes [bug] shorrrtcodes: intermediately use random ids instead o' .Ordinal #543 5.15.0 (2023-05-25) Enhancements [feature] tab: new shortcode t' display single tab #538 [feature][change] tabs: treat groupid as unique if not set #537 [feature] expand: indent expanded rrrambl'n #536 [feature] notice: make boxes more prominent #535 Fixes [bug] attachments: fix build error since Cap'n Hugo 0.112 #540 Maintenance [task] chore: update Merrrmaid t' 9.4.3 #534 [task] mermaid: update t' 10.2.0 #499",
"description": "5.15.2 (2023-05-29) Enhancements [feature] taxonomy: add support fer category default taxonomy #541 Fixes [bug] attachments: work fer Cap'n Hugo \u003c 0.112 #546",
"tags": [],
"title": "Version 5.15",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/15/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nTh' attachments shortcode has compatibility issues wit' newer Cap'n Hugo versions. Ye must switch t' leaf bundles or be locked t' Cap'n Hugo \u003c 0.112.0 fer now.\nIt 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 break'n change.\nChange Th' tabs shortcode has changed behavior if ye haven’t set th' groupid parameter.\nFormerly 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.\nNew 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.\nAdditionally fer such a use case, th' whitespace between a tab outline an' th' code be removed if only a single code block be contained.\nNew 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.",
"description": "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.",
"tags": [],
"title": "Version 5.15",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/15/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.14.3 (2023-05-20) Fixes [bug] tags: show taxonomy toc fer standard installat'n #533 5.14.2 (2023-05-20) Fixes [bug] tags: translate breadcrumb an' title fer taxonomy #532 5.14.1 (2023-05-20) No changelog fer this release. 5.14.0 (2023-05-19) Enhancements [feature] tags: improve search index fer tags #531 [feature] tags: increase readability o' taxonomy planks #530 [feature] nav: make breadcrumb separator configur'ble #529 [feature] i18n: add translat'n fer default taxonomies #528 [feature] theme: set appropriate defaults fer all theme specific params #516 [feature] theme: allow t' display tags below article #513 Fixes [bug] shortcode: make .context always a plank #527",
"description": "5.14.3 (2023-05-20) Fixes [bug] tags: show taxonomy toc fer standard installat'n #533",
"tags": [],
"title": "Version 5.14",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/14/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nHugo’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.\nNew T' give ye more flexibility 'n customiz'n yer article layout a new partial content-header.html be introduced.\nThis 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.\nSo how t' adjust th' posit'n o' tags start'n from th' theme’s default whar' tags be only shown above th' title?\nHide tags above title: Overwrite content-header.html wit' an empty file. Show tags between title an' rrrambl'n: Overwrite heading-post.html an' add {{ partial \"tags.html\" . }} t' it. 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.",
"description": "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.",
"tags": [],
"title": "Version 5.14",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/14/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.13.2 (2023-05-17) Fixes [bug] print: en'ble print fer planks wit' _build opt'ns #522 5.13.1 (2023-05-16) Fixes [bug] openapi: allow toc t' scroll plank #526 5.13.0 (2023-05-14) Enhancements [feature][change] openapi: replace implementat'n wit' swagger-ui #523 Fixes [bug] variant: avoid leak'n shadows 'n neon print style #524",
"description": "5.13.2 (2023-05-17) Fixes [bug] print: en'ble print fer planks wit' _build opt'ns #522",
"tags": [],
"title": "Version 5.13",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/13/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nAdditionally, th' implemant'n o' this shortcode was switched from RapiDoc t' SwaggerUI.",
"description": "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.",
"tags": [],
"title": "Version 5.13",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/13/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.12.6 (2023-05-04) Enhancements [feature] theme: better HTML titles an' breadcrumbs fer search an' tag planks #521 Fixes [bug] menu: avoid hid'n o' expander on hover when active item has children #520 [bug] menu: showVisitedLinks not work'n fer some theme variants #518 [bug] theme: fix resource URLs fer 404 plank on subdirectories #515 5.12.5 (2023-03-28) Fixes [bug] expand: not properly exanded when used 'n bullet point list #508 5.12.4 (2023-03-24) Fixes [bug] theme: disableExplicitIndexURLs param be not work'n as expected #505 5.12.3 (2023-03-14) Fixes [bug] attachments: fix links if only one language be present #503 [bug] shorrrtcodes: allow markdown fer title an' rrrambl'n #502 5.12.2 (2023-03-03) Fixes [bug] menu: fix state fer alwaysopen=false + collapsibleMenu=false #498 5.12.1 (2023-02-26) Enhancements [feature] variant: add relearn bright theme #493 Fixes [bug] generator: fix sett'n o' colors #494 5.12.0 (2023-02-24) Enhancements [feature] frontmatter: support VSCode Front Matter extension #481 [feature] theme: make expand an' image ids st'ble #477 [feature] variant: set scrollbar color t' dark fer dark variants #471 [feature] i18n: add full RTL support #470 [feature] piratify: fix some quirks, arrr #469 [feature][change] theme: optimizat'n fer huge screen sizes #466 Fixes [bug] i18n: write code ltr even fer rtl languages #492 [bug] anchor: fix link 'n FF when served from file system #482 [bug] shorrrtcodes: don’t break build an' render fer invalid parameters #480 [bug] nav: restore scroll posit'n on browser back #476 [bug] variant: avoid style leak fer auto style #473 Maintenance [task] build: add imagebot #485",
"description": "5.12.6 (2023-05-04) Enhancements [feature] theme: better HTML titles an' breadcrumbs fer search an' tag planks #521 Fixes [bug] menu: avoid hid'n o' expander on hover when active item has children #520 [bug] menu: showVisitedLinks not work'n fer some theme variants #518 [bug] theme: fix resource URLs fer 404 plank on subdirectories #515",
"tags": [],
"title": "Version 5.12",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/12/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nTh' 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\n​ 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.\nNew Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.",
"description": "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.",
"tags": [],
"title": "Version 5.12",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/12/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.11.2 (2023-02-07) Fixes [bug] tabs: nested tabs rrrambl'n be not displayed #468 5.11.1 (2023-02-06) Fixes [bug] variant: include miss'n theme-auto.css 'n distribut'n #467 5.11.0 (2023-02-05) Enhancements [feature] i18n: add Czech translat'n #455 [feature][change] lightbox: switch t' CSS-only solut'n #451 [feature][change] variant: add support fer prefers-color-scheme #445 [feature][change] expand: refactor fer a11y #339 [feature][change] mermaid: make zoom configur'ble #144 Fixes [bug] swagger: avoid errors when us'n invalid rapi-doc fragment ids #465 [bug] search: fix oddities 'n keyboard handl'n #463 [bug] badge: fix text color fer IE11 #462 [bug] mermaid: rerender graph if search term be present an' variant be switched #460 [bug] tags: show tag on planks when tag has space #459 [bug] edit: remove do'ble slash on root plank link #450 Maintenance [task] build: add mov'n version tags #453 [task][change] theme: remove jQuery #452 [task] build: check fer release notes before release #448",
"description": "5.11.2 (2023-02-07) Fixes [bug] tabs: nested tabs rrrambl'n be not displayed #468",
"tags": [],
"title": "Version 5.11",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/11/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "5.11.0 (2023-02-07) Change Change Th' theme removed th' popular jQuery library from its distribut'n.\nIn 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:\n​ layouts/partials/custom-header.html \u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Merrrmaid diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.\nTh' 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.\nChange Th' theme be now cap'ble t' visually adapt t' yer OS’s light/dark mode sett'n.\nThis be also th' new default sett'n if ye haven’t configured themeVariant 'n yer hugo.toml.\nAdditionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new themeVariantAuto parameter.\nThis be not supported fer Internet Explorer 11, which still displays 'n th' relearn-light variant.\nChange Th' JavaScript code fer handl'n image lightboxes (provided by Featherlight) was replaced by a CSS-only solut'n.\nThis 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.\nChange 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.\nNew New Translat'n into Czech. This language be not supported fer search.\nNew 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.",
"description": "5.11.0 (2023-02-07) Change Change Th' theme removed th' popular jQuery library from its distribut'n.",
"tags": [],
"title": "Version 5.11",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/11/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.10.2 (2023-01-25) Fixes [bug] nav: fix breadcrumb fer huge installat'ns #446 5.10.1 (2023-01-25) Fixes [bug] print: fix image links wit' relative path #444 5.10.0 (2023-01-25) Enhancements [feature] shorrrtcodes: support fer accent color #440 [feature] shorrrtcodes: add color parameter whar' applic'ble #438 [feature] theme: announce translat'ns as alternate links #422 Fixes [bug] nav: fix breadcrumbs fer deeply nested sections #442 [bug] theme: improve whitespac'n 'n tables #441",
"description": "5.10.2 (2023-01-25) Fixes [bug] nav: fix breadcrumb fer huge installat'ns #446",
"tags": [],
"title": "Version 5.10",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/10/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nAdditionally th' --ACCENT-color brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.",
"description": "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.",
"tags": [],
"title": "Version 5.10",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/10/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigat'n respect ordersectionsby configurat'n #170 2.9.4 (2022-02-06) Fixes [bug] exampleSite: fix links 'n official documentat'n #168 2.9.3 (2022-02-06) Fixes [bug] menu: invalid URL when th' shortcut be an internal link #163 2.9.2 (2021-11-26) Enhancements [feature] theme: add theme version info t' head #158 Fixes [bug] theme: fix select'n o' *.ico files as favicons #160 2.9.1 (2021-11-22) Fixes [bug] menu: fix significantly low performance fer collect'n o' meta info #157 2.9.0 (2021-11-19) Fixes [bug][break'n] relref: fix inconsistent behavior #156 [bug] search: make dropdown stick t' search field when scroll'n #155 [bug] menu: align long text properly #154 [bug] copyToClipBoard: add miss'n right border fer inline code if disableInlineCopyToClipBoard=true #153 [bug] menu: show hidden sibl'n planks reliably #152 [bug] menu: br'n active item 'n sight fer large menus #149",
"description": "2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigat'n respect ordersectionsby configurat'n #170",
"tags": [],
"title": "Version 2.9",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/9/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "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.\nIn 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:\nType 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.\nAlso, 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.\nIn 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.\nYe may see errors on th' console after th' update 'n th' form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"configuration/reference/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": plank not found In this case, ye must apply one o' two opt'ns:\nStart 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.\nCopy 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.",
"description": "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.",
"tags": [],
"title": "Version 2.9",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/9/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.9.4 (2023-01-23) Fixes [bug] variant: fix search ay'con an' text color #437 5.9.3 (2023-01-22) Fixes [bug] nav: fix left/right navigat'n fer horizontal scroll'n #435 [bug][break'n] theme: allow planks on top level #434 Maintenance [task] build: switch t' wildcard version o' act'ns #428 5.9.2 (2022-12-30) Fixes [bug] search: apply dependency scripts fer Hindi an' Japanese #427 5.9.1 (2022-12-23) Enhancements [feature] theme: make external link target configur'ble #426 5.9.0 (2022-12-23) Enhancements [feature][change] theme: open external links 'n separate tab #419 [feature] theme: make it a Cap'n Hugo module #417 Fixes [bug][change] attachments: fix incorrect links fer defaultContentLanguageInSubdir=true #425",
"description": "5.9.4 (2023-01-23) Fixes [bug] variant: fix search ay'con an' text color #437",
"tags": [],
"title": "Version 5.9",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/9/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nIt 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.\nT' get rid o' this undesired behavior ye have two choices:\nMake 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 exampleSite’s content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.\n​ 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\" } Store th' plank file fer below a parent headless branch bundle an' add th' follow'n front matter t' he parent (see exampleSite’s 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.\n​ 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 exampleSite’s content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } Change Change Th' required directory name fer th' attachments shortcode was changed fer leaf bundles.\nPreviously, 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.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis 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.\nChange Absolute links prefixed wit' http:// or https:// be now opened 'n a separate browser tab.\nYe can revert back t' th' old behavior by defin'n externalLinkTarget=\"_self\" 'n th' params section o' yer hugo.toml.\nNew New Th' theme now supports Hugo’s module system.",
"description": "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.",
"tags": [],
"title": "Version 5.9",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/9/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset t' initial size #145 [bug] mermaid: remove whitespace from big graphs #143 2.8.2 (2021-11-08) Fixes [bug] mermaid: always board javascript t' avoid break if code fences be used #142 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS 'n multilang setup if search be disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally avail'ble via config.toml #133 [feature] mermaid: only board javascript if necessary #95 [feature][change] theme: switch font #83 [feature] theme: make favicon configur'ble #2 Fixes [bug] mermaid: assert that window.mermaid be actually mermaid #136 [bug] menu: remove usage o' Hugo’s UniqueID #131 [bug] theme: reduce margin fer children shortcode #130 [bug] theme: left-align h3 'n chapters #129 [bug] theme: align copy link t' clipboard #128",
"description": "2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset t' initial size #145 [bug] mermaid: remove whitespace from big graphs #143",
"tags": [],
"title": "Version 2.8",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/8/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "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.\nNew Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' disableToc opt'n 'n yer hugo.toml. For an example see th' example configurat'n.",
"description": "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.",
"tags": [],
"title": "Version 2.8",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/8/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.8.1 (2022-12-11) Fixes [bug] theme: fix alias fer home plank if defaultContentLanguageInSubdir=true #414 5.8.0 (2022-12-08) Enhancements [feature] ay'con: add new shortcode #412 [feature] theme: style an' document markdown extensions #411 [feature] badge: add new shortcode #410 [feature] theme: add accent color #409 Fixes [bug] theme: fix spac'n fer tag flyout 'n FF #413",
"description": "5.8.1 (2022-12-11) Fixes [bug] theme: fix alias fer home plank if defaultContentLanguageInSubdir=true #414",
"tags": [],
"title": "Version 5.8",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/8/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nNew Th' new ay'con shortcode simplyfies th' usage o' ay'cons. This can even be combined wit' also new badge shortcode.\nNew 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.\nNew 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.",
"description": "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.",
"tags": [],
"title": "Version 5.8",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/8/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.7.0 (2021-10-24) Enhancements [feature] notice: support custom titles #124",
"description": "2.7.0 (2021-10-24) Enhancements [feature] notice: support custom titles #124",
"tags": [],
"title": "Version 2.7",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/7/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "2.7.0 (2021-10-24) New New Optional second parameter fer notice shortcode t' set title 'n box header.",
"description": "2.7.0 (2021-10-24) New New Optional second parameter fer notice shortcode t' set title 'n box header.",
"tags": [],
"title": "Version 2.7",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/7/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.7.0 (2022-11-29) Enhancements [feature] button: refactor fer a11y #372 Fixes [bug] search: don’t freeze browser on long search terms #408 [bug] search: fix searchbox placeholder color 'n FF an' IE #405 [bug][change] i18n: rename Korean translat'n from country t' lang code #404 Maintenance [task] search: update lunr languages t' 1.10.0 #403",
"description": "5.7.0 (2022-11-29) Enhancements [feature] button: refactor fer a11y #372 Fixes [bug] search: don’t freeze browser on long search terms #408 [bug] search: fix searchbox placeholder color 'n FF an' IE #405 [bug][change] i18n: rename Korean translat'n from country t' lang code #404 Maintenance [task] search: update lunr languages t' 1.10.0 #403",
"tags": [],
"title": "Version 5.7",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/7/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nNew Th' search now supports th' Korean language.",
"description": "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.",
"tags": [],
"title": "Version 5.7",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/7/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "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' exampleSite #924 [feature][change] math: adhere t' Hugo’s default config params #923 [feature][change] theme: replace font #922 [feature][break'n] 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 war'n fer usage o' .Sites.First #912 [task][break'n] theme: restructure code #891 [task][break'n] search: improve generat'n o' dedicated search plank #888 [task] theme: remove warning fer usage o' .Site.IsMultiLingual #877 [task][break'n] roadmap: upcom'n major changes fer 7.0.0 #715",
"description": "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",
"tags": [],
"title": "Version 7",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/7/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "7.1.0 (2024-10-24) Change Change Th' sidebar menus be now completely configur'ble.\nThis be provided by th' new parameter sidebarmenus. Wit' th' new system, ye can\nshow 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.\nChange Th' children shortcode was changed t' output a page’s LinkTitle instead o' previously us'n th' Title.\nAs 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.\nTh' 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.\nNew 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\nsuffered 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.\nIf ye haven’t done customizat'ns t' any partials, ye can update right away.\nIf 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.\nSpecifically, ye will have t' adapt yer ship if ye have\noverwritten th' header.html, menu.html or footer.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.\nYe need t' remove th' now obsolete search an' searchpage output format from [outputs.home] 'n yer hugo.toml, result'n 'n someth'n similar t'\nhugo. 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 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.\nIn 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.\nSee th' updated documentat'n fer reference.\nChange Change Once again, th' theme changed th' font. We switched t' th' excellent Roboto Flex font.\nCare 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.\nThis 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.\nTh' 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.\nIf 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.\nAdditionally, 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.\nChange 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.\n--MAIN-TITLES-TEXT-font was renamed t' --MAIN-TITLES-font, --MAIN-TITLES-H\u003cn\u003e-color was renamed t' --MAIN-TITLES-H\u003cn\u003e-TEXT-color.\nChange Th' opt'ns an' front matter t' force load'n a math, mermaid or openapi library has been changed.\nPreviously, 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.\nYe don’t need t' change anyth'n yet but will receive warnings if th' old sett'ns be used.\nChange Th' default logo be not contained inside o' th' theme’s logo partial anymore.\nThis be t' avoid usage o' th' theme’s brand'n throughout th' web 'n non-modified installat'ns.\nIn addit'n, th' default text fer th' logo partial be now taken from th' linkTitle sett'n o' yer hugo.toml.\nNew New Th' docs received a much-needed overhaul fer all chapters.\nBasically, 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.\nTh' 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.\nT' 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.\nAlso, a lot o' previously undocumented features be now included, namely\nth' hidden planks feature opt'ns o' th' menus configur'n breadcrumb, titles an' head'ns o' yer rrrambl'n opt'ns fer us'n links add'n custom output formats",
"description": "7.1.0 (2024-10-24) Change Change Th' sidebar menus be now completely configur'ble.",
"tags": [],
"title": "Version 7",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/7/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.6.0 (2021-10-21) Fixes [bug] theme: generate correct links if theme served from subdirectory #120",
"description": "2.6.0 (2021-10-21) Fixes [bug] theme: generate correct links if theme served from subdirectory #120",
"tags": [],
"title": "Version 2.6",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/6/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "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.",
"description": "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.",
"tags": [],
"title": "Version 2.6",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/6/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.6.6 (2022-11-23) Enhancements [feature] search: make build an' js forgiv'n against config errors #400 Fixes [bug] variant: minor color adjustments #402 [bug] variant: fix generator fer use o' neon #401 5.6.5 (2022-11-19) Fixes [bug] menu: relax usage o' background color #399 5.6.4 (2022-11-19) Fixes [bug] theme: make alias planks us'ble by file:// protocol #398 5.6.3 (2022-11-19) Fixes [bug] theme: be compat'ble wit' Cap'n Hugo \u003e= 0.95.0 #397 5.6.2 (2022-11-19) Fixes [bug] theme: build breaks sites without “output” section 'n config #396 5.6.1 (2022-11-19) Fixes [bug] theme: fix image distort'n #395 5.6.0 (2022-11-18) Enhancements [feature] toc: improve keyboard handl'n #390 [feature] search: improve keyboard handl'n #387 [feature] search: add dedicated search plank #386 [feature] theme: make creat'n o' generator meta tag configur'ble #383 [feature] theme: increase build performance #380 Fixes [bug] mermaid: avoid lead'n whitespace #394 [bug] theme: fix build errors when referenc'n SVGs 'n markdown #393 [bug] variant: avoid neon t' leak into IE11 fallback #392 [bug] theme: fix urls fer file:// protocol 'n sitemap #385 [bug] theme: add id t' h1 elements #384 [bug] rss: fix display o' hidden subpages #382 [bug] nav: fix key navigat'n when press'n wrong modifiers #379 Maintenance [task] mermaid: update t' version 9.2.2 #391",
"description": "5.6.6 (2022-11-23) Enhancements [feature] search: make build an' js forgiv'n against config errors #400 Fixes [bug] variant: minor color adjustments #402 [bug] variant: fix generator fer use o' neon #401",
"tags": [],
"title": "Version 5.6",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/6/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nT' 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.\nYe can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.\nNew Keyboard handl'n fer th' TOC an' search was improved.\nPress'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.\nTh' 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.\nNew 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.\nT' 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.\nNew Creat'n o' yer project gets a little bit faster wit' this release.\nThis 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.).",
"description": "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.",
"tags": [],
"title": "Version 5.6",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/6/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "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 opt'n 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][break'n] 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][break'n] menu: remove menuTitle frontmatter #714 [feature][break'n] theme: end support fer Internet Explorer 11 #584 Fixes [bug] frontmatter: move frontmatter config fer exampleSite out o' root #843 [bug] images: color outline us'n primary color #838 [bug][break'n] variant: avoid Cap'n Hugo permission errors on build #831 [bug] theme: unwanted paragraph break wit' AsciiDoc #829 Maintenance [task][break'n] swagger: remove shortcode #847 [task][break'n] 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",
"description": "6.4.1 (2024-10-11) Fixes [bug] highlight: remove additional newlines from code if copied from cursor select'n #925",
"tags": [],
"title": "Version 6",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/6/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "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.\nNew 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.\nChange 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.\nNew New Th' notice shortcode has a new parameter expanded t' make th' rrrambl'n collaps'ble.\nNew If ye be runn'n Hugo 0.134.0 or later, th' theme now supports Obsidian callouts.\nNew 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.\nIf 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.\nIf ye dislike th' new behavior, ye can deactivate it by sett'n disableAnchorScrolling=true 'n yer hugo.toml. See th' docs fer further opt'ns.\nNew New If ye be runn'n Hugo 0.132.0 or later, th' theme be now cap'ble t' print GitHub alerts.\nNew T' support new severity levels fer GitHub alerts, all shorrrtcodes that support severity levels wit' their style parameter were expanded wit' th' new severities caut'n 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.\nNew 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).\nChange 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.\nNew 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 can not be resolved.\nNew Shorrrtcodes support'n an errorlevel configurat'n can now have overridden values 'n th' front matter section o' each individual plank.\nNew Th' theme now comes wit' its own overridden version o' th' relref shortcode.\nWhile 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.\nTh' shortcode be deactivated by default an' can be activated by sett'n\nhugo. 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.\nThis was necessary t' avoid permission errors on build if runn'n 'n certain Unix configurat'ns.\nIn addit'n it be not allowed anymore t' @import yer chroma stylesheet from inside o' yer variant stylesheet.\nSay, yer chroma stylesheet be named chroma-monokai.css, ye have t' add th' follow'n inside yer variant stylesheet:\n--CODE-theme: monokai; Break'n Th' parameter descript'n 'n yer hugo.toml will now be ignored.\nWit' 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.\nFor migrat'n, move th' descript'n parameter o' yer hugo.toml into th' front matter section o' yer home plank.\nBreak'n Search support fer th' json outputformat deprecated 'n 5.4.0 was removed.\nChange it t' search fer th' homepage 'n yer hugo.toml. See th' docs fer detailed configurat'n.\nBreak'n Th' front matter opt'n menuTitle deprecated 'n 5.24.0 was removed 'n favor fer Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead o' title t' generate th' breadcrumb.\nBreak'n Th' swagger shortcode deprecated 'n 5.13.0 was removed 'n favor fer th' openapi shortcode wit' th' same set o' parameter.\nBreak'n Support fer Internet Explorer 11 was finally dropped.\nChange Change Wit' th' removal o' support fer Internet Explorer 11, Font Awesome was upgraded t' version 6.5.2.\nYe may experience slight changes fer some ay'cons. In addit'n ye have additional ~1700 ay'cons t' chose from.\nChange 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.\nPreviously, th' summary erroneously was ignored which now can lead t' different output if ye set description=true as a parameter.\nNew 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 can not be resolved.\nNew Math be now us'ble without enclos'n it 'n a shortcode or Marrrkdown codefence by us'n Hugo’s passthrough configurat'n.\nNew Translat'n into Romanian.",
"description": "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.",
"tags": [],
"title": "Version 6",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/6/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.5.1 (2021-10-12) Fixes [bug] security: fix XSS fer malicious image URLs #117 2.5.0 (2021-10-08) Enhancements [feature][change] rules highlight: provide default colors fer unknown languages #113 Fixes [bug] security: fix XSS fer malicious URLs #114 [bug] menu: write correct local shortcut links #112",
"description": "2.5.1 (2021-10-12) Fixes [bug] security: fix XSS fer malicious image URLs #117",
"tags": [],
"title": "Version 2.5",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/5/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "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.",
"description": "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.",
"tags": [],
"title": "Version 2.5",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/5/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "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 load'n image effect opt'n #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 t'ble #790 [bug] nav: browser back navigat'n does not jump t' th' correct posit'n #509 Maintenance [task] build: update all avail'ble act'ns 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 Fixes [bug] link: resolve fragments #775 5.24.1 (2024-02-18) Enhancements [feature] link: make resolut'n report'n configur'ble #774 5.24.0 (2024-02-17) Enhancements [feature] theme: compatibility wit' Cap'n Hugo 0.123 #771 [feature] topbar: support editURL 'n frontmatter #764 [feature] menu: use –MENU-WIDTH-S t' adjust mobile flyout #761 [feature] figure: support built-in shortcode #746 [feature] theme: make head'n a template #744 [feature] taxonomy: make arrow nav browse through terms #742 [feature] theme: switch from config.toml t' hugo.toml #741 [feature] button: make non-interactive if used as mock #740 [feature][change] topbar: allow text fer button #739 [feature] theme: run hugo demo ship without warning #736 [feature] menu: make swipe handler passive #735 [feature] i18n: support standard Cap'n Hugo opt'ns #733 [feature] a11y: show tab focus on images #730 [feature] a11y: improve discover'n links on keyboard navigat'n #726 [feature][change] variant: increase contrast fer light themes #722 [feature] theme: break build if minimum Cap'n Hugo version be not matched #719 [feature] taxonomy: hum'nize term on miss'n term title #713 Fixes [bug] taxonomy: display translated title #772 [bug] highlight: fix codefence rules 'n Hugo \u003e= 0.121.0 #749 [bug] link: fix links t' planks contain'n dots 'n their name #748 [bug] image: get resource images if link be prefixed wit' ./ #747 [bug] theme: switch dependency colors on OS color scheme change #745 [bug] clipboard: fix O(n²) buttons #738 [bug] button: fix whitespac'n 'n FF #737 [bug] i18n: fix warning messages fer zh-CN #732 [bug] mermaid: fix zoom button #725 [bug] theme: fix JS errors on hugo --minifiy #724 [bug] include: fix whitespac'n 'n codefences #723 5.23.2 (2023-11-03) Enhancements [feature] taxonomy: improve taxonomy plank #712 [feature] taxonomy: warn on miss'n term title #709 Fixes [bug] taxonomy: fix sort'n o' terms on rrrambl'n planks #710 5.23.1 (2023-10-30) Enhancements [feature] taxonomy: improve term plank #705 Fixes [bug] variant: fix typo 'n chroma-learn.css #708 [bug] links: ignore local markdown links link'n t' files wit' extension #707 5.23.0 (2023-10-29) Enhancements [feature] taxonomy: allow fer rrrambl'n on term planks #701 [feature] theme: write full file path on warnings #699 [feature] theme: show anchor link an' copy t' clipboard button on mobile #697 [feature][change] config: adjust t' changes 'n Hugo 0.120 #693 [feature] variants: add more contrast t' neon #692 [feature] mermaid: only show zoom reset button if zoomed #691 [feature] menu: add additional sort opt'ns #684 [feature] theme: add social media meta informat'n #683 [feature] theme: simplify additional JS dependencies #682 [feature] links: warn if ref/relref be used falsly #681 [feature] menu: make width configur'ble #677 [feature] tabs: use color fer link o' inactive tabs #675 [feature] taxonomy: modularize term list generat'n #671 [feature] theme: remove warnings wit' hugo --printI18nWarn'ns #670 [feature] theme: implement port'ble link'n #377 Fixes [bug] links: extra space before link text #700 [bug] mermaid: reset zoom correctly #690 [bug] theme: fix mobile layout fer width=48rem #676 [bug] frontmatter: resemble documented shortcode style #672 [bug] taxonomy: display terms 'n planks if removePathAccents=true #669 Maintenance [task] mermaid: update mermaid t' 10.6.0 #703 [task] openapi: update swagger-ui t' 5.9.1 #702 5.22.1 (2023-10-02) Enhancements [feature] i18n: add Swahili translat'n #666 [feature] math: hide unrendered math #663 [feature] tabs: improve a11y by remov'n duplicate hidden title #662 [feature] mermaid: improve zoom UX #659 Fixes [bug] variant: fix sidebar-flyout borders color fer zen #667 [bug] clipboard: fix RTL locat'n o' tooltip #661 [bug] clipboard: ignore RTL fer code #660 [bug] expand: fix aria-controls #658 [bug] theme: fix id generat'n fer markdownified titles #657 [bug] mermaid: avoid graph bomb'n on hugo –minify #656 [bug] mermaid: fix width fer some graphs #655 5.22.0 (2023-09-26) Enhancements [feature] mermaid: add pan\u0026zoom reset #651 [feature] markdown: add interlace color fer tables #648 [feature] search: add breadcrumb t' dedicated search results #647 [feature][change] menu: optionally dis'ble index planks fer sections #642 Fixes [bug] variants: restore generator zoom #650 [bug] clipboard: malused Fontawesome style #649 [bug][change] theme: avoid id collisions between head'ns an' theme #646 [bug] theme: remove HTML validat'n errors #644 [bug] breadcrumb: remove superflous whitespace between items #643 5.21.0 (2023-09-18) Enhancements [feature] topbar: make buttons configur'ble #639 [feature][change] menu: fix footer padd'n #637 Fixes [bug] breadcrumb: don’t ignore spaces fer separator #636 [bug] theme: fix snyk code issues #633 [bug] images: apply image effects t' lightbox images #631 Maintenance [task] openapi: update t' swagger 5.7.2 #641 5.20.0 (2023-08-26) Enhancements [feature][change] theme: support fer colored borders between menu an' rrrambl'n #626 [feature] image: allow opt'n t' apply image effects globally #623 [feature][change] openapi: switch t' light syntaxhighlight'n whar' applic'ble #621 [feature] images: document usage o' images wit' links #576 Fixes [bug] highlight: fix render'n fer Cap'n Hugo \u003c 0.111 #630 [bug] search: remove link underline on dedicated search plank #627 [bug] highlight: don’t switch t' block view if hl_inline=true #618 [bug] variant: minor adjustments t' zen variants #617 [bug] mermaid: lazy render graph if it be initially hidden #187 Maintenance [task] openapi: update t' swagger 5.4.1 #620 5.19.0 (2023-08-12) Enhancements [feature] highlight: add title parameter #616 [feature] variant: signal variant switch as event #614 [feature] variant: add zen variant 'n light an' dark #613 [feature] i18n: add Hungarian translat'n #604 [feature] mermaid: update t' 10.3.0 #601 Fixes [bug] siteparam: avoid halt if param be a map/slice #611 [bug] mermaid: fix broken zoom since update t' v10 #608 [bug] mermaid: variant generator diagram does not respond t' events #607 [bug] print: avoid chroma leak fer relearn-dark #605 Maintenance [task] mermaid: update t' 10.3.1 #610 5.18.0 (2023-07-27) Enhancements [feature][change] shorrrtcodes: add more deprecat'n warnings #598 [feature][change] shorrrtcodes: change context parameter t' plank if called as partial #595 [feature] siteparam: support nested parameters an' text formatt'n #590 [feature][change] a11y: improve when tabb'n through links #581 Fixes [bug] openapi: inherit RTL sett'n from Cap'n Hugo rrrambl'n #600 [bug] 404: fix display 'n RTL #597 [bug] highlight: fix posit'n o' copy-to-clipboard button 'n RTL #594 [bug] openapi: fix spell'n #593 [bug] search: fix typo 'n output format #591 [bug] tabs: fix tab select'n by groupid #582 [bug] theme: restore compat wit' Cap'n Hugo 0.95.0 #580 [bug][change] theme: improve display o' links #577 5.17.1 (2023-06-22) Enhancements [feature][change] highlight: make copy t' clipboard appear on hover #574 5.17.0 (2023-06-22) Enhancements [feature] highlight: add configur'ble line breaks #169 Fixes [bug] theme: support Cap'n Hugo 0.114.0 #573 [bug] taxonomy: fix number tags #570 [bug] highlight: improve copy t' clipboard #569 5.16.2 (2023-06-10) Enhancements [feature] theme: revamp 404 plank #566 5.16.1 (2023-06-09) Enhancements [feature] theme: add deprecat'n warnings #565 Fixes [bug] mermaid: allow fer YAML frontmatter inside o' graph #564 [bug] alias: fix redirect URLs 'n case o' empty BaseURL #562 5.16.0 (2023-06-08) Enhancements [feature] tabs: add title an' ay'con opt'n #552 [feature] shorrrtcodes: add style opt'n t' mimic code box color scheme #551 [feature] tabs: support color opt'ns #550 [feature] favicon: add light \u0026 dark opt'n fer OS’s preferred color scheme #549 Fixes [bug] ay'con: remove whitespace on start #560 [bug] shorrrtcodes: avoid superflous margin at start an' end o' rrrambl'n #558 [bug] expand: fix html encod'n o' finish'n rrrambl'n tag #557 [bug] ay'con: fix ouput “raw HTML omitted” wit' goldmark config unsafe=false #555 5.15.2 (2023-05-29) Enhancements [feature] taxonomy: add support fer category default taxonomy #541 Fixes [bug] attachments: work fer Cap'n Hugo \u003c 0.112 #546 5.15.1 (2023-05-25) Fixes [bug] shorrrtcodes: intermediately use random ids instead o' .Ordinal #543 5.15.0 (2023-05-25) Enhancements [feature] tab: new shortcode t' display single tab #538 [feature][change] tabs: treat groupid as unique if not set #537 [feature] expand: indent expanded rrrambl'n #536 [feature] notice: make boxes more prominent #535 Fixes [bug] attachments: fix build error since Cap'n Hugo 0.112 #540 Maintenance [task] chore: update Merrrmaid t' 9.4.3 #534 [task] mermaid: update t' 10.2.0 #499 5.14.3 (2023-05-20) Fixes [bug] tags: show taxonomy toc fer standard installat'n #533 5.14.2 (2023-05-20) Fixes [bug] tags: translate breadcrumb an' title fer taxonomy #532 5.14.1 (2023-05-20) No changelog fer this release. 5.14.0 (2023-05-19) Enhancements [feature] tags: improve search index fer tags #531 [feature] tags: increase readability o' taxonomy planks #530 [feature] nav: make breadcrumb separator configur'ble #529 [feature] i18n: add translat'n fer default taxonomies #528 [feature] theme: set appropriate defaults fer all theme specific params #516 [feature] theme: allow t' display tags below article #513 Fixes [bug] shortcode: make .context always a plank #527 5.13.2 (2023-05-17) Fixes [bug] print: en'ble print fer planks wit' _build opt'ns #522 5.13.1 (2023-05-16) Fixes [bug] openapi: allow toc t' scroll plank #526 5.13.0 (2023-05-14) Enhancements [feature][change] openapi: replace implementat'n wit' swagger-ui #523 Fixes [bug] variant: avoid leak'n shadows 'n neon print style #524 5.12.6 (2023-05-04) Enhancements [feature] theme: better HTML titles an' breadcrumbs fer search an' tag planks #521 Fixes [bug] menu: avoid hid'n o' expander on hover when active item has children #520 [bug] menu: showVisitedLinks not work'n fer some theme variants #518 [bug] theme: fix resource URLs fer 404 plank on subdirectories #515 5.12.5 (2023-03-28) Fixes [bug] expand: not properly exanded when used 'n bullet point list #508 5.12.4 (2023-03-24) Fixes [bug] theme: disableExplicitIndexURLs param be not work'n as expected #505 5.12.3 (2023-03-14) Fixes [bug] attachments: fix links if only one language be present #503 [bug] shorrrtcodes: allow markdown fer title an' rrrambl'n #502 5.12.2 (2023-03-03) Fixes [bug] menu: fix state fer alwaysopen=false + collapsibleMenu=false #498 5.12.1 (2023-02-26) Enhancements [feature] variant: add relearn bright theme #493 Fixes [bug] generator: fix sett'n o' colors #494 5.12.0 (2023-02-24) Enhancements [feature] frontmatter: support VSCode Front Matter extension #481 [feature] theme: make expand an' image ids st'ble #477 [feature] variant: set scrollbar color t' dark fer dark variants #471 [feature] i18n: add full RTL support #470 [feature] piratify: fix some quirks, arrr #469 [feature][change] theme: optimizat'n fer huge screen sizes #466 Fixes [bug] i18n: write code ltr even fer rtl languages #492 [bug] anchor: fix link 'n FF when served from file system #482 [bug] shorrrtcodes: don’t break build an' render fer invalid parameters #480 [bug] nav: restore scroll posit'n on browser back #476 [bug] variant: avoid style leak fer auto style #473 Maintenance [task] build: add imagebot #485 5.11.2 (2023-02-07) Fixes [bug] tabs: nested tabs rrrambl'n be not displayed #468 5.11.1 (2023-02-06) Fixes [bug] variant: include miss'n theme-auto.css 'n distribut'n #467 5.11.0 (2023-02-05) Enhancements [feature] i18n: add Czech translat'n #455 [feature][change] lightbox: switch t' CSS-only solut'n #451 [feature][change] variant: add support fer prefers-color-scheme #445 [feature][change] expand: refactor fer a11y #339 [feature][change] mermaid: make zoom configur'ble #144 Fixes [bug] swagger: avoid errors when us'n invalid rapi-doc fragment ids #465 [bug] search: fix oddities 'n keyboard handl'n #463 [bug] badge: fix text color fer IE11 #462 [bug] mermaid: rerender graph if search term be present an' variant be switched #460 [bug] tags: show tag on planks when tag has space #459 [bug] edit: remove do'ble slash on root plank link #450 Maintenance [task] build: add mov'n version tags #453 [task][change] theme: remove jQuery #452 [task] build: check fer release notes before release #448 5.10.2 (2023-01-25) Fixes [bug] nav: fix breadcrumb fer huge installat'ns #446 5.10.1 (2023-01-25) Fixes [bug] print: fix image links wit' relative path #444 5.10.0 (2023-01-25) Enhancements [feature] shorrrtcodes: support fer accent color #440 [feature] shorrrtcodes: add color parameter whar' applic'ble #438 [feature] theme: announce translat'ns as alternate links #422 Fixes [bug] nav: fix breadcrumbs fer deeply nested sections #442 [bug] theme: improve whitespac'n 'n tables #441 5.9.4 (2023-01-23) Fixes [bug] variant: fix search ay'con an' text color #437 5.9.3 (2023-01-22) Fixes [bug] nav: fix left/right navigat'n fer horizontal scroll'n #435 [bug][break'n] theme: allow planks on top level #434 Maintenance [task] build: switch t' wildcard version o' act'ns #428 5.9.2 (2022-12-30) Fixes [bug] search: apply dependency scripts fer Hindi an' Japanese #427 5.9.1 (2022-12-23) Enhancements [feature] theme: make external link target configur'ble #426 5.9.0 (2022-12-23) Enhancements [feature][change] theme: open external links 'n separate tab #419 [feature] theme: make it a Cap'n Hugo module #417 Fixes [bug][change] attachments: fix incorrect links fer defaultContentLanguageInSubdir=true #425 5.8.1 (2022-12-11) Fixes [bug] theme: fix alias fer home plank if defaultContentLanguageInSubdir=true #414 5.8.0 (2022-12-08) Enhancements [feature] ay'con: add new shortcode #412 [feature] theme: style an' document markdown extensions #411 [feature] badge: add new shortcode #410 [feature] theme: add accent color #409 Fixes [bug] theme: fix spac'n fer tag flyout 'n FF #413 5.7.0 (2022-11-29) Enhancements [feature] button: refactor fer a11y #372 Fixes [bug] search: don’t freeze browser on long search terms #408 [bug] search: fix searchbox placeholder color 'n FF an' IE #405 [bug][change] i18n: rename Korean translat'n from country t' lang code #404 Maintenance [task] search: update lunr languages t' 1.10.0 #403 5.6.6 (2022-11-23) Enhancements [feature] search: make build an' js forgiv'n against config errors #400 Fixes [bug] variant: minor color adjustments #402 [bug] variant: fix generator fer use o' neon #401 5.6.5 (2022-11-19) Fixes [bug] menu: relax usage o' background color #399 5.6.4 (2022-11-19) Fixes [bug] theme: make alias planks us'ble by file:// protocol #398 5.6.3 (2022-11-19) Fixes [bug] theme: be compat'ble wit' Cap'n Hugo \u003e= 0.95.0 #397 5.6.2 (2022-11-19) Fixes [bug] theme: build breaks sites without “output” section 'n config #396 5.6.1 (2022-11-19) Fixes [bug] theme: fix image distort'n #395 5.6.0 (2022-11-18) Enhancements [feature] toc: improve keyboard handl'n #390 [feature] search: improve keyboard handl'n #387 [feature] search: add dedicated search plank #386 [feature] theme: make creat'n o' generator meta tag configur'ble #383 [feature] theme: increase build performance #380 Fixes [bug] mermaid: avoid lead'n whitespace #394 [bug] theme: fix build errors when referenc'n SVGs 'n markdown #393 [bug] variant: avoid neon t' leak into IE11 fallback #392 [bug] theme: fix urls fer file:// protocol 'n sitemap #385 [bug] theme: add id t' h1 elements #384 [bug] rss: fix display o' hidden subpages #382 [bug] nav: fix key navigat'n when press'n wrong modifiers #379 Maintenance [task] mermaid: update t' version 9.2.2 #391 5.5.3 (2022-11-10) Fixes [bug] tags: fix non-latin tag display on planks #378 5.5.2 (2022-11-08) Fixes [bug] theme: fix typo 'n 404.html #376 [bug] theme: allow menu items an' children t' be served by file:// protocol #375 5.5.1 (2022-11-07) Fixes [bug] theme: fix overflow'n issue wit' anchors an' tooltips #364 5.5.0 (2022-11-06) Enhancements [feature][change] theme: opt'mize plank board fer images #304 Fixes [bug] theme: fix context 'n render hooks #373 [bug] print: make canonical URL absolute #371 5.4.3 (2022-11-05) Enhancements [feature] history: refactor fer a11y #341 Fixes [bug] theme: fix multilang links when ship served from subdirectory #370 5.4.2 (2022-11-05) Maintenance [task] build: change set-output t' env vars #348 5.4.1 (2022-11-05) Fixes [bug] mermaid: fix Gantt chart width #365 5.4.0 (2022-11-01) Enhancements [feature] math: allow pass'n o' parameters wit' codefence rules #363 [feature] i18n: add Finnish translat'n #361 [feature] mermaid: allow pass'n o' parameters wit' codefence rules #360 [feature] i18n: support RTL #357 [feature][change] button: add opt'n fer target #351 [feature][change] theme: allow t' be served by file:// protocol #349 5.3.3 (2022-10-09) Fixes [bug] archetypes: fix frontmatter on home.md template #346 5.3.2 (2022-10-08) Fixes [bug] nav: change defunct keyboard shortcuts #344 5.3.1 (2022-10-08) Enhancements [feature] i18n: update Spanish translat'n #343 [feature] theme: opt'n t' align images #327 5.3.0 (2022-10-07) Enhancements [feature] expander: improve whitespace between label an' rrrambl'n #338 [feature] swagger: improve print version #333 Fixes [bug] print: fix links o' subsections #340 [bug] theme: remove W3C validator errors #337 [bug] children: remove unused plank parameter from docs #336 [bug] print: remove menu placeholder 'n Firefox #335 [bug] swagger: fix download button overflow #334 [bug][change] a11y: remove WCAG errors whar' applic'ble #307 5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter planks overwrite font-size #328 5.2.2 (2022-08-23) Fixes [bug] print: fix urls fer uglyURLs=true #322 5.2.1 (2022-08-05) Enhancements [feature] i18n: improve Japanese translat'n #318 Fixes [bug] nav: prev/next ignores ordersectionby #320 Maintenance [task] task: bump Cap'n Hugo minimum requirement t' 0.95 #319 5.2.0 (2022-08-03) Enhancements [feature][change] menu: expand collapsed menus if search term be found 'n submenus #312 Fixes [bug] print: switch mermaid an' swagger style before print #316 [bug] theme: fix chapter margins on big screens #315 5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme t' light #313 [bug] mermaid: header be show'n up 'n FF #311 5.1.1 (2022-07-15) Fixes [bug] tags: don’t count tags if plank be hidden #310 5.1.0 (2022-07-15) Enhancements [feature][change] print: make print url deterministic #309 [feature] theme: allow overrid'n partials fer output formats #308 5.0.3 (2022-07-07) Fixes [bug] ie11: no styles after rework o' archetypes #306 5.0.2 (2022-07-07) Fixes [bug] theme: board CSS if JS be disabled #305 5.0.1 (2022-07-07) Enhancements [feature][break'n] theme: opt'mize load'n o' js an' css #303 5.0.0 (2022-07-05) Enhancements [feature][change] archetypes: modularize render'n #300 [feature] history: don’t reload plank when history gets cleared #299 [feature] menu: replace expander by fontawesome chevrons #296 [feature] theme: align rrrambl'n wit' topbar ay'con limits #290 [feature] button: allow fer empty href #288 [feature] i18n: make Simplified Chinese th' standard language fer th' zn code #287 [feature] clipboard: move head styles t' stylesheet #286 [feature] math: add mathjax render'n #235 [feature] theme: allow fer plank head'n modificat'n #139 Fixes [bug] favicon: fix URL if ship resides 'n subdirectory #302 [bug] code: show copy-to-clipboard marker fer blocklevel code #298 [bug] menu: make active expander vis'ble on hover #297 [bug] print: dis'ble arrow navigat'n #294 [bug] print: add miss'n plank break after index or section #292 [bug] theme: use more space on wide screens #291 [bug] theme: fix size o' chapter head'n #289 Maintenance [task] chore: update RapiDoc 9.3.3 #301 [task] chore: update Merrrmaid 9.1.3 #293",
"description": "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",
"tags": [],
"title": "Version 5",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "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.\nChange Th' dependency loader was made more versatile.\nTh' 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.\nWit' 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.\nBy 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.\nNew New Additional styl'n was added fer th' native HTML elements \u003cmark\u003e an' \u003ckbd\u003e. T' use them ye must allow th' usage o' HTML 'n yer hugo.toml. Th' Marrrkdown documentat'n was enhanced fer this.\nNew 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.\nNew 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 load'n 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.\nNew 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.\nNew Images an' Marrrkdown codefences be now respect'n Hugo’s Marrrkdown attributes.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer block diagrams.\nNew 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.\nIf 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).\nAnyways, 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.\nChange 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 opt'n was renamed t' hint while th' new title opt'n be now displayed next t' th' ay'con.\nChange Th' front matter opt'n menuTitle be now deprecated 'n favor fer Hugo’s own linkTitle. Ye don’t need t' change anyth'n as th' old menuTitle opt'n be still supported.\nChange 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.\nNew New If th' theme can not 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.\nPlease note that a plank link will generate false negatives if uglyURLs=true an' it references an ordinary plank before 0.123.0.\nPlease note that an image link will generate false negatives if th' file resides 'n yer static directory.\nNew Ye now can configure additional opt'ns 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 opt'ns will still work (but may generate warnings now).\nTh' 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.\nNew New partial fer defin'n th' head'n. See documentat'n fer further read'n.\nNew Support fer Hugo’s built-in figure shortcode.\nNew On taxonomy an' term planks ye can now use prev/next navigat'n as within th' normal plank structure.\nNew 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-WIDTH-S CSS property.\nNew Improvements fer accessibility when tabb'n through th' plank fer images, links an' tab handles.\nNew Th' editURL config parameter be now overwrit'ble '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.\nNew Th' themes config an' front matter opt'ns received a comprehensive documentat'n update. In addit'n th' theme switched from config.toml t' hugo.toml.\nNew 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.\nNew 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.\nChange yer previous sett'n from\nhugo. toml yaml json [params] author = 'Hugo' params: author: Cap'n Hugo { \"params\": { \"author\": \"Hugo\" } } t'\nhugo. 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.\nNew New Taxonomy an' term planks be now allowed t' contain rrrambl'n. This be added inbetween th' title an' th' plank list.\nNew It be now poss'ble t' print custom taxonomies anywhere 'n yer plank. See th' docs.\nNew It be now poss'ble t' adjust th' menu width fer yer whole ship. See th' docs.\nNew This release adds social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. See th' docs.\nNew This release comes wit' additional sort opt'ns 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).\nNew 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.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer th' xychart type.\nNew This release adds port'ble Marrrkdown links.\nPreviously 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.\nYe could work around this by us'n th' relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results 'n non-port'ble Marrrkdown.\nNow 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.\nTh' follow'n types o' link'n be supported:\nlink 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-.\nIf ye haven’t modified anyth'n, everyth'n be fine. Otherwise ye have t' check yer custom CSS rules an' JavaScript code.\nChange Ye can now have structural sections 'n th' hierarchical menu without generat'n a plank fer it.\nThis 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.\nThis 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.\nIn 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.\nNew New It be now poss'ble t' overwrite th' sett'n fer collapsibleMenu o' yer hugo.toml inside o' a page’s front matter.\nNew 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.\nNew It be now poss'ble t' remove th' root breadcrumb by sett'n disableRootBreadcrumb=true 'n yer hugo.toml.\nNew Th' output o' th' dedicated search plank now displays th' result’s breadcrumb.\nNew T'ble rows now change their background color on every even row.\nNew 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.\nNew 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.\nWit' 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.\nAdditionally, th' syntaxhighlight'n inside o' openapi fer print'n was switched t' a light scheme fer all theme variants.\nIf ye dislike this change, ye can revert this 'n yer theme variants CSS by add'n\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.\nNew New Th' theme variants Zen Light an' Zen Dark now add more contrast between menu, topbar an' rrrambl'n by add'n thin borders.\nThose 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.\nFor exist'n variants noth'n has changed visually.\nNew 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.\nNew 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.\nNew 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.\nNew Th' theme has added two new color variants zen-light an' zen-dark. Check it out!\nNew 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.\nNew 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).\nNew Translat'n into Hungarian. 5.18.0 (2023-07-27) Change Change Th' theme adds additional warnings fer deprecated or now unsupported features.\nChange 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.\nNew New Restored compatibility wit' Cap'n Hugo 0.95.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew 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.\nTh' copy-to-clipboard button fer code blocks will now only be displayed if th' reader hovers th' code block.\nIf 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.\nNew New Restored compatibility wit' Cap'n Hugo 0.114.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' new highlight shortcode replaces Hugo’s default implementat'n an' be fully compat'ble. So ye don’t need t' change anyth'n.\nIn addit'n it offers some extensions. Currently only th' wrap extension opt'n 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.\nDEPRECATION warnings mark features that still work but may be removed 'n th' future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange Th' 404 error plank was revamped. Hopefully ye will not see this very often.\nNew 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.\nTh' 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.\nAdditionally 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.\nNew Th' theme now optionally supports separate favicons fer light \u0026 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.\nTh' attachments shortcode has compatibility issues wit' newer Cap'n Hugo versions. Ye must switch t' leaf bundles or be locked t' Cap'n Hugo \u003c 0.112.0 fer now.\nIt 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 break'n change.\nChange Th' tabs shortcode has changed behavior if ye haven’t set th' groupid parameter.\nFormerly 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.\nNew 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.\nAdditionally fer such a use case, th' whitespace between a tab outline an' th' code be removed if only a single code block be contained.\nNew 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.\nHugo’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.\nNew T' give ye more flexibility 'n customiz'n yer article layout a new partial content-header.html be introduced.\nThis 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.\nSo how t' adjust th' posit'n o' tags start'n from th' theme’s default whar' tags be only shown above th' title?\nHide tags above title: Overwrite content-header.html wit' an empty file. Show tags between title an' rrrambl'n: Overwrite heading-post.html an' add {{ partial \"tags.html\" . }} t' it. 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.\nAdditionally, 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.\nTh' 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\n​ 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.\nNew 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.\nIn 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:\n​ layouts/partials/custom-header.html \u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Merrrmaid diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.\nTh' 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.\nChange Th' theme be now cap'ble t' visually adapt t' yer OS’s light/dark mode sett'n.\nThis be also th' new default sett'n if ye haven’t configured themeVariant 'n yer hugo.toml.\nAdditionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new themeVariantAuto parameter.\nThis be not supported fer Internet Explorer 11, which still displays 'n th' relearn-light variant.\nChange Th' JavaScript code fer handl'n image lightboxes (provided by Featherlight) was replaced by a CSS-only solut'n.\nThis 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.\nChange 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.\nNew New Translat'n into Czech. This language be not supported fer search.\nNew 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.\nAdditionally 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.\nIt 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.\nT' get rid o' this undesired behavior ye have two choices:\nMake 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 exampleSite’s content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.\n​ 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\" } Store th' plank file fer below a parent headless branch bundle an' add th' follow'n front matter t' he parent (see exampleSite’s 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.\n​ 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 exampleSite’s content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } Change Change Th' required directory name fer th' attachments shortcode was changed fer leaf bundles.\nPreviously, 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.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis 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.\nChange Absolute links prefixed wit' http:// or https:// be now opened 'n a separate browser tab.\nYe can revert back t' th' old behavior by defin'n externalLinkTarget=\"_self\" 'n th' params section o' yer hugo.toml.\nNew 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.\nNew Th' new ay'con shortcode simplyfies th' usage o' ay'cons. This can even be combined wit' also new badge shortcode.\nNew 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.\nNew 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.\nNew 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.\nT' 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.\nYe can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.\nNew Keyboard handl'n fer th' TOC an' search was improved.\nPress'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.\nTh' 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.\nNew 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.\nT' 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.\nNew Creat'n o' yer project gets a little bit faster wit' this release.\nThis 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.\nFor 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.\nIf 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.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 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.\nPlease 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://.\nChange 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.\nNew New Th' math shortcode an' mermaid shortcode now also support th' align parameter if Marrrkdown codefences be used.\nNew 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.\nNew 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 opt'n be now documented.\nNew 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.\nYe can revert this behavior by overwrit'n th' print output format sett'n 'n yer hugo.tomlt':\nhugo. 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.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e 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.\nYer 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:\nfer yer home plank, add th' front matter parameter archetype = \"home\" an' remove th' lead'n head'n\nfer all files contain'n th' deprecated front matter parameter chapter = true, replace it wit' archetype = \"chapter\" an' remove th' lead'n head'ns\nChange Th' front matter opt'ns pre / post were renamed t' menuPre / menuPost. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n after th' upgrade.\nNew New Add'n new partials heading-pre.html / heading-post.html an' accord'n front matter opt'ns headingPre / headingPost t' modify th' way yer page`s main head'n gets styled.\nNew 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.",
"description": "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.",
"tags": [],
"title": "Version 5",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.5.3 (2022-11-10) Fixes [bug] tags: fix non-latin tag display on planks #378 5.5.2 (2022-11-08) Fixes [bug] theme: fix typo 'n 404.html #376 [bug] theme: allow menu items an' children t' be served by file:// protocol #375 5.5.1 (2022-11-07) Fixes [bug] theme: fix overflow'n issue wit' anchors an' tooltips #364 5.5.0 (2022-11-06) Enhancements [feature][change] theme: opt'mize plank board fer images #304 Fixes [bug] theme: fix context 'n render hooks #373 [bug] print: make canonical URL absolute #371",
"description": "5.5.3 (2022-11-10) Fixes [bug] tags: fix non-latin tag display on planks #378",
"tags": [],
"title": "Version 5.5",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/5/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nFor 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.\nIf 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.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e",
"description": "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.",
"tags": [],
"title": "Version 5.5",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/5/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.4.1 (2021-10-07) Fixes [bug] theme: remove runtime styles from print #111 2.4.0 (2021-10-07) Enhancements [feature] lang: add vietnamese translat'n #109 [feature][change] theme: simplify stylesheet fer color variants #107 [feature] hidden planks: remove from RSS feed, JSON, taxonomy etc #102 [feature] theme: announce alternative rrrambl'n 'n header #101 [feature] menu: frontmatter opt'n t' change sort predicate #98 [feature] menu: frontmatter opt'n t' change sort predicate #98 [feature] menu: add default sett'n fer menu expansion #97 [feature] theme: improve print style #93 [feature] theme: improve style #92 Fixes [bug] include: don’t generate additional HTML if file should be displayed “as is” #110 [bug] attachments: fix broken links if multilang config be used #105 [bug] theme: fix sticky header t' remove horizontal scrollbar #82 Maintenance [task] chore: update fontawesome #94",
"description": "2.4.1 (2021-10-07) Fixes [bug] theme: remove runtime styles from print #111",
"tags": [],
"title": "Version 2.4",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "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.\nNew Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' alwaysopen opt'n 'n yer hugo.toml. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New front matter ordersectionsby opt'n t' change immediate children sort'n 'n menu an' children shortcode. Poss'ble values be title or weight.\nNew Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See Cap'n Hugo documentat'n.",
"description": "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.",
"tags": [],
"title": "Version 2.4",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translat'n #233 [feature] menu: expand/collapse menu items without navigat'n #231 [feature] print: add opt'n t' print whole chapter #230 [feature][break'n] theme: apply user supplied rrrambl'n footer below rrrambl'n #229 Fixes [bug] theme: scroll t' head'n on initial board #232",
"description": "3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translat'n #233 [feature] menu: expand/collapse menu items without navigat'n #231 [feature] print: add opt'n t' print whole chapter #230 [feature][break'n] theme: apply user supplied rrrambl'n footer below rrrambl'n #229 Fixes [bug] theme: scroll t' head'n on initial board #232",
"tags": [],
"title": "Version 3.4",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/3/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "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.\nNew Ye can activate print support 'n yer hugo.toml t' add th' capability t' print whole chapters or even th' complete ship.\nNew Translat'n into Traditional Chinese.",
"description": "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.",
"tags": [],
"title": "Version 3.4",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/3/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not board 'n documentat'n #285 [bug] children: descript'ns not work'n #284 [bug] print: fix empty plank fer shortcut links #283 4.2.4 (2022-06-23) Fixes [bug] theme: fix url fer logo an' home button #282 4.2.3 (2022-06-23) Fixes [bug][break'n] include: second parameter be ignored #281 4.2.2 (2022-06-23) No changelog fer this release. 4.2.1 (2022-06-23) No changelog fer this release. 4.2.0 (2022-06-23) Enhancements [feature][change] tabs: don’t change tab select'n if panel does not contain item #279 [feature] shorrrtcodes: convert t' partials #277 Fixes [bug] swagger: avoid builtin syntaxhighlight'n #280 [bug] search: fix console message fer miss'n lunr translat'ns #278 [bug] tabs: fix wrapp'n when hav'n many tabs #272 4.1.1 (2022-06-18) Fixes [bug] notice: fix layout when rrrambl'n starts wit' head'n #275 4.1.0 (2022-06-12) Enhancements [feature] i18n: support multilang rrrambl'n #271 4.0.5 (2022-06-12) Fixes [bug] i18n: Vietnamese language wit' wrong lang code #270 [bug] i18n: fix search fer non western languages #269 4.0.4 (2022-06-07) Enhancements [feature] theme: improve keyboard navigat'n fer scroll'n #268 Fixes [bug] swagger: adjust font-size fer method buttons #267 [bug] menu: hide expander when only hidden subpages #264 [bug] theme: make compat'ble wit' Cap'n Hugo 0.100.0 #263 Maintenance [task] swagger: update rapidoc t' 9.3.2 #266 [task] mermaid: update t' 9.1.1 #265 4.0.3 (2022-06-05) Enhancements [feature] toc: add scrollbar #262 4.0.2 (2022-06-05) Fixes [bug] theme: let browser scroll plank on CTRL+f #242 4.0.1 (2022-06-05) No changelog fer this release. 4.0.0 (2022-06-05) Enhancements [feature] shorrrtcodes: add named parameter if miss'n #260 [feature][break'n] theme: remove –MAIN-ANCHOR-color from stylesheet #256 [feature] i18n: add Italian translat'n #254 [feature] attachments: support fer brand colors #252 [feature] notice: support fer brand colors #251 [feature][break'n] config: remove custom_css #248 [feature] theme: use proper file extension fer page-meta.go #246 [feature] variant: add support fer brand color variables #239 [feature] i18n: add Polish translat'n #237 Fixes [bug] shorrrtcodes: accept boolean parameters if given as str'n #261 [bug] print: adjust button an' tab size #259 [bug] print: show Merrrmaid if requested 'n frontmatter #255 [bug] theme: adjust thin scrollbar slider #244 [bug] mobile: fix broken scrollbar #243 [bug] theme: fix display o' tooltip fer head'n anchor #241",
"description": "4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not board 'n documentat'n #285 [bug] children: descript'ns not work'n #284 [bug] print: fix empty plank fer shortcut links #283",
"tags": [],
"title": "Version 4",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "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.\nIf you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.\nChange 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.\nChange 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.\nNew 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.\nBreak'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.\nNew New All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.\nThis applies t' expand, include, notice an' siteparam.\nNew Th' button shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.\nNew 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.\nThese 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.\nNew Translat'n into Polish. This language be not supported fer search.\nNew Th' documentat'n fer all shorrrtcodes were revised.",
"description": "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.",
"tags": [],
"title": "Version 4",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.4.3 (2022-11-05) Enhancements [feature] history: refactor fer a11y #341 Fixes [bug] theme: fix multilang links when ship served from subdirectory #370 5.4.2 (2022-11-05) Maintenance [task] build: change set-output t' env vars #348 5.4.1 (2022-11-05) Fixes [bug] mermaid: fix Gantt chart width #365 5.4.0 (2022-11-01) Enhancements [feature] math: allow pass'n o' parameters wit' codefence rules #363 [feature] i18n: add Finnish translat'n #361 [feature] mermaid: allow pass'n o' parameters wit' codefence rules #360 [feature] i18n: support RTL #357 [feature][change] button: add opt'n fer target #351 [feature][change] theme: allow t' be served by file:// protocol #349",
"description": "5.4.3 (2022-11-05) Enhancements [feature] history: refactor fer a11y #341 Fixes [bug] theme: fix multilang links when ship served from subdirectory #370",
"tags": [],
"title": "Version 5.4",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nPlease 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://.\nChange 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.\nNew New Th' math shortcode an' mermaid shortcode now also support th' align parameter if Marrrkdown codefences be used.\nNew 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.\nNew Translat'n into Finnish (Suomi).",
"description": "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.",
"tags": [],
"title": "Version 5.4",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "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",
"description": "6.4.1 (2024-10-11) Fixes [bug] highlight: remove additional newlines from code if copied from cursor select'n #925",
"tags": [],
"title": "Version 6.4",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/6/4/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "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.\nNew Th' resources shortcode has a new parameter expanded t' make th' resource list collaps'ble.",
"description": "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.",
"tags": [],
"title": "Version 6.4",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/6/4/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translat'n #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translat'n t' avoid crash on render'n #90 2.3.0 (2021-09-13) Fixes [bug] theme: fix usage o' section element #88 Maintenance [task] theme: ensure IE11 compatibility #89 [task] docs: Arrr! showcase multilang featurrre #87",
"description": "2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translat'n #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translat'n t' avoid crash on render'n #90",
"tags": [],
"title": "Version 2.3",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "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.",
"description": "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.",
"tags": [],
"title": "Version 2.3",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translat'n #233 [feature] menu: expand/collapse menu items without navigat'n #231 [feature] print: add opt'n t' print whole chapter #230 [feature][break'n] theme: apply user supplied rrrambl'n footer below rrrambl'n #229 Fixes [bug] theme: scroll t' head'n on initial board #232 3.3.0 (2022-03-28) Enhancements [feature] theme: add CSS font variables #227 [feature] swagger: add support fer oas/swagger documentat'n #226 Fixes [bug] variant: make variant switch work on slow networks #228 3.2.1 (2022-03-25) Fixes [bug] print: fix minor inconsistencies #225 [bug] print: show more than just th' title plank #224 [bug] theme: align rrrambl'n scrollbar t' th' right on big screens #223 3.2.0 (2022-03-19) Enhancements [feature][change] mermaid: support differ'n themes fer color variant switch #219 [feature] mermaid: board javascript on demand #218 Maintenance [task] mermaid: update t' 8.14.0 #220 3.1.1 (2022-03-16) Enhancements [feature] i18n: add Korean translat'n #217 3.1.0 (2022-03-15) Enhancements [feature] notice: add ay'con parameter #212 [feature] mobile: remove breadcrumb ellipsis #211 Fixes [bug] theme: make storage o' multiple Cap'n Hugo sites on same server distinct #214 [bug] variant: switch breadcrumb color 'n Chrome #213 [bug] mobile: improve behavior o' sidebar menu #210 3.0.4 (2022-02-24) Enhancements [feature] theme: improve font load'n #201 [feature][change] variant: fix inconsistent color vari'ble nam'n #200 Fixes [bug] variant: fix occasional fail when resett'n generator #208 [bug] docs: don’t move header on logo hover 'n IE11 #207 [bug] variant: avoid flash o' menu header when non default variant be active #206 [bug] theme: fix wrong HTML clos'n tag order 'n chapters #205 [bug] theme: adjust breadcrumb an' title fer empty home plank titles #202 3.0.3 (2022-02-23) Enhancements [feature] tags: show tag count 'n taxonomy list #195 Fixes [bug] theme: remove Cap'n Hugo build warning if plank be not file based #197 [bug] tags: adhere t' titleSeparator #196 [bug] theme: hide footer divider an' variant selector 'n IE11 #194 3.0.2 (2022-02-23) Enhancements [feature] tags: sort by name #193 3.0.1 (2022-02-23) Enhancements [feature] children: set containerstyle automatically accord'n t' style #192 Fixes [bug] theme: revert fontawsome t' version 5 fer IE11 compat #191 3.0.0 (2022-02-22) Enhancements [feature] variant: build a variant generator #188 [feature] nav: only show toc if th' plank has head'ns #182 [feature][break'n] theme: change default colors t' Relearrrn defaults #181 [feature] variant: add a variant selector #178 [feature][break'n] menu: rework footer UX #177 [feature] theme: support fer dark mode #175 [feature] docs: use light rules highlight'n theme #174 [feature] notice: tweak dull colors #173 [feature] theme: rework header UX #151 Fixes [bug] search: remove additional X 'n filled out search box 'n IE11 #190 [bug] clipboard: localize tooltips #186 [bug] print: hide sidebar on Mac #183 [bug] menu: fix scrollbar height #180 [bug][change] search: fix color change fer ay'cons on hover #176",
"description": "3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translat'n #233 [feature] menu: expand/collapse menu items without navigat'n #231 [feature] print: add opt'n t' print whole chapter #230 [feature][break'n] theme: apply user supplied rrrambl'n footer below rrrambl'n #229 Fixes [bug] theme: scroll t' head'n on initial board #232",
"tags": [],
"title": "Version 3",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "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.\nNew Ye can activate print support 'n yer hugo.toml t' add th' capability t' print whole chapters or even th' complete ship.\nNew 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' exampleSite fer all avail'ble variables.\nNew 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 opt'n as follows: If a Merrrmaid shortcode or Marrrkdown codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.\nTh' opt'n 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' exampleSite fer an example.\nNew 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' exampleSite.\nThis 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).\nBreak'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.\nThis 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.\nAvast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange 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.\nChange 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.\nNew New Wit' this release ye be now cap'ble t' define yer own dark mode variants.\nT' 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.\nT' see what’s now poss'ble, see th' new variants relearn-dark an' neon that be com'n wit' this release.\nNew 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.\nNew 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.\nAvast, 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.",
"description": "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.",
"tags": [],
"title": "Version 3",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.3.0 (2022-03-28) Enhancements [feature] theme: add CSS font variables #227 [feature] swagger: add support fer oas/swagger documentat'n #226 Fixes [bug] variant: make variant switch work on slow networks #228",
"description": "3.3.0 (2022-03-28) Enhancements [feature] theme: add CSS font variables #227 [feature] swagger: add support fer oas/swagger documentat'n #226 Fixes [bug] variant: make variant switch work on slow networks #228",
"tags": [],
"title": "Version 3.3",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/3/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "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' exampleSite fer all avail'ble variables.\nNew 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.",
"description": "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' exampleSite fer all avail'ble variables.",
"tags": [],
"title": "Version 3.3",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/3/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.3.3 (2022-10-09) Fixes [bug] archetypes: fix frontmatter on home.md template #346 5.3.2 (2022-10-08) Fixes [bug] nav: change defunct keyboard shortcuts #344 5.3.1 (2022-10-08) Enhancements [feature] i18n: update Spanish translat'n #343 [feature] theme: opt'n t' align images #327 5.3.0 (2022-10-07) Enhancements [feature] expander: improve whitespace between label an' rrrambl'n #338 [feature] swagger: improve print version #333 Fixes [bug] print: fix links o' subsections #340 [bug] theme: remove W3C validator errors #337 [bug] children: remove unused plank parameter from docs #336 [bug] print: remove menu placeholder 'n Firefox #335 [bug] swagger: fix download button overflow #334 [bug][change] a11y: remove WCAG errors whar' applic'ble #307",
"description": "5.3.3 (2022-10-09) Fixes [bug] archetypes: fix frontmatter on home.md template #346",
"tags": [],
"title": "Version 5.3",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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 opt'n be now documented.\nNew 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.",
"description": "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 opt'n be now documented.",
"tags": [],
"title": "Version 5.3",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "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",
"description": "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",
"tags": [],
"title": "Version 6.3",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/6/3/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "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.\nChange 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.\nNew New Th' notice shortcode has a new parameter expanded t' make th' rrrambl'n collaps'ble.\nNew If ye be runn'n Hugo 0.134.0 or later, th' theme now supports Obsidian callouts.\nNew Th' theme has updated its Merrrmaid dependency t' 11.1.0. This adds support fer packet an' architecture diagrams.",
"description": "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.",
"tags": [],
"title": "Version 6.3",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/6/3/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 1",
"content": "1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes an' attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add opt'n t' open on plank board #25 [feature] expand: rework styl'n #24 [feature] attachments: sort output #23 [feature] notice: make restyl'n o' notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors t' common standards #18 [feature] notice: use distinct ay'cons fer notice box type #17 Fixes [bug] attachments: support i18n fer attachment size #21 [bug] notice: support i18n fer box labels #16 [bug] notice: support multiple blocks 'n one box #15 Maintenance [task] dependency: upgrade jquery t' 3.6.0 #30",
"description": "1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes an' attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add opt'n t' open on plank board #25 [feature] expand: rework styl'n #24 [feature] attachments: sort output #23 [feature] notice: make restyl'n o' notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors t' common standards #18 [feature] notice: use distinct ay'cons fer notice box type #17 Fixes [bug] attachments: support i18n fer attachment size #21 [bug] notice: support i18n fer box labels #16 [bug] notice: support multiple blocks 'n one box #15 Maintenance [task] dependency: upgrade jquery t' 3.6.0 #30",
"tags": [],
"title": "Version 1.2",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/1/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 1",
"content": "1.2.0 (2021-07-26) New New Shortcode expand wit' new parameter t' open on plank board.",
"description": "1.2.0 (2021-07-26) New New Shortcode expand wit' new parameter t' open on plank board.",
"tags": [],
"title": "Version 1.2",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/1/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigat'n respect ordersectionsby configurat'n #170 2.9.4 (2022-02-06) Fixes [bug] exampleSite: fix links 'n official documentat'n #168 2.9.3 (2022-02-06) Fixes [bug] menu: invalid URL when th' shortcut be an internal link #163 2.9.2 (2021-11-26) Enhancements [feature] theme: add theme version info t' head #158 Fixes [bug] theme: fix select'n o' *.ico files as favicons #160 2.9.1 (2021-11-22) Fixes [bug] menu: fix significantly low performance fer collect'n o' meta info #157 2.9.0 (2021-11-19) Fixes [bug][break'n] relref: fix inconsistent behavior #156 [bug] search: make dropdown stick t' search field when scroll'n #155 [bug] menu: align long text properly #154 [bug] copyToClipBoard: add miss'n right border fer inline code if disableInlineCopyToClipBoard=true #153 [bug] menu: show hidden sibl'n planks reliably #152 [bug] menu: br'n active item 'n sight fer large menus #149 2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset t' initial size #145 [bug] mermaid: remove whitespace from big graphs #143 2.8.2 (2021-11-08) Fixes [bug] mermaid: always board javascript t' avoid break if code fences be used #142 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS 'n multilang setup if search be disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally avail'ble via config.toml #133 [feature] mermaid: only board javascript if necessary #95 [feature][change] theme: switch font #83 [feature] theme: make favicon configur'ble #2 Fixes [bug] mermaid: assert that window.mermaid be actually mermaid #136 [bug] menu: remove usage o' Hugo’s UniqueID #131 [bug] theme: reduce margin fer children shortcode #130 [bug] theme: left-align h3 'n chapters #129 [bug] theme: align copy link t' clipboard #128 2.7.0 (2021-10-24) Enhancements [feature] notice: support custom titles #124 2.6.0 (2021-10-21) Fixes [bug] theme: generate correct links if theme served from subdirectory #120 2.5.1 (2021-10-12) Fixes [bug] security: fix XSS fer malicious image URLs #117 2.5.0 (2021-10-08) Enhancements [feature][change] rules highlight: provide default colors fer unknown languages #113 Fixes [bug] security: fix XSS fer malicious URLs #114 [bug] menu: write correct local shortcut links #112 2.4.1 (2021-10-07) Fixes [bug] theme: remove runtime styles from print #111 2.4.0 (2021-10-07) Enhancements [feature] lang: add vietnamese translat'n #109 [feature][change] theme: simplify stylesheet fer color variants #107 [feature] hidden planks: remove from RSS feed, JSON, taxonomy etc #102 [feature] theme: announce alternative rrrambl'n 'n header #101 [feature] menu: frontmatter opt'n t' change sort predicate #98 [feature] menu: frontmatter opt'n t' change sort predicate #98 [feature] menu: add default sett'n fer menu expansion #97 [feature] theme: improve print style #93 [feature] theme: improve style #92 Fixes [bug] include: don’t generate additional HTML if file should be displayed “as is” #110 [bug] attachments: fix broken links if multilang config be used #105 [bug] theme: fix sticky header t' remove horizontal scrollbar #82 Maintenance [task] chore: update fontawesome #94 2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translat'n #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translat'n t' avoid crash on render'n #90 2.3.0 (2021-09-13) Fixes [bug] theme: fix usage o' section element #88 Maintenance [task] theme: ensure IE11 compatibility #89 [task] docs: Arrr! showcase multilang featurrre #87 2.2.0 (2021-09-09) Enhancements [feature] sitemap: hide hidden planks from sitemap an' SEO index'n #85 Fixes [bug] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary t' schema #84 2.1.0 (2021-09-07) Enhancements [feature] search: open expand if it contains search term #80 [feature] menu: scroll active item into view #79 [feature] search: dis'ble search 'n hidden planks #76 [feature] search: improve readability o' index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site rrrambl'n #81 [bug] menu: always hide hidden sub planks #77 2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styl'n #65 [feature] theme: improve readability #64 [feature] menu: show hidden planks if accessed directly #60 [feature][change] theme: treat planks without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates fer pre/post menu entries #56 [feature] theme: make chapter archetype more read'ble #55 [feature] children: add parameter fer container style #53 [feature] theme: make rrrambl'n a template #50 [feature] menu: control menu expansion wit' alwaysopen parameter #49 [feature] include: new shortcode t' include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highlighter: switch t' standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sort'n ignores ordersectionsby #63 [bug][change] children: default sort'n ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden planks #61 [bug] theme: remove superfluous singular taxonomy from taxonomy title #46 [bug][change] theme: miss'n –MENU-HOME-LINK-HOVER-color 'n documentat'n #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog 'n exampleSite #33",
"description": "2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigat'n respect ordersectionsby configurat'n #170",
"tags": [],
"title": "Version 2",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "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.\nIn 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:\nType 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.\nAlso, 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.\nIn 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.\nYe may see errors on th' console after th' update 'n th' form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"configuration/reference/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": plank not found In this case, ye must apply one o' two opt'ns:\nStart 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.\nCopy 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.\nNew Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' disableToc opt'n '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.\nNew Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' alwaysopen opt'n 'n yer hugo.toml. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New front matter ordersectionsby opt'n t' change immediate children sort'n 'n menu an' children shortcode. Poss'ble values be title or weight.\nNew 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 planks - see CHANGELOG.md 'n th' exampleSite), 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.\nNew If a search term be found 'n an expand shortcode, th' expand will be opened.\nNew 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\nChange 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.\nChange --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.\nChange 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.\nChange If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.\nChange A plank without a title will be treated as hidden=true.\nNew 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.\nNew New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See documentat'n fer further read'n.\nNew Shortcode children wit' new parameter containerstyle.\nNew New shortcode include t' include arbitrary file rrrambl'n into a plank.",
"description": "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.",
"tags": [],
"title": "Version 2",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.2.0 (2021-09-09) Enhancements [feature] sitemap: hide hidden planks from sitemap an' SEO index'n #85 Fixes [bug] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary t' schema #84",
"description": "2.2.0 (2021-09-09) Enhancements [feature] sitemap: hide hidden planks from sitemap an' SEO index'n #85 Fixes [bug] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary t' schema #84",
"tags": [],
"title": "Version 2.2",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "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.",
"description": "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.",
"tags": [],
"title": "Version 2.2",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.2.1 (2022-03-25) Fixes [bug] print: fix minor inconsistencies #225 [bug] print: show more than just th' title plank #224 [bug] theme: align rrrambl'n scrollbar t' th' right on big screens #223 3.2.0 (2022-03-19) Enhancements [feature][change] mermaid: support differ'n themes fer color variant switch #219 [feature] mermaid: board javascript on demand #218 Maintenance [task] mermaid: update t' 8.14.0 #220",
"description": "3.2.1 (2022-03-25) Fixes [bug] print: fix minor inconsistencies #225 [bug] print: show more than just th' title plank #224 [bug] theme: align rrrambl'n scrollbar t' th' right on big screens #223",
"tags": [],
"title": "Version 3.2",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/3/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "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 opt'n as follows: If a Merrrmaid shortcode or Marrrkdown codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.\nTh' opt'n 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' exampleSite fer an example.\nNew 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.",
"description": "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 opt'n as follows: If a Merrrmaid shortcode or Marrrkdown codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.",
"tags": [],
"title": "Version 3.2",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/3/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 4",
"content": "4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not board 'n documentat'n #285 [bug] children: descript'ns not work'n #284 [bug] print: fix empty plank fer shortcut links #283 4.2.4 (2022-06-23) Fixes [bug] theme: fix url fer logo an' home button #282 4.2.3 (2022-06-23) Fixes [bug][break'n] include: second parameter be ignored #281 4.2.2 (2022-06-23) No changelog fer this release. 4.2.1 (2022-06-23) No changelog fer this release. 4.2.0 (2022-06-23) Enhancements [feature][change] tabs: don’t change tab select'n if panel does not contain item #279 [feature] shorrrtcodes: convert t' partials #277 Fixes [bug] swagger: avoid builtin syntaxhighlight'n #280 [bug] search: fix console message fer miss'n lunr translat'ns #278 [bug] tabs: fix wrapp'n when hav'n many tabs #272",
"description": "4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not board 'n documentat'n #285 [bug] children: descript'ns not work'n #284 [bug] print: fix empty plank fer shortcut links #283",
"tags": [],
"title": "Version 4.2",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/4/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 4",
"content": "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.\nIf you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.\nChange 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.\nChange 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.\nNew New All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.",
"description": "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.",
"tags": [],
"title": "Version 4.2",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/4/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter planks overwrite font-size #328 5.2.2 (2022-08-23) Fixes [bug] print: fix urls fer uglyURLs=true #322 5.2.1 (2022-08-05) Enhancements [feature] i18n: improve Japanese translat'n #318 Fixes [bug] nav: prev/next ignores ordersectionby #320 Maintenance [task] task: bump Cap'n Hugo minimum requirement t' 0.95 #319 5.2.0 (2022-08-03) Enhancements [feature][change] menu: expand collapsed menus if search term be found 'n submenus #312 Fixes [bug] print: switch mermaid an' swagger style before print #316 [bug] theme: fix chapter margins on big screens #315",
"description": "5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter planks overwrite font-size #328",
"tags": [],
"title": "Version 5.2",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.",
"description": "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.",
"tags": [],
"title": "Version 5.2",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "6.2.0 (2024-08-26) Enhancements [feature][change] anchor: add opt'n 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",
"description": "6.2.0 (2024-08-26) Enhancements [feature][change] anchor: add opt'n 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",
"tags": [],
"title": "Version 6.2",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/6/2/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "6.2.0 (2024-08-26) Change Change Th' head'n anchor links be extended 'n functionality.\nIf 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.\nIf ye dislike th' new behavior, ye can deactivate it by sett'n disableAnchorScrolling=true 'n yer hugo.toml. See th' docs fer further opt'ns.\nNew New If ye be runn'n Hugo 0.132.0 or later, th' theme be now cap'ble t' print GitHub alerts.\nNew T' support new severity levels fer GitHub alerts, all shorrrtcodes that support severity levels wit' their style parameter were expanded wit' th' new severities caut'n 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.\nNew 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.",
"description": "6.2.0 (2024-08-26) Change Change Th' head'n anchor links be extended 'n functionality.",
"tags": [],
"title": "Version 6.2",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/6/2/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog",
"content": "1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes an' attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add opt'n t' open on plank board #25 [feature] expand: rework styl'n #24 [feature] attachments: sort output #23 [feature] notice: make restyl'n o' notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors t' common standards #18 [feature] notice: use distinct ay'cons fer notice box type #17 Fixes [bug] attachments: support i18n fer attachment size #21 [bug] notice: support i18n fer box labels #16 [bug] notice: support multiple blocks 'n one box #15 Maintenance [task] dependency: upgrade jquery t' 3.6.0 #30 1.1.1 (2021-07-04) Maintenance [task] theme: prepare fer new hugo theme registrat'n #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose opt'ns 'n config.toml #4 Fixes [bug] mermaid: config opt'n fer CDN url not used #12 [bug] mermaid: only highlight text 'n HTML elements #10 [bug] mermaid: support pan \u0026 zoom fer graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on board may bomb chart #5 Maintenance [task] mermaid: update t' 8.10.2 #7 1.0.1 (2021-07-01) Maintenance [task] Prepare fer hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1",
"description": "1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes an' attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add opt'n t' open on plank board #25 [feature] expand: rework styl'n #24 [feature] attachments: sort output #23 [feature] notice: make restyl'n o' notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors t' common standards #18 [feature] notice: use distinct ay'cons fer notice box type #17 Fixes [bug] attachments: support i18n fer attachment size #21 [bug] notice: support i18n fer box labels #16 [bug] notice: support multiple blocks 'n one box #15 Maintenance [task] dependency: upgrade jquery t' 3.6.0 #30",
"tags": [],
"title": "Version 1",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New",
"content": "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 opt'ns 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.",
"description": "1.2.0 (2021-07-26) New New Shortcode expand wit' new parameter t' open on plank board.",
"tags": [],
"title": "Version 1",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 1",
"content": "1.1.1 (2021-07-04) Maintenance [task] theme: prepare fer new hugo theme registrat'n #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose opt'ns 'n config.toml #4 Fixes [bug] mermaid: config opt'n fer CDN url not used #12 [bug] mermaid: only highlight text 'n HTML elements #10 [bug] mermaid: support pan \u0026 zoom fer graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on board may bomb chart #5 Maintenance [task] mermaid: update t' 8.10.2 #7",
"description": "1.1.1 (2021-07-04) Maintenance [task] theme: prepare fer new hugo theme registrat'n #13",
"tags": [],
"title": "Version 1.1",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/1/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 1",
"content": "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 opt'ns can be set 'n hugo.toml.",
"description": "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 opt'ns can be set 'n hugo.toml.",
"tags": [],
"title": "Version 1.1",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/1/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.1.0 (2021-09-07) Enhancements [feature] search: open expand if it contains search term #80 [feature] menu: scroll active item into view #79 [feature] search: dis'ble search 'n hidden planks #76 [feature] search: improve readability o' index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site rrrambl'n #81 [bug] menu: always hide hidden sub planks #77",
"description": "2.1.0 (2021-09-07) Enhancements [feature] search: open expand if it contains search term #80 [feature] menu: scroll active item into view #79 [feature] search: dis'ble search 'n hidden planks #76 [feature] search: improve readability o' index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site rrrambl'n #81 [bug] menu: always hide hidden sub planks #77",
"tags": [],
"title": "Version 2.1",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "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 planks - see CHANGELOG.md 'n th' exampleSite), 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.\nNew If a search term be found 'n an expand shortcode, th' expand will be opened.\nNew Th' menu will scroll th' active item into view on board.",
"description": "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 planks - see CHANGELOG.md 'n th' exampleSite), 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.",
"tags": [],
"title": "Version 2.1",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.1.1 (2022-03-16) Enhancements [feature] i18n: add Korean translat'n #217 3.1.0 (2022-03-15) Enhancements [feature] notice: add ay'con parameter #212 [feature] mobile: remove breadcrumb ellipsis #211 Fixes [bug] theme: make storage o' multiple Cap'n Hugo sites on same server distinct #214 [bug] variant: switch breadcrumb color 'n Chrome #213 [bug] mobile: improve behavior o' sidebar menu #210",
"description": "3.1.1 (2022-03-16) Enhancements [feature] i18n: add Korean translat'n #217 3.1.0 (2022-03-15) Enhancements [feature] notice: add ay'con parameter #212 [feature] mobile: remove breadcrumb ellipsis #211 Fixes [bug] theme: make storage o' multiple Cap'n Hugo sites on same server distinct #214 [bug] variant: switch breadcrumb color 'n Chrome #213 [bug] mobile: improve behavior o' sidebar menu #210",
"tags": [],
"title": "Version 3.1",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/3/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "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.",
"description": "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.",
"tags": [],
"title": "Version 3.1",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/3/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 4",
"content": "4.1.1 (2022-06-18) Fixes [bug] notice: fix layout when rrrambl'n starts wit' head'n #275 4.1.0 (2022-06-12) Enhancements [feature] i18n: support multilang rrrambl'n #271",
"description": "4.1.1 (2022-06-18) Fixes [bug] notice: fix layout when rrrambl'n starts wit' head'n #275",
"tags": [],
"title": "Version 4.1",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/4/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 4",
"content": "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.",
"description": "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.",
"tags": [],
"title": "Version 4.1",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/4/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme t' light #313 [bug] mermaid: header be show'n up 'n FF #311 5.1.1 (2022-07-15) Fixes [bug] tags: don’t count tags if plank be hidden #310 5.1.0 (2022-07-15) Enhancements [feature][change] print: make print url deterministic #309 [feature] theme: allow overrid'n partials fer output formats #308",
"description": "5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme t' light #313 [bug] mermaid: header be show'n up 'n FF #311",
"tags": [],
"title": "Version 5.1",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\nYe can revert this behavior by overwrit'n th' print output format sett'n 'n yer hugo.tomlt':\nhugo. 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 } } }",
"description": "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.",
"tags": [],
"title": "Version 5.1",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "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",
"description": "6.1.1 (2024-08-02) Fixes [bug] link: link resolv'n stopped work'n 'n certain configurat'ns #882",
"tags": [],
"title": "Version 6.1",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/6/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "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).\nChange 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.\nNew 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 can not be resolved.\nNew Shorrrtcodes support'n an errorlevel configurat'n can now have overridden values 'n th' front matter section o' each individual plank.\nNew Th' theme now comes wit' its own overridden version o' th' relref shortcode.\nWhile 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.\nTh' shortcode be deactivated by default an' can be activated by sett'n\nhugo. 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.",
"description": "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).",
"tags": [],
"title": "Version 6.1",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/6/1/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 7",
"content": "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",
"description": "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",
"tags": [],
"title": "Version 7.1",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/7/1/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 7",
"content": "7.1.0 (2024-10-24) Change Change Th' sidebar menus be now completely configur'ble.\nThis be provided by th' new parameter sidebarmenus. Wit' th' new system, ye can\nshow 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.\nChange Th' children shortcode was changed t' output a page’s LinkTitle instead o' previously us'n th' Title.\nAs 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.\nTh' 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.\nNew 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.",
"description": "7.1.0 (2024-10-24) Change Change Th' sidebar menus be now completely configur'ble.",
"tags": [],
"title": "Version 7.1",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/7/1/index.html"
},
{
"breadcrumb": "Rambl'n",
"content": "In Cap'n Hugo, planks be th' core o' yer ship.\nTh' theme generates th' navigat'n menu out o' th' given directory structure.\nOrg'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rrrambl'n directory wit' all yer planks.\nrrrambl'n ├── first-chapter │ ├── first-page | | |── _index.md | │ ├── first-sub-page | | | |── _index.md | | | |── picture1.png | | | └── plain.txt │ ├── second-page | | |── index.md | | |── picture1.png | | └── picture2.png │ └── third-page.md └── _index.md Avast While ye can also go different, _index.md (with an underscore) be recommended fer each directory, it’s yer directory’s home plank.\nSee Hugo’s guide fer rrrambl'n t' learn more.",
"description": "Your content's directory structure",
"tags": [],
"title": "Directory Structure",
"uri": "/hugo-theme-relearn/pir/authoring/structure/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Site Management",
"content": "If you’ve followed th' Gett'n Started guide, yer directory layout will look similar t' this:\n├── rrrambl'n │ ├── first-chapter │ │ ├── first-page | | | └── _index.md │ │ ├── second-page | | | └── index.md │ │ └── third-page.md │ └── _index.md ├── themes │ └── hugo-theme-relearn │ └── ... └── hugo.toml Cap'n Hugo uses a union file system, which lets ye combine multiple directories.\nBy default, it puts yer root directory on top o' th' Relearrrn theme directory. Files 'n yer root directory will replace theme files 'n th' same locat'n.\nFor example, if ye create a file at layouts/partials/head'n.html, it will override th' theme’s themes/hugo-theme-relearn/layouts/partials/head'n.html.\nSee this list, t' learn which files be allowed t' be modified by ye.\nThis makes it easy t' cust'mize th' theme without chang'n files 'n th' themes directory, mak'n future theme updates simpler.\nArrr Don’t edit files inside th' themes/hugo-theme-relearn directory. That’s not th' recommended way t' cust'mize! Refer t' th' explanat'n above.\nDon’t clone th' theme repository an' edit files there fer yer ship. That’s not th' recommended way t' cust'mize! Instead, follow th' Gett'n Started guide.",
"description": "Your site's directory structure",
"tags": [],
"title": "Directory Structure",
"uri": "/hugo-theme-relearn/pir/configuration/sitemanagement/structure/index.html"
},
{
"breadcrumb": "Introduction",
"content": "Here’s how t' start yer new website. If you’re new t' Cap'n Hugo, we recommend learn'n more about it 'n its excellent starter’s guide.\nInstall Cap'n Hugo Download an' install Cap'n Hugo 0.126.0 or newer fer yer operat'n system follow'n th' instruct'ns.\nTh' standard edit'n o' Cap'n Hugo be sufficient but ye can also use th' extended edit'n.\nCreate yer Project Use Hugo’s new ship command t' make a new website\nhugo new ship my-new-site Then move into th' new directory\ncd my-new-site Run all future commands from this directory.\nInstall th' Theme Download as a Zip File Ye can download th' theme as a .zip file an' unzip it into th' themes/hugo-theme-relearn directory.\nThen add this at th' top o' yer hugo.toml\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Use Hugo’s Module System Install th' Relearrrn theme us'n Hugo’s module system\nhugo mod init example.com Then add this at th' end o' yer hugo.toml\nhugo. toml yaml json [module] [[module.imports]] path = 'github.com/McShelby/hugo-theme-relearn' module: imports: - path: github.com/McShelby/hugo-theme-relearn { \"module\": { \"imports\": [ { \"path\": \"github.com/McShelby/hugo-theme-relearn\" } ] } } Use as a Git Submodule If you’re us'n Git fer yer project, ye can create a repository now\ngit init Add th' theme as a Git submodule\ngit submodule add --depth 1 https://github.com/McShelby/hugo-theme-relearn.git themes/hugo-theme-relearn Then add this at th' top o' yer hugo.toml\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Create yer Home Plank Start by mak'n a home plank\nhugo new --kind home _index.md Th' new home plank file content/_index.md has two parts: th' plank info (like title) at th' top, called front matter, an' th' plank rrrambl'n below.\nCreate yer First Chapter Plank Chapters be top-level planks that contain other planks. They have a special layout.\nMake yer first chapter plank\nhugo new --kind chapter first-chapter/_index.md Th' new file content/first-chapter/_index.md has a weight number 'n th' front matter. This sets th' chapter’s subtitle an' its order 'n th' menu.\nCreate yer First Rrrambl'n Planks Now make rrrambl'n planks inside th' chapter. Here be three ways t' do this\nhugo new first-chapter/first-page/_index.md hugo new first-chapter/second-page/index.md hugo new first-chapter/third-page.md Cap'n Hugo treats these files differently based on their file names. Learrrn more 'n Hugo’s guide.\nFeel free t' edit these files. Change th' title, add a weight if ye want, an' write yer rrrambl'n.\nTest yer Website Locally Start yer new website on yer computer wit' this command\nhugo serve Open http://localhost:1313 'n yer web browser.\nYe can keep th' server runn'n while ye edit. Th' browser will update automatically when ye save changes.\nIt’s a kind o' magic\nBuild an' Deploy yer Website When yer ship be ready t' go live, run this command\nhugo This creates a public directory wit' all yer website files.\nYe can upload this directory t' any web server, or use one o' Hugo’s many other ways t' publish.\nNext Steps Yer ship be now fully functional.\nYe can continue configur'n yer ship t' yer needs.\nOr just start author'n rrrambl'n an' discover what’s poss'ble.",
"description": "Initialize your website in a few simple steps",
"tags": [],
"title": "Gettin' started",
"uri": "/hugo-theme-relearn/pir/introduction/quickstart/index.html"
},
{
"breadcrumb": "",
"content": "Discover what this Cap'n Hugo theme be all about.\nGett'n StartedInitialize yer website 'n a few simple steps\nTool Integrat'nAll about supported 3rd party tools\nWhat's NewWhat's new 'n this version\nChangelogTh' detailed changelog",
"description": "Discover what this Cap'n Hugo theme be all about.\nGett'n StartedInitialize yer website 'n a few simple steps",
"tags": [],
"title": "Introduction",
"uri": "/hugo-theme-relearn/pir/introduction/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Brrrand'n",
"content": "Change th' Favicon If yer favicon be an SVG, PNG, or ICO, just drop yer image 'n yer site’s static/images/ directory an' name it favicon.svg, favicon.png, or favicon.ico respectively.\nIf ye want t' adjust yer favicon accord'n t' yer OS sett'ns fer light/dark mode, add th' image files static/images/favicon-light.svg an' static/images/favicon-dark.svg t' yer site’s directory, respectively, correspond'n t' yer file format. In case some o' th' files be miss'n, th' theme falls back t' favicon.svg fer each miss'n file. All supplied favicons must be o' th' same file format.\nIf no favicon file be found, th' theme will look up th' alternative filename logo 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.\nIf ye need t' change this default behavior, create a new file layouts/partials/favicon.html 'n yer site’s directory an' write someth'n like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change th' Logo By default, only yer ship title will be shown at th' top o' th' menu. Ye can configure this, or override th' logo partial.\nCreate a new file 'n layouts/partials/logo.html o' yer ship. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image, or ye could paste an SVG definit'n!\nTh' size o' th' logo will adapt automatically.",
"description": "Provide your own logo and favicon",
"tags": [],
"title": "Logo",
"uri": "/hugo-theme-relearn/pir/configuration/branding/logo/index.html"
},
{
"breadcrumb": "Rambl'n \u003e Front Matter",
"content": "A plank be displayed by exactly one plank design an' represented by Hugo’s reserved type front matter.\nTh' Relearrrn theme offers th' plank designs home, chapter, an' default but ye can define further custom plank designs.\nRegardless o' shipped or custom plank design, ye be us'n them 'n th' same way.\nIf ye have an archetype file, ye can just do\nhugo new --kind chapter chapter1/_index.md If ye be creat'n yer Marrrkdown files manually, ye can achieve th' same by just sett'n type='chapter' 'n th' front matter.\nYer result'n Marrrkdown file needs t' have at least th' type front matter set t' th' value o' th' plank design\n​ _index.md +++ title = \"Chapter 1\" type = \"chapter\" +++ Predefined Designs Home A Home plank be th' start'n plank o' yer project. It’s best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.md Chapter A Chapter displays a plank meant t' be used as introduct'n fer a set o' child planks.\nCommonly, it contains a title front matter an' a short descript'n 'n th' rrrambl'n.\nT' create a chapter plank, run th' follow'n command\nhugo new --kind chapter chapter1/_index.md If a numerical weight front matter be set, it will be used t' generate th' subtitle o' th' chapter plank. Set th' number t' a consecutive value start'n at 1 fer each new chapter on th' same directory level.\nDefault A Default plank be any other rrrambl'n plank.\nT' create a default plank, run either one o' th' follow'n commands\nhugo new chapter1/page1/_index.md or\nhugo new chapter1/page1.md",
"description": "How to vary layouts by using page designs",
"tags": [],
"title": "Page Designs",
"uri": "/hugo-theme-relearn/pir/authoring/frontmatter/designs/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Customization",
"content": "Us'ble Partials Ye can call other partials from themes/hugo-relearn-themes/ besides those 'n themes/hugo-relearn-themes/layouts/partials/_relearn. However, us'n partials not mentioned as customiz'ble below might make future updates more challeng'n.\nCustomiz'ble Partials Th' Relearrrn theme allows ye t' cust'mize various parts o' th' theme by overrid'n partials. This makes th' theme highly configur'ble.\nA bloody rule t' follow: Th' less code a partial contains, th' easier it will be t' update th' theme 'n th' future.\nHere’s a list o' partials ye can safely override:\nlayouts/partials/content.html: Th' main rrrambl'n o' a plank. Override this t' display additonal plank metadata.\nlayouts/partials/content-header.html: Th' header above th' title. By default, it shows tags, but ye can change this.\nlayouts/partials/content-footer.html: Th' footer below th' rrrambl'n. By default, it shows author info, modificat'n dates, an' categories. Ye can cust'mize this.\nlayouts/partials/custom-header.html: For add'n custom CSS. Remember t' include th' style HTML tag.\nlayouts/partials/custom-footer.html: For add'n custom JavaScript. Remember t' include th' script HTML tag.\nlayouts/partials/favicon.html: Th' favicon. Ye should definitely cust'mize this.\nlayouts/partials/head'n.html: th' page’s title head'ns\nlayouts/partials/heading-pre.html: Add rrrambl'n before th' page’s title head'ns. Remember t' consider th' headingPre front matter.\nlayouts/partials/heading-post.html: Add rrrambl'n after th' page’s title head'ns. Remember t' consider th' headingPost front matter.\nlayouts/partials/logo.html: Th' logo 'n th' top left corner. Ye should cust'mize this.\nlayouts/partials/menu-pre.html: Add rrrambl'n before menu items. Remember t' consider th' menuPre front matter.\nlayouts/partials/menu-post.html: Add rrrambl'n after menu items. Remember t' consider th' menuPost front matter.\nlayouts/partials/menu-footer.html: Th' footer o' th' left menu.\nYe can override other partials from themes/hugo-relearn-themes/, but be careful as this might make future updates more difficult.",
"description": "Modifying partials to your needs",
"tags": [],
"title": "Partials",
"uri": "/hugo-theme-relearn/pir/configuration/customization/partials/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children",
"content": "This be a plain demo child plank X.",
"description": "This be a plain plank test, an' th' beginn'n o' a YAML multiline description…",
"tags": [
"Children"
],
"title": "plank X",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/test/index.html"
},
{
"breadcrumb": "Configurrrat'n",
"content": "Directory StructureYer site's directory structure\nMultilingualHow t' set up a multilingual ship\nMeta Informat'nWhat site-wide meta informat'n can be set\nDeployment ScenariosOpt'ns fer specific deployment needs\nAvail'ble Output FormatsWhat other formats can a plank be displayed 'n\nSt'ble OutputHow t' make yer generated HTML output st'ble",
"description": "Get yourself familiar with the general structure of your website",
"tags": [],
"title": "Site Management",
"uri": "/hugo-theme-relearn/pir/configuration/sitemanagement/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Content",
"content": "Th' theme adjusts th' rrrambl'n width when ye resize yer browser.\nIf ye want t' change th' chosen default width, ye can add CSS variables t' layouts/partials/custom-header.html.\nChang'n th' Main Area’s Maximum Width Th' main area has a default maximum width o' 80.25rem fer better readability. If ye want t' change this, ye can set a CSS vari'ble\nFor full width, use a large value like 1000rem.\n​ layouts/partials/custom-header.html \u003cstyle\u003e :root { --MAIN-WIDTH-MAX: 1000rem; } \u003c/style\u003e",
"description": "Changing the content area width",
"tags": [],
"title": "Width",
"uri": "/hugo-theme-relearn/pir/configuration/content/width/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Sidebar",
"content": "Th' theme adjusts th' menu width based on browser size.\nIf ye want t' change th' chosen default width, ye can add CSS variables t' layouts/partials/custom-header.html.\nChang'n Menu Width Th' menu width changes fer different screen sizes:\nScreen Size Screen Width Menu Width Small \u003c 48rem 14.375rem Medium 48rem - 60rem 14.375rem Large \u003e= 60rem 18.75rem Ye can change th' menu width but not th' screen width breakpoints.\nT' adjust th' menu width, use these CSS variables. Avast that --MENU-WIDTH-S be fer th' mobile menu flyout on small screens.\n​ layouts/partials/custom-header.html \u003cstyle\u003e :root { --MENU-WIDTH-S: 14.375rem; --MENU-WIDTH-M: 14.375rem; --MENU-WIDTH-L: 18.75rem; } \u003c/style\u003e",
"description": "Changing the width of the sidebar",
"tags": [],
"title": "Width",
"uri": "/hugo-theme-relearn/pir/configuration/sidebar/width/index.html"
},
{
"breadcrumb": "Configurrrat'n",
"content": "LogoProvide yer own logo an' favicon\nColorsLearrrn how t' cust'mize yer site's colors\nModule Them'nColors o' rules highlight'n an' 3rd-party modules\nStylesheet GeneratorAn interactive tool t' generate color variant stylesheets",
"description": "Change colors and logos of your site",
"tags": [],
"title": "Brrrand'n",
"uri": "/hugo-theme-relearn/pir/configuration/branding/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Brrrand'n",
"content": "Th' Relearrrn theme offers color variants t' change yer site’s appearance. Each color variant contains o' a CSS file an' optional sett'ns 'n yer hugo.toml.\nYe can use th' shipped variants, cust'mize them, or create yer own. Th' interactive variant generator can help ye wit' this.\nOnce set up 'n hugo.toml, ye can switch variants us'n th' selector at th' bottom o' th' menu.\nShipped Variants Th' theme ships wit' th' follow'n set o' variants\nRelearrrn Light: th' classic Relearrrn default, com'n wit' signature green, dark sidebar an' light rrrambl'n area Dark: dark variant o' Light, com'n wit' signature green, dark sidebar an' dark rrrambl'n area Bright: alternative o' Light, com'n wit' signature green, green sidebar an' light rrrambl'n area Zen Light: a more relaxed white/grey variant, com'n wit' blue accents, light sidebar an' light rrrambl'n area Dark: dark variant o' Light, com'n wit' blue accents, dark sidebar an' dark rrrambl'n area Experimental Neon: a variant that glows 'n th' dark, gradient sidebar an' dark rrrambl'n area Retro Learrrn: th' default o' th' old Learrrn theme, com'n wit' signature light purple, dark sidebar an' light rrrambl'n area Blue: a blue variant o' th' old Learrrn theme, com'n tinted 'n blue, dark sidebar an' light rrrambl'n area Green: a green variant o' th' old Learrrn theme, com'n tinted 'n green, dark sidebar an' light rrrambl'n area Red: a red variant o' th' old Learrrn theme, com'n tinted 'n red, dark sidebar an' light rrrambl'n area Chang'n th' Variant Opt'n Set th' themeVariant opt'n t' change th' variant.\nTh' theme offers th' recommended advanced configurat'n mode that combines th' functionality fer multiple variants, OS sett'n adjustments, an' more.\nSimple Setup Single Variant Set themeVariant t' yer theme CSS file name:\nhugo. toml yaml json [params] themeVariant = 'relearn-light' params: themeVariant: relearn-light { \"params\": { \"themeVariant\": \"relearn-light\" } } Place yer theme file 'n assets/css or themes/hugo-theme-relearn/assets/css. Name it theme-*.css.\nIn th' above example, th' path o' yer theme file must be assets/css/theme-relearn-light.css or themes/hugo-theme-relearn/assets/css/theme-relearn-light.css.\nMultiple Variants T' let th' reader choose between multiple variants, set themeVariant like this:\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } Th' first variant be th' default, an' a selector will appear if there’s more than one.\nAdjust t' OS Sett'ns Use th' auto value t' match OS light/dark sett'ns. Usually it makes sense t' set it 'n th' first posit'n an' make it th' default.\nhugo. toml yaml json [params] themeVariant = ['auto', 'red'] params: themeVariant: - auto - red { \"params\": { \"themeVariant\": [ \"auto\", \"red\" ] } } If ye don’t configure anyth'n else, th' theme will default t' use relearn-light fer light mode an' relearn-dark fer dark mode.\nDefault be relearn-light fer light an' relearn-dark fer dark mode. These defaults be overwritten by th' first two non-auto opt'ns o' yer themeVariant array.\nYe can override th' default wit' themeVariantAuto:\nhugo. toml yaml json [params] themeVariantAuto = ['learn', 'neon'] params: themeVariantAuto: - learn - neon { \"params\": { \"themeVariantAuto\": [ \"learn\", \"neon\" ] } } Advanced Th' theme offers an advanced way t' configure theme variants an' all o' th' aspects above inside o' a single configurat'n item. This comes wit' some features previously unsupported.\nLike wit' th' multiple variants opt'n, ye be defin'n yer theme variants 'n an array but now 'n a t'ble wit' subopt'ns.\nAgain, 'n this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } ye now write it that way:\nhugo. toml yaml json [params] [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' params: themeVariant: - identifier: relearn-light - identifier: relearn-dark { \"params\": { \"themeVariant\": [ { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" } ] } } Th' identifier opt'n be mandatory an' equivalent t' th' str'n 'n th' first example. Further opt'ns can be configured, see th' t'ble below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond t' th' name o' a color variant either 'n yer site’s or th' theme’s directory 'n th' form assets/css/theme-\u003cIDENTIFIER\u003e.css. name see notes Th' name t' be displayed 'n th' variant selector. If not set, th' identifier be used 'n a human read'ble form. auto \u003cempty\u003e If set, th' variant be treated as an auto mode variant. It has th' same behavior as th' themeVariantAuto opt'n. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode. Defin'n auto mode variants wit' th' advanced opt'ns has th' benefit that ye can now have multiple auto mode variants instead o' just one wit' th' simple opt'ns. Example Configurat'n hugo. toml yaml json [params] [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] identifier = 'relearn-bright' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] auto = ['learn', 'neon'] identifier = 'retro-auto' name = 'Retro Learn/Neon' [[params.themeVariant]] identifier = 'neon' [[params.themeVariant]] identifier = 'learn' params: themeVariant: - auto: [] identifier: relearn-auto name: Relearrrn Light/Dark - identifier: relearn-light - identifier: relearn-dark - identifier: relearn-bright - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - auto: - learn - neon identifier: retro-auto name: Retro Learn/Neon - identifier: neon - identifier: learn { \"params\": { \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"identifier\": \"relearn-bright\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"auto\": [ \"learn\", \"neon\" ], \"identifier\": \"retro-auto\", \"name\": \"Retro Learn/Neon\" }, { \"identifier\": \"neon\" }, { \"identifier\": \"learn\" } ] } } Advanced Topics Modify'n Variants In case ye like a shipped variant but only want t' tweak some aspects, ye have some choices. Don’t edit th' file 'n th' theme’s directory! Ye will lose th' ability t' later easily upgrade yer theme t' a newer version.\nCopy an' change\nYe can copy th' shipped variant file from th' theme’s themes/hugo-theme-relearn/assets/css directory t' th' site’s assets/css directory an' either store it wit' th' same name or give it a new name. Edit th' sett'ns an' save th' new file. Afterwards, ye can use it 'n yer hugo.toml by th' chosen name.\nCreate an' import\nYe can create a new variant file 'n th' site’s assets/css directory an' give it a new name. Import th' shipped variant, add th' sett'ns ye want t' change an' save th' new file. Afterwards, ye can use it 'n yer hugo.toml by th' chosen name.\nFor example, ye want t' use th' relearn-light variant but want t' change th' rules highlight'n schema t' th' one used 'n th' neon variant. For that, create a new assets/css/theme-my-brand'n.css 'n yer site’s directory an' add th' follow'n lines:\n​ assets/css/theme-my-brand'n.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: neon; /* name o' th' chroma stylesheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color fer code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color fer code background */ } Afterwards, put this 'n yer hugo.toml t' use yer new variant:\nhugo. toml yaml json [params] themeVariant = 'my-branding' params: themeVariant: my-brand'n { \"params\": { \"themeVariant\": \"my-branding\" } } In comparison t' copy an' change, this has th' advantage that ye profit from any adjustments t' th' relearn-light variant while keep'n yer modificat'ns.\nReact t' Variant Switches 'n JavaScript Once a color variant be fully boarded, either initially or by switch'n th' color variant manually wit' th' variant selector, th' custom event themeVariantLoaded on th' document will be dispatched. Ye can add an event listener an' react t' changes.\n​ JavaScript document.addEventListener( 'themeVariantLoaded', funct'n( e ){ console.log( e.detail.variant ); // `relearn-light` });",
"description": "Learn how to customize your site's colors",
"tags": [],
"title": "Brrrand'n",
"uri": "/hugo-theme-relearn/pir/configuration/branding/colors/index.html"
},
{
"breadcrumb": "",
"content": "Find out how t' configure an' cust'mize yer ship.\nShip ManagementGet yourself familiar wit' th' general structure o' yer website\nBrand'nChange colors an' logos o' yer ship\nSidebarConfigure all th'ns sidebar\nRrrambl'nConfigure th' rrrambl'n area o' yer ship\nCustomizat'nCust'mize files fer advanced usage\nOpt'ns ReferenceAll configurat'n opt'ns fer th' Relearrrn theme",
"description": "Find out how t' configure an' cust'mize yer ship.\nShip ManagementGet yourself familiar wit' th' general structure o' yer website",
"tags": [],
"title": "Configurrrat'n",
"uri": "/hugo-theme-relearn/pir/configuration/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Customization",
"content": "A common quest'n be how t' add extra CSS styles or JavaScript t' yer ship. This depends on what ye need.\nAdd'n JavaScript or Stylesheets t' All Planks T' add JavaScript files or CSS stylesheets t' every plank, ye can include them 'n layouts/partials/custom-header.html or layouts/partials/custom-footer.html.\nHowever, this can make yer ship larger than necessary if these files be only needed on a few planks. Th' next section explains how t' add dependencies only when needed.\nCustom Shorrrtcodes wit' Dependencies Some shorrrtcodes need extra JavaScript an' CSS files. Th' theme only loads these when th' shortcode be used. Ye can use this fer yer own shorrrtcodes too.\nFor example, t' create a shortcode called myshortcode that needs th' jquery library:\nCreate th' shortcode file layouts/shortcodes/myshortcode.html an' add th' follog'n line somewhere:\n​ layouts/shortcodes/myshortcode.html ... {{- .Plank.Store.Set \"hasMyShortcode\" true }} ... Opt'n Add this t' yer hugo.toml:\nhugo. toml yaml json [params] [params.relearn] [params.relearn.dependencies] [params.relearn.dependencies.myshortcode] name = 'MyShortcode' params: relearn: dependencies: myshortcode: name: MyShortcode { \"params\": { \"relearn\": { \"dependencies\": { \"myshortcode\": { \"name\": \"MyShortcode\" } } } } } Create loader file layouts/partials/dependencies/myshortcode.html:\n​ layouts/partials/dependencies/myshortcode.html {{- if eq .locat'n \"footer\" }} \u003cscript src=\"https://www.unpkg.com/jquery/dist/jquery.js\"\u003e\u003c/script\u003e {{- end }} Important notes:\nCharacter cas'n be relevant! Th' name 'n hugo.toml must match th' Store key used 'n th' shortcode file, prefixed wit' a has. Th' key o' relearn.dependencies must match th' loader file name. See th' math, mermaid, an' openapi shorrrtcodes fer examples.\nAvast For advanced customizat'n, ye can use th' dependency loader 'n yer own partials:\n{{- partial \"dependencies.gotmpl\" (dict \"page\" . \"location\" \"mylocation\") }} Give a unique name fer th' locat'n parameter when ye call it, so ye can distinguish yer loaders behavior depend'n on th' locat'n it was called from.",
"description": "Add further code to your site",
"tags": [],
"title": "Extending Scripts",
"uri": "/hugo-theme-relearn/pir/configuration/customization/dependencies/index.html"
},
{
"breadcrumb": "Rambl'n",
"content": "Plank DesignsHow t' vary layouts by us'n plank designs\nMenusSett'n th' behavior o' th' menus\nLink'nWhat opt'ns be avail'ble fer links an' images\nTopbarConfigure th' topbar\nReferenceAll front matter fer th' Relearrrn theme",
"description": "All things front matter",
"tags": [],
"title": "Front Matter",
"uri": "/hugo-theme-relearn/pir/authoring/frontmatter/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Sidebar",
"content": "Title Opt'n Wit' th' default partials fer th' logo, Th' ship title will also be used fer th' text at th' top o' th' sidebar. If ye want t' show a different text 'n th' sidebar, ye can overwrite linkTitle.\nhugo. toml yaml json [params] linkTitle = 'Relearn' params: linkTitle: Relearrrn { \"params\": { \"linkTitle\": \"Relearn\" } } Home Button Configurat'n By default, th' theme displays a home button between search form an' navigat'n menu. Th' Home button serves as an alternative t' click'n th' logo.\nOpt'n T' hide th' Home button on th' left menu, set disableLandingPageButton=true.\nhugo. toml yaml json [params] disableLandingPageButton = true params: disableLandingPageButton: true { \"params\": { \"disableLandingPageButton\": true } } Opt'n T' change its ay'con or text, configure th' landingPageName fer yer defined languages.\nhugo. toml yaml json [languages] [languages.en] [languages.en.params] landingPageName = '\u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Home' [languages.pir] [languages.pir.params] landingPageName = '\u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Arrr! Homme' languages: en: params: landingPageName: \u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Home pir: params: landingPageName: \u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Arrr! Homme { \"languages\": { \"en\": { \"params\": { \"landingPageName\": \"\\u003ci class=\\\"fa-fw fas fa-home\\\"\\u003e\\u003c/i\\u003e Home\" } }, \"pir\": { \"params\": { \"landingPageName\": \"\\u003ci class=\\\"fa-fw fas fa-home\\\"\\u003e\\u003c/i\\u003e Arrr! Homme\" } } } } If this opt'n isn’t set fer a specific language, it will use these default values\nhugo. toml yaml json [params] landingPageName = '\u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Home' params: landingPageName: \u003ci class=\"fa-fw fas fa-home\"\u003e\u003c/i\u003e Home { \"params\": { \"landingPageName\": \"\\u003ci class=\\\"fa-fw fas fa-home\\\"\\u003e\\u003c/i\\u003e Home\" } } History Opt'n Turn on showVisitedLinks=true t' see checkmarks next t' visited planks 'n th' main menu. This also adds a Clear History opt'n at th' bottom o' th' menu t' remove all checkmarks. Avast that checkmarks will disappear if ye rebuild yer ship, as th' plank IDs may change.\nhugo. toml yaml json [params] showVisitedLinks = true params: showVisitedLinks: true { \"params\": { \"showVisitedLinks\": true } } Footer T' change th' menu footer, edit th' layouts/partials/menu-footer.html file. Check out th' Partials section fer more ways t' cust'mize yer ship.",
"description": "Configure the header and footer",
"tags": [],
"title": "Header \u0026 Footer",
"uri": "/hugo-theme-relearn/pir/configuration/sidebar/headerfooter/index.html"
},
{
"breadcrumb": "Rambl'n \u003e Front Matter",
"content": "",
"description": "Setting the behavior of the menus",
"tags": [],
"title": "Menus",
"uri": "/hugo-theme-relearn/pir/authoring/frontmatter/menus/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Site Management",
"content": "Th' Relearrrn theme works wit' Hugo’s multilingual mode.\nIt supports many languages, includ'n right-to-left languages.\nSupported languages Arabic Simplified Chinese Traditional Chinese Czech Dutch English Finnish French German Hindi Hungarian Indonesian Italian Japanese Korean Polish Portuguese Romanian Russian Spanish Swahili Turkish Vietnamese Translat'n by File Name Here’s how t' make yer ship multilingual us'n translat'ns by file name:\nSet up languages 'n yer hugo.toml file:\nhugo. toml yaml json defaultContentLanguage = 'en' [languages] [languages.en] languageCode = 'en' languageName = 'English' title = 'My Website' weight = 1 [languages.pir] languageCode = 'art-x-pir' languageDirect'n = 'rtl' languageName = 'Pirrratish' title = 'Arrr, my Website' weight = 2 defaultContentLanguage: en languages: en: languageCode: en languageName: English title: My Website weight: 1 pir: languageCode: art-x-pir languageDirect'n: rtl languageName: Pirrratish title: Arrr, my Website weight: 2 { \"defaultContentLanguage\": \"en\", \"languages\": { \"en\": { \"languageCode\": \"en\", \"languageName\": \"English\", \"title\": \"My Website\", \"weight\": 1 }, \"pir\": { \"languageCode\": \"art-x-pir\", \"languageDirection\": \"rtl\", \"languageName\": \"Pirrratish\", \"title\": \"Arrr, my Website\", \"weight\": 2 } } } Duplicate yer rrrambl'n files an' add language codes t' their file names:\n├── rrrambl'n │ ├── first-chapter │ │ ├── first-page | | | ├── _index.en.md | | | └── _index.pir.md │ │ ├── second-page | | | ├── index.en.md | | | └── index.pir.md │ │ ├── third-page.en.md │ │ └── third-page.pir.md │ ├── _index.en.md │ └── _index.pir.md ├── themes │ └── hugo-theme-relearn │ └── ... └── hugo.toml Translat'n by Rrrambl'n Directory Th' theme also support translat'ns by rrrambl'n directory which can be configured 'n a similar way. This be not used 'n further examples o' this documentat'n.\nSearch Sett'ns Check th' search configurat'n fer multilingual opt'ns.\nTurn Off Language Switch'n Opt'n By default th' theme shows a language switcher 'n th' lower part o' th' menu.\nT' dis'ble th' language switcher set disableLanguageSwitchingButton=true\nhugo. toml yaml json [params] disableLanguageSwitchingButton = true params: disableLanguageSwitchingButton: true { \"params\": { \"disableLanguageSwitchingButton\": true } }",
"description": "How to set up a multilingual site",
"tags": [],
"title": "Multilingual",
"uri": "/hugo-theme-relearn/pir/configuration/sitemanagement/multilingual/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Content",
"content": "Breadcrumbs Learrrn how t' turn off th' breadcrumbs completely an' further configure th' topbar.\nOpt'n Set disableRootBreadcrumb=true t' remove th' root breadcrumb which often feels redundant. This will also apply t' th' breadcrumbs o' th' search results an' taxonomy planks.\nOpt'n Ye can override th' default breadcrumb separator by us'n breadcrumbSeparator='/'. This separator will also be used 'n th' breadcrumbs o' th' search results an' taxonomy planks.\nOpt'n By default th' term planks o' a taxonomy will display th' breadcrumb fer each plank. Set disableTermBreadcrumbs=true t' remove th' breadcrumb if th' term planks look t' cluttered.\nhugo. toml yaml json [params] breadcrumbSeparator = '/' disableRootBreadcrumb = true disableTermBreadcrumbs = true params: breadcrumbSeparator: / disableRootBreadcrumb: true disableTermBreadcrumbs: true { \"params\": { \"breadcrumbSeparator\": \"/\", \"disableRootBreadcrumb\": true, \"disableTermBreadcrumbs\": true } } Titles Opt'n Ye can override th' default title separator by us'n titleSeparator='|'.\nhugo. toml yaml json [params] titleSeparator = '|' params: titleSeparator: '|' { \"params\": { \"titleSeparator\": \"|\" } }",
"description": "Configuring titles and breadcrumbs to your needs",
"tags": [],
"title": "Titles \u0026 Breadcrumbs",
"uri": "/hugo-theme-relearn/pir/configuration/content/titles/index.html"
},
{
"breadcrumb": "Introduction",
"content": "Front Matter CMS Th' theme supports th' great VSCode Front Matter CMS extension which provides on-premise CMS capabilties t' Cap'n Hugo.\nFor that, th' theme provides a snippets file so ye can use shorrrtcodes from inside th' Front Matter CMS.\nCurrently only English an' German be supported.\nT' use them 'n yer Front Matter CMS, put a reference into yer frontmatter.json like this\n​ frontmatter.json { \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] }",
"description": "All about supported 3rd party tools",
"tags": [],
"title": "Tool Integration",
"uri": "/hugo-theme-relearn/pir/introduction/tools/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Content",
"content": "Head'ns can have anchor links that appear when ye hover over them.\nYe can change what happens when ye click th' anchor ay'con 'n yer hugo.toml file. By default, all opt'ns be turned on. If ye turn off all opt'ns, no anchor ay'con will show up when ye hover.\nCopy Anchor Links Opt'n Set disableAnchorCopy=true t' prevent copy'n th' anchor link when ye click th' ay'con.\nhugo. toml yaml json [params] disableAnchorCopy = true params: disableAnchorCopy: true { \"params\": { \"disableAnchorCopy\": true } } Scroll t' Head'n Opt'n Set disableAnchorScrolling=true t' stop th' plank from scroll'n t' th' head'n when ye click th' anchor ay'con.\nhugo. toml yaml json [params] disableAnchorScroll'n = true params: disableAnchorScroll'n: true { \"params\": { \"disableAnchorScrolling\": true } }",
"description": "Configuring heading anchors",
"tags": [],
"title": "Headings",
"uri": "/hugo-theme-relearn/pir/configuration/content/headings/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Customization",
"content": "This plank shows ye, how t' configure custom image effects on top o' exist'n ones.\nThis sett'n can also be overridden by yer front matter.\nIf ye don’t configure anyth'n 'n yer hugo.toml, th' image effects default t'\nDefault Values ​ toml yaml json [imageEffects] border = false lazy = true lightbox = true shadow = false imageEffects: border: false lazy: true lightbox: true shadow: false { \"imageEffects\": { \"border\": false, \"lazy\": true, \"lightbox\": true, \"shadow\": false } } Configurat'n Opt'n Ye can change these sett'ns 'n yer hugo.toml an' add arbitrary custom effects as boolean values (like bg-white 'n th' below snippet).\nhugo. toml yaml json [params] [params.imageEffects] bg-white = true border = true lazy = false params: imageEffects: bg-white: true border: true lazy: false { \"params\": { \"imageEffects\": { \"bg-white\": true, \"border\": true, \"lazy\": false } } } This would result 'n\n​ toml yaml json [imageEffects] bg-white = true border = true lazy = false lightbox = true shadow = false imageEffects: bg-white: true border: true lazy: false lightbox: true shadow: false { \"imageEffects\": { \"bg-white\": true, \"border\": true, \"lazy\": false, \"lightbox\": true, \"shadow\": false } } Example Wit' this configurat'n 'n effect, th' follow'n URL\n​ Marrrkdown ![Minion](https://octodex.github.com/images/minion.png) would result 'n\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png\" load'n=\"lazy\" alt=\"Minion\" class=\"bg-white border nolazy lightbox noshadow\"\u003e Styl'n Effects If th' result'n effect value be\ntrue: add a class wit' th' effect’s name false: add a class wit' th' effect’s name an' a “no” prefix Styles fer default effects be contained 'n th' theme. Add styles fer yer custom effects t' layouts/partials/content-header.html.\nFor th' above example ye could add styles fer both boolean cases:\n​ layouts/partials/content-header.html \u003cstyle\u003e img.bg-white { background-color: white; } img.nobg-white { background-color: transparent; } \u003c/style\u003e",
"description": "How to extend image effects",
"tags": [],
"title": "Image Effects",
"uri": "/hugo-theme-relearn/pir/configuration/customization/imageeffects/index.html"
},
{
"breadcrumb": "Rambl'n \u003e Front Matter",
"content": "Open'n Links Opt'n Front Matter By default, external links open 'n a new tab. T' change this, use th' externalLinkTarget sett'n wit' a proper link target.\nFor example, this will open links 'n th' same tab\n​ toml yaml json externalLinkTarget = '_self' externalLinkTarget: _self { \"externalLinkTarget\": \"_self\" } Enabl'n Link an' Image Link Warn'ns Opt'n Front Matter Ye can use link.errorlevel an' image.errorlevel t' control what should happen if a local link can not be resolved t' a resource.\nIf not set or empty, any unresolved link be written as given into th' result'n output. If set t' warning th' same happens an' an additional warning be printed 'n th' built console. If set t' error an error message be printed an' th' build be aborted.\nPlease note that this can not resolve files inside o' yer static directory. Th' file must be a resource o' th' plank or th' ship.\nLink warnings be also avail'ble fer th' include an' openapi shorrrtcodes.\n​ toml yaml json [image] errorlevel = 'warning' [link] errorlevel = 'warning' image: errorlevel: warning link: errorlevel: warning { \"image\": { \"errorlevel\": \"warning\" }, \"link\": { \"errorlevel\": \"warning\" } }",
"description": "What options are available for links and images",
"tags": [],
"title": "Linking",
"uri": "/hugo-theme-relearn/pir/authoring/frontmatter/linking/index.html"
},
{
"breadcrumb": "Rambl'n",
"content": "Plank Title Th' title will be used 'n th' head'n an' meta informat'n o' yer HTML.\nA plank without a title be treated as if hidden=true has been set.\n​ toml yaml json +++ title = 'Example Title' +++ --- title: Example Title --- { \"title\": \"Example Title\" } Plank Descript'n Th' descript'n be used fer generat'n HTML meta informat'n, 'n th' children shortcode an' 'n social media meta informat'n.\nIf not set, th' set value o' yer site’s hugo.toml be used fer th' HTML meta informat'n an' social media meta informat'n. It appears empty fer th' children shortcode.\n​ toml yaml json +++ descript'n = 'Some lenghty example description' +++ --- descript'n: Some lenghty example descript'n --- { \"description\": \"Some lenghty example description\" } Social Media Images Th' theme adds social media meta tags includ'n feature images fer th' Open Graph protocol an' Twitter Cards t' yer ship. These be configured as mentioned 'n th' linked Cap'n Hugo docs.\n​ toml yaml json +++ images = ['images/hero.png'] +++ --- images: - images/hero.png --- { \"images\": [ \"images/hero.png\" ] } Hidden Front Matter Ye can hide yer planks from th' menu by sett'n hidden=true.\nMenu For Cap'n Hugo menus, ye have t' set params.hidden=true instead.\nSee how ye can further configure visibility throughout yer ship.\n​ toml yaml json +++ hidden = true +++ --- hidden: true --- { \"hidden\": true } Add Ay'con t' th' Title Head'n Front Matter In th' plank front matter, add a headingPre t' insert any HTML code before th' title head'n. Ye can also set headingPost t' insert HTML code after th' title head'n.\nYe also may want t' apply further CSS 'n this case.\n​ toml yaml json +++ headingPre = '\u003ci class=\"fab fa-github\"\u003e\u003c/i\u003e ' +++ --- headingPre: '\u003ci class=\"fab fa-github\"\u003e\u003c/i\u003e ' --- { \"headingPre\": \"\\u003ci class=\\\"fab fa-github\\\"\\u003e\\u003c/i\\u003e \" } Footer Informat'n Front Matter If ye use th' default layouts/partials/content-footer.html be not overridden by ye, it will display author'n informat'n, namely\nAuthorName if GitInfo be active, otherwise LastModifierDisplayName front matter AuthorEmail if GitInfo be active, otherwise LastModifierEmail front matter AuthorDate if GitInfo be active, otherwise Hugo’s date front matter ​ toml yaml json +++ LastModifierDisplayName = 'Santa Claus' LastModifierEmail = 'santa@example.com' date = 2000-12-24T00:00:00-12:00 +++ --- LastModifierDisplayName: Santa Claus LastModifierEmail: santa@example.com date: 2000-12-24T00:00:00-12:00 --- { \"LastModifierDisplayName\": \"Santa Claus\", \"LastModifierEmail\": \"santa@example.com\", \"date\": \"2000-12-24T00:00:00-12:00\" }",
"description": "What page meta information are available",
"tags": [],
"title": "Meta Information",
"uri": "/hugo-theme-relearn/pir/authoring/meta/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Site Management",
"content": "Ship Author Informat'n Opt'n Th' theme uses author details 'n various parts o' yer ship, like RSS feeds an' meta tags.\nhugo. toml yaml json [params] [params.author] email = 'santa@example.com' name = 'Santa Claus' params: author: email: santa@example.com name: Santa Claus { \"params\": { \"author\": { \"email\": \"santa@example.com\", \"name\": \"Santa Claus\" } } } Ship Title Th' title will be used 'n meta informat'n o' yer HTML.\nhugo. toml yaml json title = 'Hugo Relearrrn Theme' title: Cap'n Hugo Relearrrn Theme { \"title\": \"Hugo Relearrrn Theme\" } Ship Descript'n Front Matter Th' theme shows a ship descript'n 'n various places, such as RSS feeds an' meta tags. For this, it uses th' descript'n field from yer home page’s front matter.\nSocial Media Images When yer plank be shared on social media, ye can set a site-wide image t' display wit' th' link\nhugo. toml yaml json images = ['images/hero.png'] images: - images/hero.png { \"images\": [ \"images/hero.png\" ] } More Social Media Opt'ns Th' theme adheres t' Hugo’s official documentat'n fer Open Graph an' Twitter Cards configurat'n.",
"description": "What site-wide meta information can be set",
"tags": [],
"title": "Meta Information",
"uri": "/hugo-theme-relearn/pir/configuration/sitemanagement/meta/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Brrrand'n",
"content": "Change Rules Highlight'n If ye want t' switch th' rules highlight'n theme together wit' yer color variant, first ye need t' configure yer installat'n accord'n t' Hugo’s documentat'n t' provide a rules highlight'n stylesheet file.\nhugo. toml yaml json [marrrkup] [marrrkup.highlight] noClasses = false marrrkup: highlight: noClasses: false { \"markup\": { \"highlight\": { \"noClasses\": false } } } Ye can use one o' th' shipped stylesheet files or use Cap'n Hugo t' generate a file fer ye.\nhugo gen chromastyles --style=monokai \u003e chroma-mycode.css Th' file must be written t' assets/css/chroma-\u003cNAME\u003e.css. T' use it wit' yer color variant, ye have t' modify --CODE-theme: \u003cNAME\u003e 'n th' color variant stylesheet file.\n​ assets/css/theme-my-brand'n.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: mycode; /* name o' th' chroma stylesheet file */ } Change 3rd-Party Libraries Them'n Some o' th' shipped shorrrtcodes be us'n 3rd-party libraries. See th' individual shortcode documentat'n on how t' change their them'n.\nmermaid shortcode openapi shortcode",
"description": "Colors of syntax highlighting and 3rd-party modules",
"tags": [],
"title": "Module Theming",
"uri": "/hugo-theme-relearn/pir/configuration/branding/modules/index.html"
},
{
"breadcrumb": "",
"content": "Learrrn how t' create an' org'nize yer rrrambl'n planks.\nDirectory StructureYer content's directory structure\nFront MatterAll th'ns front matter\nMeta Informat'nWhat plank meta informat'n be avail'ble\nMarrrkdown RulesReference o' CommonMark an' Marrrkdown extensions\nImage EffectsHow t' apply graphical effects t' yer images",
"description": "Learrrn how t' create an' org'nize yer rrrambl'n planks.\nDirectory StructureYer content's directory structure",
"tags": [],
"title": "Rambl'n",
"uri": "/hugo-theme-relearn/pir/authoring/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Sidebar",
"content": "Configure Search Th' theme offers three levels o' search through th' menu’s search form:\nIn-page search: Highlights search terms on th' current plank Search popup: Opens a popup wit' results from other planks Dedicated search plank: Access'ble by click'n th' magnifier glass or press'n ENTER Each level requires th' previous one t' be enabled. If no search be configured, th' search form won’t appear.\nOpt'n All levels be enabled by default. Dis'ble them 'n hugo.toml:\nIn-page search: disableSearch=true Search popup: disableSearchIndex=true Dedicated search plank: disableSearchPage=true hugo. toml yaml json [params] disableSearch = true disableSearchIndex = true disableSearchPage = true params: disableSearch: true disableSearchIndex: true disableSearchPage: true { \"params\": { \"disableSearch\": true, \"disableSearchIndex\": true, \"disableSearchPage\": true } } Opt'n Default URLs can be changed wit' th' follow'n parameter\nSearch popup: searchindex.js set by searchIndexURL Dedicated search plank: search/index.html set by searchPageURL hugo. toml yaml json [params] searchIndexURL = 'omnisearchindex.js' searchPageURL = 'omnisearch' params: searchIndexURL: omnisearchindex.js searchPageURL: omnisearch { \"params\": { \"searchIndexURL\": \"omnisearchindex.js\", \"searchPageURL\": \"omnisearch\" } } Avast Only change these if ye have rrrambl'n at those URLs. This can happen wit' uglyURLs=true 'n hugo.toml an' hav'n a rrrambl'n file at content/search.md.\nCheck fer duplicate URLs by runn'n hugo --printPathWarn'ns.\nSupported Languages Th' Lunr search library doesn’t support all languages o' th' theme. Unsupported languages will show errors 'n th' browser console. Currently unsupported be\nCzech Indonesian Polish Swahili Mixed Language Support Opt'n In case yer page’s rrrambl'n contains text 'n multiple languages (for example, ye be writ'n a Piratish documentat'n fer yer English API), ye can set those languages 'n additionalContentLanguage t' broaden th' search.\nhugo. toml yaml json [params] additionalContentLanguage = ['en'] params: additionalContentLanguage: - en { \"params\": { \"additionalContentLanguage\": [ \"en\" ] } } Ye can add multiple languages t' this array.\nAvast Use th' base language code. For example, if yer plank be us'n zh-CN, add zh t' this parameter.",
"description": "Configure search and the search form",
"tags": [],
"title": "Search",
"uri": "/hugo-theme-relearn/pir/configuration/sidebar/search/index.html"
},
{
"breadcrumb": "Configurrrat'n",
"content": "WidthChang'n th' width o' th' sidebar\nHeader \u0026 FooterConfigure th' header an' footer\nSearchConfigure search an' th' search form\nMenusConfigure all th'ns menus",
"description": "Configure all things sidebar",
"tags": [],
"title": "Sidebar",
"uri": "/hugo-theme-relearn/pir/configuration/sidebar/index.html"
},
{
"breadcrumb": "Introduction",
"content": "Version 7 7.1.0 (2024-10-24) Change Change Th' sidebar menus be now completely configur'ble.\nThis be provided by th' new parameter sidebarmenus. Wit' th' new system, ye can\nshow 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.\nChange Th' children shortcode was changed t' output a page’s LinkTitle instead o' previously us'n th' Title.\nAs 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.\nTh' 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.\nNew 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\nsuffered 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.\nIf ye haven’t done customizat'ns t' any partials, ye can update right away.\nIf 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.\nSpecifically, ye will have t' adapt yer ship if ye have\noverwritten th' header.html, menu.html or footer.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.\nYe need t' remove th' now obsolete search an' searchpage output format from [outputs.home] 'n yer hugo.toml, result'n 'n someth'n similar t'\nhugo. 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 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.\nIn 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.\nSee th' updated documentat'n fer reference.\nChange Change Once again, th' theme changed th' font. We switched t' th' excellent Roboto Flex font.\nCare 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.\nThis 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.\nTh' 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.\nIf 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.\nAdditionally, 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.\nChange 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.\n--MAIN-TITLES-TEXT-font was renamed t' --MAIN-TITLES-font, --MAIN-TITLES-H\u003cn\u003e-color was renamed t' --MAIN-TITLES-H\u003cn\u003e-TEXT-color.\nChange Th' opt'ns an' front matter t' force load'n a math, mermaid or openapi library has been changed.\nPreviously, 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.\nYe don’t need t' change anyth'n yet but will receive warnings if th' old sett'ns be used.\nChange Th' default logo be not contained inside o' th' theme’s logo partial anymore.\nThis be t' avoid usage o' th' theme’s brand'n throughout th' web 'n non-modified installat'ns.\nIn addit'n, th' default text fer th' logo partial be now taken from th' linkTitle sett'n o' yer hugo.toml.\nNew New Th' docs received a much-needed overhaul fer all chapters.\nBasically, 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.\nTh' 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.\nT' 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.\nAlso, a lot o' previously undocumented features be now included, namely\nth' hidden planks feature opt'ns o' th' menus configur'n breadcrumb, titles an' head'ns o' yer rrrambl'n opt'ns fer us'n links add'n custom output formats Version 6 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.\nNew 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.\nChange 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.\nNew New Th' notice shortcode has a new parameter expanded t' make th' rrrambl'n collaps'ble.\nNew If ye be runn'n Hugo 0.134.0 or later, th' theme now supports Obsidian callouts.\nNew 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.\nIf 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.\nIf ye dislike th' new behavior, ye can deactivate it by sett'n disableAnchorScrolling=true 'n yer hugo.toml. See th' docs fer further opt'ns.\nNew New If ye be runn'n Hugo 0.132.0 or later, th' theme be now cap'ble t' print GitHub alerts.\nNew T' support new severity levels fer GitHub alerts, all shorrrtcodes that support severity levels wit' their style parameter were expanded wit' th' new severities caut'n 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.\nNew 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).\nChange 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.\nNew 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 can not be resolved.\nNew Shorrrtcodes support'n an errorlevel configurat'n can now have overridden values 'n th' front matter section o' each individual plank.\nNew Th' theme now comes wit' its own overridden version o' th' relref shortcode.\nWhile 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.\nTh' shortcode be deactivated by default an' can be activated by sett'n\nhugo. 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.\nThis was necessary t' avoid permission errors on build if runn'n 'n certain Unix configurat'ns.\nIn addit'n it be not allowed anymore t' @import yer chroma stylesheet from inside o' yer variant stylesheet.\nSay, yer chroma stylesheet be named chroma-monokai.css, ye have t' add th' follow'n inside yer variant stylesheet:\n--CODE-theme: monokai; Break'n Th' parameter descript'n 'n yer hugo.toml will now be ignored.\nWit' 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.\nFor migrat'n, move th' descript'n parameter o' yer hugo.toml into th' front matter section o' yer home plank.\nBreak'n Search support fer th' json outputformat deprecated 'n 5.4.0 was removed.\nChange it t' search fer th' homepage 'n yer hugo.toml. See th' docs fer detailed configurat'n.\nBreak'n Th' front matter opt'n menuTitle deprecated 'n 5.24.0 was removed 'n favor fer Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead o' title t' generate th' breadcrumb.\nBreak'n Th' swagger shortcode deprecated 'n 5.13.0 was removed 'n favor fer th' openapi shortcode wit' th' same set o' parameter.\nBreak'n Support fer Internet Explorer 11 was finally dropped.\nChange Change Wit' th' removal o' support fer Internet Explorer 11, Font Awesome was upgraded t' version 6.5.2.\nYe may experience slight changes fer some ay'cons. In addit'n ye have additional ~1700 ay'cons t' chose from.\nChange 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.\nPreviously, th' summary erroneously was ignored which now can lead t' different output if ye set description=true as a parameter.\nNew 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 can not be resolved.\nNew Math be now us'ble without enclos'n it 'n a shortcode or Marrrkdown codefence by us'n Hugo’s passthrough configurat'n.\nNew Translat'n into Romanian. Older Versions Version 5 Version 4 Version 3 Version 2 Version 1",
"description": "What's new in this version",
"tags": [],
"title": "What's New",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/index.html"
},
{
"breadcrumb": "Introduction",
"content": "Version 7 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' exampleSite #924 [feature][change] math: adhere t' Hugo’s default config params #923 [feature][change] theme: replace font #922 [feature][break'n] 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 war'n fer usage o' .Sites.First #912 [task][break'n] theme: restructure code #891 [task][break'n] search: improve generat'n o' dedicated search plank #888 [task] theme: remove warning fer usage o' .Site.IsMultiLingual #877 [task][break'n] 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 opt'n 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][break'n] 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][break'n] menu: remove menuTitle frontmatter #714 [feature][break'n] theme: end support fer Internet Explorer 11 #584 Fixes [bug] frontmatter: move frontmatter config fer exampleSite out o' root #843 [bug] images: color outline us'n primary color #838 [bug][break'n] variant: avoid Cap'n Hugo permission errors on build #831 [bug] theme: unwanted paragraph break wit' AsciiDoc #829 Maintenance [task][break'n] swagger: remove shortcode #847 [task][break'n] 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 Older Versions Version 5 Version 4 Version 3 Version 2 Version 1",
"description": "The detailed changelog",
"tags": [],
"title": "Changelog",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/index.html"
},
{
"breadcrumb": "Configurrrat'n",
"content": "WidthChang'n th' rrrambl'n area width\nTitles \u0026 BreadcrumbsConfigur'n titles an' breadcrumbs t' yer needs\nHead'nsConfigur'n head'n anchors\nLink'nWhat opt'ns be avail'ble fer links an' images\nHidden PlanksLearrrn about th' hidden planks feature",
"description": "Configure the content area of your site",
"tags": [],
"title": "Content",
"uri": "/hugo-theme-relearn/pir/configuration/content/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Site Management",
"content": "Offline Usage Th' theme be us'ble offline. No internet connect'n be required t' board yer plank. This be achieved by stor'n all dependencies within th' theme.\nNo calls t' 3rd party servers, no call'n home, no track'n. Privacy friendly.\nServer Deployment If yer server deployment has no special requirements, ye can skip this section an' use th' standard Cap'n Hugo opt'ns.\nFor special requirements, th' theme be cap'ble o' different scenarios, requir'n th' follow'n mandatory sett'ns 'n yer hugo.toml. All sett'ns not mentioned 'n th' examples below can be set t' yer lik'n.\nPublic Web Server from Root hugo. toml yaml json baseURL = 'https://example.com/' baseURL: https://example.com/ { \"baseURL\": \"https://example.com/\" } Public Web Server from Subdirectory hugo. toml yaml json baseURL = 'https://example.com/mysite/' relativeURLs = false baseURL: https://example.com/mysite/ relativeURLs: false { \"baseURL\": \"https://example.com/mysite/\", \"relativeURLs\": false } If ye be still us'n Hugo’s relref shortcode (which ye shouldn’t), ye will need further configurat'n.\nArrr Don’t use a baseURL wit' a subdirectory an' relativeURLs=true together. Cap'n Hugo doesn’t apply th' baseURL correctly 'n this case. If ye need both, generate yer ship twice wit' different sett'ns into separate directories.\nPrivate Web Server (LAN) Th' same sett'ns as wit' any o' th' public web server scenarios or\nhugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } File System Yer generated ship can be used headless without a HTTP server.\nThis can be achieved by us'n th' file:// protocol 'n yer browser’s address bar or by do'ble click on a generated *.html file 'n yer file navigat'n tool.\nUse th' follow'n sett'ns\nhugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } Avast Planks like sitemap.xml an' rss.xml, an' social media links will always use absolute URLs. They won’t work wit' relativeURLs=true.",
"description": "Options for specific deployment needs",
"tags": [],
"title": "Deployment Scenarios",
"uri": "/hugo-theme-relearn/pir/configuration/sitemanagement/deployment/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Content",
"content": "Further sett'ns be avail'ble t' be used 'n yer configurat'n or front matter.\nURL Management Opt'n By default, th' theme adds index.html t' plank links when uglyURLs=false (Hugo’s default).\nIf you’re only us'n a web server scenario an' dislike this, ye can reset t' Hugo’s default behavior by sett'ns disableExplicitIndexURLs=true.\nFor th' file system scenario, ye be not allowed t' change this value.\nhugo. toml yaml json [params] disableExplicitIndexURLs = true params: disableExplicitIndexURLs: true { \"params\": { \"disableExplicitIndexURLs\": true } } Patch'n th' relref Shortcode Opt'n While th' usage o' relref be obsolete an' discouraged by Cap'n Hugo fer a while, exist'n installat'ns may still use it.\nIn configurat'ns us'n a baseURL wit' a subdirectory an' hav'n relativeURLs=false (the default), Hugo’s standard relref implementat'n be fail'n.\nT' work around this, ye can activate a patched version o' th' shortcode by sett'n disableDefaultRelref=true.\nhugo. toml yaml json [params] disableDefaultRelref = true params: disableDefaultRelref: true { \"params\": { \"disableDefaultRelref\": true } }",
"description": "What options are available for links and images",
"tags": [],
"title": "Linking",
"uri": "/hugo-theme-relearn/pir/configuration/content/linking/index.html"
},
{
"breadcrumb": "Rambl'n",
"content": "Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\nMarrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid HTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship. Write 'n any text editor or Marrrkdown applicat'n ye like. Marrrkdown be a joy t' use! John Gruber, th' author o' Marrrkdown, puts it like this:\nTh' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email. John Gruber\nSmarrrt Arrrse Bookmark this plank fer easy future reference!\nStandard an' Extensions If not otherwise noted, th' shown examples adhere t' th' CommonMark standard. In addit'n th' theme supports th' follow'n extensions that can be activated 'n yer hugo.toml or be built into th' theme:\nGFM Extension on top o' standard Marrrkdown adher'n t' GitHub Flavored Marrrkdown.\nPHP Extension on top o' standard Marrrkdown adher'n t' PHP Marrrkdown.\nPants Extension by John Gruber adher'n t' SmartyPants.\nCap'n Hugo Cap'n Hugo Extra Extension supported by Cap'n Hugo.\nObsidian Extension implemented by Obsidian.\nHTML If th' usage o' HTML be allowed, th' theme supports styl'n fer further HTML elements.\nRelearrrn Extension specific t' this theme.\nParagraphs In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.\nAny text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHead'ns A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from h1 through h6 be constructed wit' a # fer each level.\nIn Hugo ye usually don’t use h1 as this be generated by yer theme an' ye should only have one such element 'n a document.\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Result h1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n Horizontal Rules T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nBlockquotes Quotat'ns For quot'n blocks o' rrrambl'n from another source within yer document add \u003e before any text ye want t' quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.\nSed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nGitHub Alerts GFM Since Cap'n Hugo 0.132.0 GitHub alerts be also supported. Please note, that color'n an' ay'cons o' severities may defer between GitHub an' this theme.\nIf ye be 'n need o' more advanced opt'ns t' style yer alerts, like ay'cons, use th' notice shortcode.\n\u003e [!CAUTION] \u003e Advises about risks or negative outcomes o' certain act'ns. \u003e [!IMPORTANT] \u003e Key informat'n users need t' know t' achieve their goal. \u003e [!INFO] \u003e Informat'n that users \u003cins\u003e_might_\u003c/ins\u003e find interest'n. \u003e [!NOTE] \u003e Useful informat'n that users should know, even when skimm'n rrrambl'n. \u003e [!TIP] \u003e Helpful advice fer do'n th'ns better or more easily. \u003e [!WARNING] \u003e Urgent info that needs immediate user attent'n t' avoid problems. Result Caut'n Advises about risks or negative outcomes o' certain act'ns.\nImportant Key informat'n users need t' know t' achieve their goal.\nAhoi Informat'n that users might find interest'n.\nAvast Useful informat'n that users should know, even when skimm'n rrrambl'n.\nSmarrrt Arrrse Helpful advice fer do'n th'ns better or more easily.\nArrr Urgent info that needs immediate user attent'n t' avoid problems.\nObsidian Callouts Obsidian Since Cap'n Hugo 0.134.0 Obsidian callouts be also supported. Which enables configur'ble title text an' expand/collapse.\nIf ye be 'n need o' more advanced opt'ns t' style yer alerts, like ay'cons, use th' notice shortcode.\n\u003e [!tip] Callouts can have custom titles \u003e Like this one. \u003e [!tip] Title-only callout \u003e [!note]- Be callouts fold'ble? \u003e Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed \u003e [!note]+ Be callouts fold'ble? \u003e Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed Result Callouts can have custom titles Like this one.\nTitle-only callout Be callouts fold'ble? Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed\nBe callouts fold'ble? Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed\nText Markers Bold Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks **.\nI am rendered wit' **bold text** Result I am rendered wit' bold text\nItalics Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores _.\nI am rendered wit' _italicized text_ Result I am rendered wit' italicized text\nMarked Text Ye can mark text 'n th' predefined accent color o' yer stylesheet.\nCap'n Hugo Since Cap'n Hugo 0.126.0, ye can activate this through th' Cap'n Hugo Extra Extension 'n yer hugo.toml\n==Parts== o' this text ==are marked!== HTML Ye can also use it by configur'n Hugo fer usage o' HTML.\n\u003cmark\u003eParts\u003c/mark\u003e o' this text \u003cmark\u003ebe marked!\u003c/mark\u003e Result Parts o' this text be marked!\nInserted Text Ye can mark text addit'ns t' exist'n text.\nCap'n Hugo Since Cap'n Hugo 0.126.0, ye can activate this through th' Cap'n Hugo Extra Extension 'n yer hugo.toml\nTh' ++hot, new++ stuff HTML Ye can also use it by configur'n Hugo fer usage o' HTML.\nTh' \u003cins\u003ehot, new\u003c/ins\u003e stuff Result Th' hot, new stuff\nDeleted Text GFM Ye can do strikethroughs by enclos'n text wit' two tildes ~~. See Hugo’s documentat'n remarks if ye want t' use this together wit' th' subscript rules.\n~~Strike through~~ this text Result Strike through this text\nSpecial Typesett'n Text Substitut'n Pants Ye can combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.\nDo'ble quotes `\"` an' single quotes `'` o' enclosed text be replaced by **\"do'ble curly quotes\"** an' **'single curly quotes'**. Do'ble dashes `--` an' triple dashes `---` be replaced by en-dash **--** an' em-dash **---** entities. Do'ble arrows point'n left `\u003c\u003c` or right `\u003e\u003e` be replaced by arrow **\u003c\u003c** an' **\u003e\u003e** entities. Three consecutive dots `...` be replaced by an ellipsis **...** entity. Result Do'ble quotes \" an' single quotes ' o' enclosed text be replaced by “do'ble curly quotes” an' ‘single curly quotes’.\nDo'ble dashes -- an' triple dashes --- be replaced by en-dash – an' em-dash — entities.\nDo'ble arrows point'n left \u003c\u003c or right \u003e\u003e be replaced by arrow « an' » entities.\nThree consecutive dots ... be replaced by an ellipsis … entity.\nSubscript an' Superscript Ye can also use subscript an' superscript text. For more complex stuff, ye can use th' math shortcode.\nCap'n Hugo Since Cap'n Hugo 0.126.0, ye can activate this through th' Cap'n Hugo Extra Extension 'n yer hugo.toml\nHow many liters H~2~O fit into 1dm^3^? HTML Ye can also use it by configur'n Hugo fer usage o' HTML.\nHow many liters H\u003csub\u003e2\u003c/sub\u003eO fit into 1dm\u003csup\u003e3\u003c/sup\u003e? Result How many liters H2O fit into 1dm3?\nKeyboard Shortcuts HTML Ye can use th' \u003ckbd\u003e element t' style keyboard shortcuts.\nPress \u003ckbd\u003eSTRG\u003c/kbd\u003e \u003ckbd\u003eALT\u003c/kbd\u003e \u003ckbd\u003eDEL\u003c/kbd\u003e t' end yer shift early. Result Press STRG ALT DEL t' end yer shift early.\nLists Unordered Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nYe may use any o' -, * or + t' denote bullets fer each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipisc'n elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered Ye can create a list o' items 'n which th' order o' items does explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nMarrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipisc'n elit 1. Integer molestie lorem at massa 7. Facilisis 'n pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks GFM Ye can add task lists result'n 'n checked or unchecked non-click'ble items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definit'ns PHP Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.\nA definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.\nIf ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble\nApple : Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. : An American computer company. Orange : Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it. : A telecommunicat'n company. Ye can't make juice out o' it. Result Apple Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. An American computer company. Orange Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it.\nA telecommunicat'n company. Ye can’t make juice out o' it.\nCode Inline Code Inline snippets o' code can be wrapped wit' backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` be marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e be marked as code.\nIndented Code Block A simple code block can be generated by indent'n several lines o' code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 o' code line 2 o' code line 3 o' code Result Be impressed by my advanced code:\n// Some comments line 1 o' code line 2 o' code line 3 o' code Fenced Code Block If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks ``` a so called fence.\nGFM Ye can also add a language specifier directly after th' open'n fence, ```js, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.\nSee Code Highlight'n fer additional documentat'n.\n```js { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; ``` Result { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; Tables GFM Ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.\n| Opt'n | Descript'n | |--------|-------------| | data | path t' data files t' supply th' data that will be passed into templates. | | engine | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | extension t' be used fer dest files. | Result Opt'n Descript'n data path t' data files t' supply th' data that will be passed into templates. engine engine t' be used fer process'n templates. Handlebars be th' default. ext extension t' be used fer dest files. Aligned Columns Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.\n| Opt'n | Number | Descript'n | |-------:|:------:|:------------| | data | 1 | path t' data files t' supply th' data that will be passed into templates. | | engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | 3 | extension t' be used fer dest files. | Result Opt'n Number Descript'n data 1 path t' data files t' supply th' data that will be passed into templates. engine 2 engine t' be used fer process'n templates. Handlebars be th' default. ext 3 extension t' be used fer dest files. Links Autolink GFM Absolute URLs will automatically be converted into a link.\nThis be a link t' https://example.com. Result This be a link t' https://example.com.\nBasic Link Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink wit' Tooltip For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go t' example domain\" Result Example\nFootnotes PHP Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.\nUsually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.\nFootnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.\nThat's some text wit' a footnote[^1] [^1]: An' that's th' footnote. That's some more text wit' a footnote.[^someid] [^someid]: Anyth'n o' interest goes here. Blue light glows blue. Result That’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar rules t' links but include a preced'n exclamat'n mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image wit' Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects Relearrrn This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. See th' image effects docs fer a detailed example an' how t' configure it.\nResiz'n Add query parameter width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combinat'n ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add th' query parameter lightbox=false t' th' image link t' dis'ble th' lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Avast If ye want t' wrap an image 'n a link an' lightbox=true be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)",
"description": "Reference of CommonMark and Markdown extensions",
"tags": [],
"title": "Marrrkdown Rules",
"uri": "/hugo-theme-relearn/pir/authoring/markdown/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Sidebar",
"content": "Th' theme can build menu trees from th' structure o' yer plank files or from Hugo’s build 'n menu feature.\nOpt'n All configurat'n opt'ns 'n yer hugo.toml apply t' all menus but can be changed individually.\nFront Matter In case o' plank structure menus, individual configurat'n be done via a page’s front matter.\nMenu. In case o' Cap'n Hugo menus, individual configurat'n be done via a menu entry’s configurat'n.\nExpand State o' Submenus Opt'n Front Matter Ye can change how submenus appear wit' alwaysopen.\nMenu For Cap'n Hugo menus, ye have t' set params.alwaysopen instead.\nIf alwaysopen=false fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.\nTh' theme generates th' expand state based on th' follow'n rules:\nall parent entries o' th' active plank includ'n their vis'ble sibl'ns be shown regardless o' any sett'ns immediate child entries o' th' active entry be shown regardless o' any sett'ns if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries o' levels besides th' first behave like they would have been given alwaysopen=true all vis'ble entries show their immediate child entries if alwaysopen=true; this proceeds recursively all remain'n entries be not shown ​ toml yaml json alwaysopen = false alwaysopen: false { \"alwaysopen\": false } Expander fer Submenus Opt'n Front Matter Set collapsibleMenu=true t' show submenus as collaps'ble trees wit' a click'ble expander.\nMenu For Cap'n Hugo menus, ye have t' set params.collapsibleMenu=true instead.\n​ toml yaml json collapsibleMenu = true collapsibleMenu: true { \"collapsibleMenu\": true } Arrr Us'n this opt'n may cause degraded build performance by slow'n down yer build process.\nThis be usually th' case fer menus wit' many entries an' happens fer plank menus as well as fer Cap'n Hugo menus.\nWe’ve seen builds tak'n 2 minutes wit' 1000+ planks, an' over 30 minutes wit' 5000+ planks when us'n a plank menu.\nThis happens because each new plank affects all other planks, lead'n t' exponentially longer build times.\nOrder'n Menu Entries By Weight Front Matter Menu Cap'n Hugo provides a simple way t' handle order o' yer entries by sett'n th' weight front matter t' a number.\nCap'n Hugo menus can only be sorted us'n th' weight method.\n​ toml yaml json weight = 5 weight: 5 { \"weight\": 5 } By Other Us'n th' weight fer sort'n can get cumbersome if ye, fer example, just want t' sort alphabetically. Each time ye add a new plank 'n th' set o' planks, ye may have t' renumber some or all o' them t' make space fer th' new plank.\nOpt'n Front Matter Use ordersectionsby t' sort by other aspects. See th' children shortcode fer a complete list.\n​ toml yaml json ordersectionsby = 'linktitle' ordersectionsby: linktitle { \"ordersectionsby\": \"linktitle\" } Title fer Menu Entries Front Matter A page’s linkTitle or title front matter will be used fer nam'n a menu entry o' a plank menu, 'n that order if both be defined. Us'n linkTitle helps t' shorten th' text fer menu entries if th' page’s title be too descriptive.\nMenu A menu entry’s title or name will be used fer nam'n a menu entry o' a Cap'n Hugo menu, 'n that order if both be defined.\nFor example fer a plank named install/linux.md\n​ toml yaml json +++ linkTitle = 'Linux' title = 'Install on Linux' +++ --- linkTitle: Linux title: Install on Linux --- { \"linkTitle\": \"Linux\", \"title\": \"Install on Linux\" } Ay'cons fer Menu Entries Front Matter For plank menus, add a menuPre t' insert any HTML code before th' menu label. Ye can also set menuPost t' insert HTML code after th' menu label.\nMenu For Cap'n Hugo menus, add a pre t' insert any HTML code before th' menu label. Ye can also set post t' insert HTML code after th' menu label.\nIf pageRef be set fer th' menu entry an' no pre or post was configured, menuPre an' menuPost o' th' referenced plank will be taken.\nTh' example below uses th' GitHub ay'con fer an entry o' a plank menu.\n​ toml yaml json +++ menuPre = '\u003ci class=\"fab fa-github\"\u003e\u003c/i\u003e ' title = 'GitHub Repo' +++ --- menuPre: '\u003ci class=\"fab fa-github\"\u003e\u003c/i\u003e ' title: GitHub Repo --- { \"menuPre\": \"\\u003ci class=\\\"fab fa-github\\\"\\u003e\\u003c/i\\u003e \", \"title\": \"GitHub Repo\" } Dis'ble Menu Entries Ye may want t' structure yer entries 'n a hierarchical way but don’t want t' generate click'ble parent entries? Th' theme got ye covered.\nFor Plank Menus T' stay wit' th' initial example: Suppose ye want first-chapter/first-page appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should be expand'ble.\nFor this, open content/first-chapter/first-page/_index.md an' add th' follow'n front matter\n​ toml yaml json +++ [_build] render = 'never' +++ --- _build: render: never --- { \"_build\": { \"render\": \"never\" } } For Cap'n Hugo Menus Just don’t give yer parent menu entry configurat'n a url or pageRef. See th' next section fer a special case.\nIf ye want t' learn how t' configure different Cap'n Hugo menus fer each language, see th' official docs.\n​ toml yaml json +++ [menu] [[menu.addendum]] name = 'Parent 1' weight = 1 [[menu.addendum]] name = 'Child 1' parent = 'Parent 1' url = 'https://example.com/1' [[menu.addendum]] name = 'Parent 2' weight = 2 [[menu.addendum]] name = 'Child 2' parent = 'Parent 2' url = 'https://example.com/2' +++ --- menu: addendum: - name: Parent 1 weight: 1 - name: Child 1 parent: Parent 1 url: https://example.com/1 - name: Parent 2 weight: 2 - name: Child 2 parent: Parent 2 url: https://example.com/2 --- { \"menu\": { \"addendum\": [ { \"name\": \"Parent 1\", \"weight\": 1 }, { \"name\": \"Child 1\", \"parent\": \"Parent 1\", \"url\": \"https://example.com/1\" }, { \"name\": \"Parent 2\", \"weight\": 2 }, { \"name\": \"Child 2\", \"parent\": \"Parent 2\", \"url\": \"https://example.com/2\" } ] } } Title fer Menus Each menu may have an optional title above its tree. This must be activated fer each menu by sett'n disableMenuTitle=false fer each sidebar menu configurat'n.\nFront Matter For plank menus, set th' menuTitle front matter fer th' root plank o' th' menu. For example 'n th' home plank fer th' default sidebar menu. If no menuTitle was set, th' title will be taken from yer translat'n files by th' key \u003cidentifier\u003e-menuTitle, whar' \u003cidentifier\u003e be th' identifier o' yer sidebar menu configurat'n.\nMenu For Cap'n Hugo menus, th' title will be taken from yer translat'n files by th' key \u003cidentifier\u003e-menuTitle, whar' \u003cidentifier\u003e be th' identifier o' yer sidebar menu configurat'n.\nIf ye don’t want t' fiddle around wit' yer translat'n files, ye also have th' possibility t' let th' title be taken from th' menu definit'n. For that, define a nested menu that only has one top-level entry without url or pageRef.\nIn this case, th' title or name be taken fer th' menu head'n.\nIf ye want t' learn how t' configure different Cap'n Hugo menus fer each language, see th' official docs.\n​ toml yaml json +++ [menu] [[menu.addendum]] name = 'A Menu Title fer th' Whole Menu' [[menu.addendum]] name = 'A Menu Entry Title fer Child 1' parent = 'Parent' url = 'https://example.com/1' weight = 1 [[menu.addendum]] name = 'A Menu Entry Title fer Child 2' parent = 'Parent' url = 'https://example.com/2' weight = 2 +++ --- menu: addendum: - name: A Menu Title fer th' Whole Menu - name: A Menu Entry Title fer Child 1 parent: Parent url: https://example.com/1 weight: 1 - name: A Menu Entry Title fer Child 2 parent: Parent url: https://example.com/2 weight: 2 --- { \"menu\": { \"addendum\": [ { \"name\": \"A Menu Title fer th' Whole Menu\" }, { \"name\": \"A Menu Entry Title fer Child 1\", \"parent\": \"Parent\", \"url\": \"https://example.com/1\", \"weight\": 1 }, { \"name\": \"A Menu Entry Title fer Child 2\", \"parent\": \"Parent\", \"url\": \"https://example.com/2\", \"weight\": 2 } ] } } Title fer th' Predefined Shortcut Menu Opt'n By default, th' predefined shortcut menu has a th' title More (in th' English translation).\nYe can dis'ble this title wit' disableShortcutsTitle=true.\nhugo. toml yaml json [params] disableShortcutsTitle = true params: disableShortcutsTitle: true { \"params\": { \"disableShortcutsTitle\": true } } T' change th' title, override yer translat'n file.\n​ i18n/en.toml [shortcuts-menuTitle] other = \"Other Great Stuff\" Defin'n Sidebar Menus Opt'n Front Matter Menus be defined us'n th' sidebarmenus opt'n.\nYe can define as many menus, as ye like. If ye don’t overwrite this opt'n, th' theme defaults t'\n​ toml yaml json [[sidebarmenus]] disableTitle = true identifier = 'home' main = true pageRef = '' type = 'page' [[sidebarmenus]] disableTitle = false identifier = 'shortcuts' main = false type = 'menu' sidebarmenus: - disableTitle: true identifier: home main: true pageRef: \"\" type: plank - disableTitle: false identifier: shortcuts main: false type: menu { \"sidebarmenus\": [ { \"disableTitle\": true, \"identifier\": \"home\", \"main\": true, \"pageRef\": \"\", \"type\": \"page\" }, { \"disableTitle\": false, \"identifier\": \"shortcuts\", \"main\": false, \"type\": \"menu\" } ] } Parameter Name Default Notes type \u003cempty\u003e Th' type o' menu.\n- plank fer a plank menu\n- menu fer a Cap'n Hugo menu identifier \u003cempty\u003e A unique identifier fer this entry\n- fer type=page an arbitrary name\n- fer page=menu th' identifier o' th' menu definit'n 'n yer hugo.toml main see notes Whether t' add additional spac'n an' larger text t' th' menu\n- fer type=page defaults t' true\n- fer page=menu defaults t' false disableTitle see notes Whether t' print a title above th' menu\n- fer type=page defaults t' true\n- fer page=menu defaults t' false pageRef \u003cempty\u003e Only fer type=page, th' plank path t' start th' menu tree. If not set, defaults t' th' home plank. Redefin'n Sidebar Menus fer Certain Planks Suppose ye be build'n a ship that contains a topmost blog an' documentat'n section.\nWhen th' user be on one o' th' blog planks he should only see a menu contain'n all blog planks, while on a documentat'n plank he should only see a menu contain'n all doc planks.\nDirectory structure:\nrrrambl'n ├── blog │ ├── post-1.md │ ├── post-2.md │ ├── post-3.md │ └── _index_.md ├── docs │ ├── topic-1.md │ ├── topic-2.md │ ├── topic-3.md │ └── _index_.md └── _index.md Opt'n Front Matter Us'n Hugo’s cascade feature, we can redefine th' menus once 'n blog/_index.md an' docs/_index.md sett'n sidebarmenus so they will be used 'n all children planks.\nblog/_index.md toml yaml json +++ title = 'Blog' [[cascade]] [cascade.params] [[cascade.params.sidebarmenus]] identifier = 'blog' pageRef = '/blog' type = 'page' +++ --- cascade: - params: sidebarmenus: - identifier: blog pageRef: /blog type: plank title: Blog --- { \"cascade\": [ { \"params\": { \"sidebarmenus\": [ { \"identifier\": \"blog\", \"pageRef\": \"/blog\", \"type\": \"page\" } ] } } ], \"title\": \"Blog\" } docs/_index.md toml yaml json +++ title = 'Documentation' [[cascade]] [cascade.params] [[cascade.params.sidebarmenus]] identifier = 'docs' pageRef = '/docs' type = 'page' +++ --- cascade: - params: sidebarmenus: - identifier: docs pageRef: /docs type: plank title: Documentat'n --- { \"cascade\": [ { \"params\": { \"sidebarmenus\": [ { \"identifier\": \"docs\", \"pageRef\": \"/docs\", \"type\": \"page\" } ] } } ], \"title\": \"Documentation\" } Display'n Arbitrary Links 'n a Plank Menu Ye may have th' need t' add arbitrary links at some point 'n yer menu that be initially not backed by a plank. These be called crosslinks.\nAssume th' follow'n structure\nrrrambl'n ├── reference │ ├── ref-a.md │ ├── ref-b.md │ ├── ref-c.md │ └── _index_.md ├── topic-blue.md ├── topic-red.md ├── topic-yellow.md └── _index_.md Ye now want t' include ref-b as separate entry after topic-green 'n yer menu.\nFor that create a new plank wit' th' follow'n front matter\ncontent/topic-green.md toml yaml json +++ menuPageRef = '/reference/ref-b' title = 'Topic Green' +++ --- menuPageRef: /reference/ref-b title: Topic Green --- { \"menuPageRef\": \"/reference/ref-b\", \"title\": \"Topic Green\" } Front Matter If ye want t' link t' an external plank instead, ye can use menuUrl instead o' menuPageRef.\nPlanks defin'n a crosslink be never part o' th' arrow navigat'n an' be skipped instead.\nSo wit' th' above example an' alphabetical sort'n o' th' menu entries, press'n on topic-blue will skip th' newly added topic-green an' instead will board topic-red.\nHav'n sub planks below a plank that defines a crosslink be undefined.\nDisplay'n Planks Exclusively 'n a Cap'n Hugo Menu Sometimes ye want t' hide planks from th' plank menu but instead want t' show them 'n a Cap'n Hugo menu. For that ye have two choices\nCreate a headless branch bundle, _index.md 'n its own folder wit' th' below front matter. Th' branch bundle will not be contained 'n th' sitemap.\ncontent/showcase/_index.en.md 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\" } Or, put a child plank inside a headless branch bundle wit' th' follow'n front matter 'n th' bundle. This causes th' child but not th' branch bundle t' be contained 'n th' sitemap.\ncontent/more/_index.en.md toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } Th' child plank can be any type o' rrrambl'n.\ncontent/more/credits_index.en.md toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" }",
"description": "Configure all things menus",
"tags": [],
"title": "Menus",
"uri": "/hugo-theme-relearn/pir/configuration/sidebar/menus/index.html"
},
{
"breadcrumb": "",
"content": "Cap'n Hugo uses Marrrkdown as its rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well.\nYe could use pure HTML t' expand yer possibilities. But this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read. Ye should avoid HTML t' keep it as simple an' port'ble as poss'ble.\nT' avoid Markdown’s limitat'ns, Cap'n Hugo created shorrrtcodes. A shortcode be a simple snippet inside o' a plank.\nTh' Relearrrn theme provides many shorrrtcodes on top o' Hugo’s exist'n ones.\nBadgeMarker badges t' display 'n yer text\nButtonClick'ble buttons\nChildrenList th' child planks o' a plank\nExpandExpandable/collaps'ble sections o' text\nHighlightRender code wit' a rules highlighter\nAy'conNice ay'cons fer yer plank\nIncludeDisplays rrrambl'n from other files\nMathBeautiful math an' chemical formulae\nMerrrmaidGenerate diagrams an' flowcharts from text\nNoticeDisclaimers t' help ye structure yer plank\nOpenAPIUI fer yer OpenAPI / Swagger specificat'ns\nResourcesList resources contained 'n a plank bundle\nSiteParamGet value o' ship params\nTabShow rrrambl'n 'n a single tab\nTabsShow rrrambl'n 'n tabbed views",
"description": "Cap'n Hugo uses Marrrkdown as its rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well.",
"tags": [],
"title": "Shorrrtcodes",
"uri": "/hugo-theme-relearn/pir/shortcodes/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Brrrand'n",
"content": "This interactive tool may help ye t' generate yer own color variant stylesheet.\nShow usage instruct'ns T' get started, first select a color variant from th' variant selector 'n th' lower left sidebar that fits ye best as a start'n point.\nTh' graph be interactive an' reflects th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.\nTh' arrowed lines reflect how colors be inherited through different parts o' th' theme if th' descendant isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.\nT' better understand this, select th' neon variant an' modify th' different head'n colors. There, colors fer th' head'ns h2, h3 an' h4 be explicitly set. h5 be not set an' inherits its value from h4. h6 be also not set an' inherits its value from h5.\nOnce you’ve changed a color, th' variant selector will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can browse t' other planks an' even close th' browser without los'n yer changes.\nOnce ye be satisfied, ye can download th' new variants file an' copy it into yer site’s assets/css directory.\nOpt'n Afterwards, ye have t' adjust th' themeVariant opt'n 'n yer hugo.toml t' yer chosen file name. For example, if yer new variants file be named theme-my-custom-variant.css, ye have t' set themeVariant='my-custom-variant' t' use it.\nSee th' docs fer further configurat'n opt'ns.\nDownload variant Reset variant\nGraph Download variant Reset variant",
"description": "An interactive tool to generate color variant stylesheets",
"tags": [],
"title": "Stylesheet Generrrat'r",
"uri": "/hugo-theme-relearn/pir/configuration/branding/generator/index.html"
},
{
"breadcrumb": "Rambl'n \u003e Front Matter",
"content": "This plank be about how t' configure th' topbar us'n configurat'n opt'ns. If ye want t' add further buttons or functionality, see this section.\nYer topbar contains th' follow'n elements. Some o' them be configuar'ble:\nsidebar: opens th' sidebar flyout if 'n mobile layout toc: opens th' t'ble o' contents 'n an overlay breadcrumb: shows th' click'ble breadcrumbs edit: browses t' th' edit'ble plank if th' editURL parameter be set print: browses t' th' chapters print'ble plank if print support was activated prev: browses t' th' previous plank if there be one next: browses t' th' next plank if there be one more: opens th' overlay if screen space be limited T'ble o' Contents Opt'n Front Matter Set disableToc=true t' hide th' TOC button on all planks. If th' button be hidden, also th' keyboard shortcut be disabled. This can be overridden 'n a page’s front matter.\n​ toml yaml json disableToc = true disableToc: true { \"disableToc\": true } Breadcrumbs Opt'n Front Matter Set disableBreadcrumb=true t' hide th' breadcrumb 'n th' topbar.\nFurther breadcrumbs sett'ns can be found 'n th' rrrambl'n configurat'n section.\n​ toml yaml json disableBreadcrumb = true disableBreadcrumb: true { \"disableBreadcrumb\": true } Edit Button Opt'n Front Matter If editURL be set t' a URL, an edit button will be shown 'n th' topbar. If th' button be hidden, also th' keyboard shortcut be disabled.\nTh' value can contain th' macro ${FilePath} which will be replaced by th' file path o' yer displayed plank. If no ${FilePath} be given 'n th' value, th' value be treated as if th' ${FilePath} was appended at th' end o' th' value. This can be overridden 'n th' planks front matter.\n​ toml yaml json editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' editURL: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath} { \"editURL\": \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\" } Arrow Navigat'n Opt'n Front Matter Ye can hide th' previous/next buttons by sett'n disableNextPrev=true. If th' buttons be hidden, also th' keyboard shortcuts be disabled.\n​ toml yaml json disableNextPrev = true disableNextPrev: true { \"disableNextPrev\": true }",
"description": "Configure the topbar",
"tags": [],
"title": "Topbarrr",
"uri": "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Customization",
"content": "Th' theme comes wit' a reasonably configured topbar. Ye can learn how t' configure th' defaults 'n this section.\nNevertheless, yer requirements may differ from this configurat'n. Luckily, th' theme has ye covered as th' topbar, its buttons, an' th' functionality behind these buttons be fully configur'ble by ye.\nSmarrrt Arrrse All mentioned file names below can be clicked an' show ye th' implementat'n fer a better understand'n.\nAreas Th' default configurat'n comes wit' three predefined areas that may contain an arbitrary set o' buttons.\nstart: shown between menu an' breadcrumb end: shown on th' opposite breadcrumb side 'n comparison t' th' start area more: shown when press'n th' more button 'n th' topbar While ye cannot add additional areas 'n th' topbar, ye be free t' configure additional buttons that behave like th' more button, provid'n further user-defined areas.\nButtons Th' theme ships wit' th' follow'n predefined buttons (from left t' right 'n th' screenshot):\nsidebar: opens th' sidebar flyout if 'n mobile layout toc: opens th' t'ble o' contents 'n an overlay edit: browses t' th' edit'ble plank if th' editURL parameter be set print: browses t' th' chapter’s print'ble plank if print support was activated prev: browses t' th' previous plank if there be one next: browses t' th' [next page]authoring/frontmatter/topbar(#arrow-navigation) if there be one more: opens th' overlay fer th' more area Not all buttons be displayed at every given time. This be configur'ble (see below if interested).\nRedefin'n Areas Each predefined area an' button comes 'n its own file. By that, it be easy fer ye t' overwrite an area file 'n yer installat'n, reus'n only th' buttons ye like.\nE.g., ye can redefine th' predefined end area by add'n th' file layouts/partials/topbar/area/end.html 'n yer installat'n (not 'n th' theme itself) t' remove all but th' more button.\nTh' below example sets an explicit value fer th' onempty parameter, overrid'n th' specific default value fer this button (these defaults vary depend'n on th' button). Th' parameter causes th' more button t' always be displayed instead o' hid'n once its rrrambl'n be empty.\n{{ partial \"topbar/button/more.html\" (dict \"page\" . \"onempty\" \"disable\" )}} Defin'n Own Buttons Button Types Th' theme distinguishes between two types o' buttons:\nbutton: a click'ble button that either browses t' another ship, triggers a user-defined script or opens an overlay contain'n user-defined rrrambl'n area-button: th' template fer th' more button, t' define yer own area overlay buttons Button Parameter Screen Widths an' Act'ns Depend'n on th' screen width, ye can configure how th' button should behave. Screen width be divided into three classes:\ns: (controlled by th' onwidths parameter) mobile layout whar' th' menu sidebar be hidden m: (controlled by th' onwidthm parameter) desktop layout wit' vis'ble sidebar while th' rrrambl'n area width still resizes l: (controlled by th' onwidthl parameter) desktop layout wit' vis'ble sidebar once th' rrrambl'n area reached its maximum width For each width class, ye can configure one o' th' follow'n act'ns:\nshow: th' button be displayed 'n its given area hide: th' button be removed area-XXX: th' button be moved from its given area into th' area XXX; fer example, this be used t' move buttons t' th' more area overlay 'n th' mobile layout Hid'n an' Disabl'n Stuff While hid'n a button depend'n on th' screen size can be configured wit' th' above-described hide act'n, ye may want t' hide th' button on certain other condit'ns as well.\nFor example, th' print button 'n its default configurat'n should only be displayed if print support was configured. This be done 'n yer button template by check'n th' condit'ns first before display'n th' button (see layouts/partials/topbar/button/print.html).\nAnother preferred condit'n fer hid'n a button be if th' displayed overlay be empty. This be th' case fer th' toc (see layouts/partials/topbar/button/toc.html) as well as th' more button (see layouts/partials/topbar/button/more.html) an' controlled by th' parameter onempty.\nThis parameter can have one o' th' follow'n values:\ndis'ble: th' button be displayed 'n a disabled state if th' overlay be empty hide: th' button be removed if th' overlay be empty If ye want t' dis'ble a button contain'n no overlay, this can be achieved by an empty href parameter. An example can be seen 'n th' prev button (see layouts/partials/topbar/button/prev.html) whar' th' URL fer th' previous ship may be empty.\nReference Button Contains th' basic button functionality an' be used as a base implementat'n fer all other buttons (layouts/partials/topbar/func/button.html).\nCall this from yer own button templates if ye want t' implement a button without an overlay like th' print button (layouts/partials/topbar/button/print.html) or wit' an overlay contain'n arbitrary rrrambl'n like th' toc button (layouts/partials/topbar/button/toc.html).\nFor display'n an area 'n th' button’s overlay, see Area-Button.\nParameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. class \u003cempty\u003e Mandatory unique class name fer this button. Display'n two buttons wit' th' same value fer class be undefined. href \u003cempty\u003e Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click.\n- If start'n wit' javascript: all follow'n text will be executed 'n yer browser\n- Every other str'n will be interpreted as URL\n- If empty, th' button will be displayed 'n a disabled state regardless o' its rrrambl'n ay'con \u003cempty\u003e Font Awesome ay'con name. onempty dis'ble Defines what t' do wit' th' button if th' rrrambl'n parameter was set but ends up empty:\n- dis'ble: Th' button be displayed 'n a disabled state.\n- hide: Th' button be removed. onwidths show Th' act'n that should be executed if th' ship be displayed 'n th' given width:\n- show: Th' button be displayed 'n its given area\n- hide: Th' button be removed.\n- area-XXX: Th' button be moved from its given area into th' area XXX. onwidthm show See above. onwidthl show See above. hint \u003cempty\u003e Arbitrary text displayed 'n th' tooltip. title \u003cempty\u003e Arbitrary text fer th' button. rrrambl'n \u003cempty\u003e Arbitrary HTML t' put into th' rrrambl'n overlay. This parameter may be empty. In this case, no overlay will be generated. Area-Button Contains th' basic functionality t' display area overlay buttons (layouts/partials/topbar/func/area-button.html).\nCall this from yer own button templates if ye want t' implement a button wit' an area overlay like th' more button (layouts/partials/topbar/button/more.html).\nParameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. area \u003cempty\u003e Mandatory unique area name fer this area. Display'n two areas wit' th' same value fer area be undefined. ay'con \u003cempty\u003e Font Awesome ay'con name. onempty dis'ble Defines what t' do wit' th' button if th' rrrambl'n overlay be empty:\n- dis'ble: Th' button be displayed 'n a disabled state.\n- hide: Th' button be removed. onwidths show Th' act'n that should be executed if th' ship be displayed 'n th' given width:\n- show: Th' button be displayed 'n its given area\n- hide: Th' button be removed.\n- area-XXX: Th' button be moved from its given area into th' area XXX. onwidthm show See above. onwidthl show See above. hint \u003cempty\u003e Arbitrary text displayed 'n th' tooltip. title \u003cempty\u003e Arbitrary text fer th' button. Predefined Buttons Th' predefined buttons by th' theme (all other buttons besides th' more an' toc button 'n layouts/partials/topbar/button).\nCall these from yer own redefined area templates if ye want t' use default button behavior.\nTh' \u003cvarying\u003e parameter values be different fer each button an' configured fer standard behavior as seen on this plank.\nParameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. onwidths \u003cvarying\u003e Th' act'n that should be executed if th' ship be displayed 'n th' given width:\n- show: Th' button be displayed 'n its given area\n- hide: Th' button be removed.\n- area-XXX: Th' button be moved from its given area into th' area XXX. onwidthm \u003cvarying\u003e See above. onwidthl \u003cvarying\u003e See above. Predefined Overlay-Buttons Th' predefined buttons by th' theme that open an overlay (the more an' toc button 'n layouts/partials/topbar/button).\nCall these from yer own redefined area templates if ye want t' use default button behavior utiliz'n overlay functionality.\nTh' \u003cvarying\u003e parameter values be different fer each button an' configured fer standard behavior as seen on this plank.\nParameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. onempty dis'ble Defines what t' do wit' th' button if th' rrrambl'n overlay be empty:\n- dis'ble: Th' button be displayed 'n a disabled state.\n- hide: Th' button be removed. onwidths \u003cvarying\u003e Th' act'n that should be executed if th' ship be displayed 'n th' given width:\n- show: Th' button be displayed 'n its given area\n- hide: Th' button be removed.\n- area-XXX: Th' button be moved from its given area into th' area XXX. onwidthm \u003cvarying\u003e See above. onwidthl \u003cvarying\u003e See above.",
"description": "How to extend the topbar",
"tags": [],
"title": "Topbarrr",
"uri": "/hugo-theme-relearn/pir/configuration/customization/topbar/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Site Management",
"content": "Print Support En'ble print support t' print entire chapters or th' whole ship. Add th' print output format t' yer home, section, an' plank 'n hugo.toml:\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'print'] plank = ['html', 'rss', 'print'] section = ['html', 'rss', 'print'] outputs: home: - html - rss - print plank: - html - rss - print section: - html - rss - print { \"outputs\": { \"home\": [ \"html\", \"rss\", \"print\" ], \"page\": [ \"html\", \"rss\", \"print\" ], \"section\": [ \"html\", \"rss\", \"print\" ] } } This adds a printer ay'con 'n th' topbar. Click'n it switches t' print preview, show'n th' plank an' its vis'ble subpages 'n a printer-friendly format. Use yer browser’s print funct'n t' print or save as PDF.\nTh' URL won’t be configured ugly fer Hugo’s URL handl'n, even wit' uglyURLs=true 'n hugo.toml. This be because each mime type can only have one suffix.\nIf ye don’t like th' URLs, ye can reconfigure outputFormats.print 'n yer hugo.toml t' someth'n other than th' default o':\nhugo. toml yaml json [outputFormats] [outputFormats.print] baseName = 'index.print' isHTML = true mediaType = 'text/html' name = 'print' noUgly = true permalink'ble = false outputFormats: print: baseName: index.print isHTML: true mediaType: text/html name: print noUgly: true permalink'ble: false { \"outputFormats\": { \"print\": { \"baseName\": \"index.print\", \"isHTML\": true, \"mediaType\": \"text/html\", \"name\": \"print\", \"noUgly\": true, \"permalinkable\": false } } }",
"description": "What other formats can a page be displayed in",
"tags": [],
"title": "Available Output Formats",
"uri": "/hugo-theme-relearn/pir/configuration/sitemanagement/outputformats/index.html"
},
{
"breadcrumb": "Configurrrat'n",
"content": "PartialsModify'n partials t' yer needs\nExtend'n ScriptsAdd further code t' yer ship\nImage EffectsHow t' extend image effects\nTopbarHow t' extend th' topbar\nPlank DesignsExtend'n plank designs\nOutput FormatsAdd'n Custom Output Formats\nTaxonomiesHow t' display custom taxonomies on yer planks",
"description": "Customize files for advanced usage",
"tags": [],
"title": "Customization",
"uri": "/hugo-theme-relearn/pir/configuration/customization/index.html"
},
{
"breadcrumb": "",
"content": "This chapter contains informat'n only needed fer development an' maintain'n th' theme.\nContribut'nWhat t' know if ye want t' contribute\nMaintain'nWhat t' know as a maintainer\nScreenshotsRecipe t' create various documentat'n screenshots",
"description": "This chapter contains informat'n only needed fer development an' maintain'n th' theme.",
"tags": [],
"title": "Development",
"uri": "/hugo-theme-relearn/pir/development/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Content",
"content": "This theme allows ye t' create hidden planks.\nHidden planks be created but not shown 'n th' navigat'n. This be useful fer planks ye only want t' access via a direct link.\nWhen ye visit a hidden page’s URL, it will appear 'n th' navigat'n menu.\nHidden planks can also have hidden subpages, creat'n multiple levels o' hid'n.\nBy default, hidden planks be only hidden from human visitors. Search engines can still find them by crawl'n yer ship an' th' planks be linked 'n yer taxonomies an' ship search. Ye can prevent this wit' these opt'ns.\nHide from Search Opt'n T' remove hidden planks from search results, use disableSearchHiddenPages=true.\nhugo. toml yaml json [params] disableSearchHiddenPages = true params: disableSearchHiddenPages: true { \"params\": { \"disableSearchHiddenPages\": true } } Hide from Search Engines Opt'n T' hide planks from search engines by remov'n them from th' sitemap, RSS feed an' make them nofollow, use disableSeoHiddenPages=true.\nhugo. toml yaml json [params] disableSeoHiddenPages = true params: disableSeoHiddenPages: true { \"params\": { \"disableSeoHiddenPages\": true } } Hide from Taxonomies Opt'n T' prevent hidden planks from appear'n on taxonomy an' term planks, use disableTagHiddenPages=true. If this makes a term’s count zero, an empty term plank will still be created but not linked.\nhugo. toml yaml json [params] disableTagHiddenPages = true params: disableTagHiddenPages: true { \"params\": { \"disableTagHiddenPages\": true } }",
"description": "Learn about the hidden pages feature",
"tags": [],
"title": "Hidden Pages",
"uri": "/hugo-theme-relearn/pir/configuration/content/hidden/index.html"
},
{
"breadcrumb": "Rambl'n",
"content": "Th' theme offers graphical effects fer yer linked images.\nYe can define additional custom image effects an' set defaults 'n yer configurat'n.\nTh' default image effects shipped wit' th' theme be\nName Descript'n border Draws a light thin border around th' image lazy Lets th' image be lazy boarded lightbox Th' image will be click'ble t' show it enlarged shadow Draws a shadow around th' image t' make it appear hovered/glow'n One way t' use them be t' add them as URL query parameter t' each individually linked image.\nThis can become cumbersome t' be done consistently fer th' whole ship. Instead, ye can configure th' defaults 'n yer hugo.toml as well as overrid'n these defaults 'n a page’s front matter.\nExplicitly set URL query parameter will override th' defaults set fer a plank or yer ship.\nWithout any sett'ns 'n yer hugo.toml imageEffects defaults t'\n​ toml yaml json [imageEffects] border = false lazy = true lightbox = true shadow = false imageEffects: border: false lazy: true lightbox: true shadow: false { \"imageEffects\": { \"border\": false, \"lazy\": true, \"lightbox\": true, \"shadow\": false } } Front Matter This can be overridden 'n a planks front matter fer example by\n​ toml yaml json +++ [imageEffects] lazy = false +++ --- imageEffects: lazy: false --- { \"imageEffects\": { \"lazy\": false } } Or by explicitly override sett'ns by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lazy=true\u0026lightbox=false) Th' sett'ns applied t' th' above image would be\n​ toml yaml json border = true lazy = true lightbox = false shadow = false border: true lazy: true lightbox: false shadow: false { \"border\": true, \"lazy\": true, \"lightbox\": false, \"shadow\": false }",
"description": "How to apply graphical effects to your images",
"tags": [],
"title": "Image Effects",
"uri": "/hugo-theme-relearn/pir/authoring/imageeffects/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Customization",
"content": "A plank be displayed by exactly one plank design. Th' Relearrrn theme offers th' plank designs home, chapter, an' default.\nA plank design usually consists o'\nan archetype file: a template fer creat'n new Marrrkdown files wit' this design rrrambl'n view files: represented by Hugo’s reserved type front matter an' backed by match'n partials CSS styles If no type be set 'n yer front matter, th' plank be treated as if type='default' was set.\nArrr Don’t use th' type opt'n 'n yer modificat'ns fer other functionality!\nAll shipped designs use th' theme’s framework from themes/hugo-theme-learn/layouts/_default/baseof.html, contain'n o' th' same topbar an' sidebar but can change how rrrambl'n appears 'n th' center o' th' plank.\nUs'n a Plank Design Regardless o' shipped or custom plank design, ye be us'n them 'n th' same way.\nCreat'n a Plank Designs T' make a custom plank design:\nChoose a name (for example, mydesign)\nCreate a rrrambl'n view file at layouts/mydesign/views/article.html\n​ layouts/mydesign/views/article.html \u003carticle class=\"mydesign\"\u003e \u003cheader class=\"headline\"\u003e {{ partial \"content-header.html\" . }} \u003c/header\u003e \u003cdiv class=\"article-subheading\"\u003eAWESOME\u003c/div\u003e {{ partial \"heading-pre.html\" . }}{{ partial \"head'n.html\" . }}{{ partial \"heading-post.html\" . }} {{ partial \"article-content.html\" . }} \u003cfooter class=\"footline\"\u003e {{ partial \"content-footer.html\" . }} \u003c/footer\u003e \u003c/article\u003e In this file, ye can cust'mize th' plank design as needed. Typically, you’ll want t':\nSet a class at th' article element fer custom CSS styles Use {{ partial \"article-content.html\" . }} t' show yer plank rrrambl'n Create an archetype file at archetypes/mydesign.md (optional)\n​ archetypes/mydesign.md +++ title = \"{{ replace .Name \"-\" \" \" | title }}\" type = \"mydesign\" +++ This be my new design. Add CSS 'n file layouts/partials/custom-header.html (optional)\n​ layouts/partials/custom-header.html \u003cstyle\u003e .mydesign .article-subhead'n { font-size: 72rem; } .mydesign a { background-color: pink; } \u003c/style\u003e Partials Th' above example uses layouts/mydesign/views/article.html but ye have some others\nlayouts/mydesign/baseof.html: Completely redefine th' whole HTML structure, none o' th' other listed partials will be used layouts/mydesign/views/menu.html: Defines th' sidebar menu layout layouts/mydesign/views/body.html: Determines what t' contain 'n th' rrrambl'n area (for example a single plank, a list o' planks, a tree o' sub pages) layouts/mydesign/views/article.html: Controls how one page’s rrrambl'n an' title be displayed",
"description": "Using and extending page designs",
"tags": [],
"title": "Page Designs",
"uri": "/hugo-theme-relearn/pir/configuration/customization/designs/index.html"
},
{
"breadcrumb": "Rambl'n \u003e Front Matter",
"content": "Every Cap'n Hugo plank must have front matter.\nIn addit'n t' Hugo’s standard front matter, th' Relearrrn theme offers extras sett'ns listed here.\nThroughout th' documentat'n, theme-specific front matter be marked wit' a Front Matter badge.\nAdd theme front matter directly t' th' root o' yer page’s front matter. For example:\n​ toml yaml json +++ math = true +++ --- math: true --- { \"math\": true } Index A Alwaysopen (1) C CollapsibleMenu (1) CustomMathJaxURL (1) CustomMermaidURL (1) CustomOpenapiURL (1) D Descript'n (1) DisableBreadcrumb (1) DisableNextPrev (1) DisableToc (1) E EditURL (1) ExternalLinkTarget (1) H HeadingPost (1) HeadingPre (1) Hidden (1) HighlightWrap (1) I Image.errorlevel (1) ImageEffects (1) Include.errorlevel (1) L LastModifierDisplayName (1) LastModifierEmail (1) Link.errorlevel (1) LinkTitle (1) M Math (1) Math.force (1) MathJaxInitialize (1) MenuPageRef (1) MenuPost (1) MenuPre (1) MenuUrl (1) Merrrmaid.force (1) MermaidInitialize (1) MermaidZoom (1) O Openapi.errorlevel (1) Openapi.force (1) Ordersectionsby (2) S Sidebarmenus (1) All Front Matter Here’s a list o' all avail'ble front matter wit' example values. Default values be described 'n th' annotated example below or 'n each front matter’s documentat'n.\n​ toml yaml json +++ LastModifierDisplayName = '' LastModifierEmail = '' alwaysopen = '' collapsibleMenu = true customMathJaxURL = '' customMermaidURL = '' customOpenapiURL = '' descript'n = '' disableBreadcrumb = false disableNextPrev = false disableToc = false editURL = '' externalLinkTarget = '_self' headingPost = '' headingPre = '' hidden = false highlightWrap = true images = ['images/hero.png'] linkTitle = '' math = false mathJaxInitialize = '{}' menuPageRef = '' menuPost = '' menuPre = '' menuUrl = '' mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidZoom = true ordersectionsby = 'weight' title = 'Example Page' type = '' [image] errorlevel = '' [imageEffects] border = true lazy = true lightbox = true shadow = false [include] errorlevel = '' [link] errorlevel = '' [mermaid] force = false [openapi] errorlevel = '' [oppenapi] force = false [[sidebarmenus]] disableTitle = true identifier = 'home' main = true pageRef = '' type = 'page' [[sidebarmenus]] disableTitle = false identifier = 'shortcuts' main = false type = 'menu' +++ --- LastModifierDisplayName: \"\" LastModifierEmail: \"\" alwaysopen: \"\" collapsibleMenu: true customMathJaxURL: \"\" customMermaidURL: \"\" customOpenapiURL: \"\" descript'n: \"\" disableBreadcrumb: false disableNextPrev: false disableToc: false editURL: \"\" externalLinkTarget: _self headingPost: \"\" headingPre: \"\" hidden: false highlightWrap: true image: errorlevel: \"\" imageEffects: border: true lazy: true lightbox: true shadow: false images: - images/hero.png include: errorlevel: \"\" link: errorlevel: \"\" linkTitle: \"\" math: false mathJaxInitialize: '{}' menuPageRef: \"\" menuPost: \"\" menuPre: \"\" menuUrl: \"\" mermaid: force: false mermaidInitialize: '{ \"securityLevel\": \"loose\" }' mermaidZoom: true openapi: errorlevel: \"\" oppenapi: force: false ordersectionsby: weight sidebarmenus: - disableTitle: true identifier: home main: true pageRef: \"\" type: plank - disableTitle: false identifier: shortcuts main: false type: menu title: Example Plank type: \"\" --- { \"LastModifierDisplayName\": \"\", \"LastModifierEmail\": \"\", \"alwaysopen\": \"\", \"collapsibleMenu\": true, \"customMathJaxURL\": \"\", \"customMermaidURL\": \"\", \"customOpenapiURL\": \"\", \"description\": \"\", \"disableBreadcrumb\": false, \"disableNextPrev\": false, \"disableToc\": false, \"editURL\": \"\", \"externalLinkTarget\": \"_self\", \"headingPost\": \"\", \"headingPre\": \"\", \"hidden\": false, \"highlightWrap\": true, \"image\": { \"errorlevel\": \"\" }, \"imageEffects\": { \"border\": true, \"lazy\": true, \"lightbox\": true, \"shadow\": false }, \"images\": [ \"images/hero.png\" ], \"include\": { \"errorlevel\": \"\" }, \"link\": { \"errorlevel\": \"\" }, \"linkTitle\": \"\", \"math\": false, \"mathJaxInitialize\": \"{}\", \"menuPageRef\": \"\", \"menuPost\": \"\", \"menuPre\": \"\", \"menuUrl\": \"\", \"mermaid\": { \"force\": false }, \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\", \"mermaidZoom\": true, \"openapi\": { \"errorlevel\": \"\" }, \"oppenapi\": { \"force\": false }, \"ordersectionsby\": \"weight\", \"sidebarmenus\": [ { \"disableTitle\": true, \"identifier\": \"home\", \"main\": true, \"pageRef\": \"\", \"type\": \"page\" }, { \"disableTitle\": false, \"identifier\": \"shortcuts\", \"main\": false, \"type\": \"menu\" } ], \"title\": \"Example Page\", \"type\": \"\" } Annotated Front Matter ​ toml +++ # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by giv'n it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes as well. # Th' social media image o' yer plank. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # If not set, th' set value o' yer site's hugo.toml be used. images = [ 'images/hero.png' ] # Th' title o' yer plank. # Default: not set # A plank without a title be treated as a hidden plank. title = 'Example Page' # Th' descript'n o' yer plank. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # If not set, th' set value o' yer site's hugo.toml be used fer th' html # meta tag, social media meta informat'n fer th' opengraph protocol an' # twitter cards. descript'n = '' # Th' plank design t' be used # Default: not set # This decides th' layout o' yer plank. Th' theme ships 'home', 'chapter' an' # 'default'. If not set, 'default' be taken. type = '' ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # If not set, th' set value o' yer site's hugo.toml be used. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false # Th' URL prefix t' edit a plank. # Default: not set # If set, an edit button will be shown 'n th' topbar. If th' button be hidden, # also th' keyboard shortcuts be disabled. Th' value can contain th' macro # `${FilePath}` which will be replaced by th' file path o' yer displayed plank. # If not set, th' set value o' yer site's hugo.toml be used. If th' global # parameter be given but ye want t' hide th' button fer th' displayed plank, # ye can set th' value t' an empty str'n. If instead o' hid'n ye want t' have # an disabled button, ye can set th' value t' a str'n contain'n just spaces. # This be useful if ye want t' give th' opportunity fer people t' create merge # request fer yer rrrambl'n. editURL = '' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu appearance. # Menu specific title # Default: not set # Th' title displayed 'n th' menu. If not set th' `title` front matter will # be used. linkTitle = '' # Prefix fer th' title 'n navigat'n menu. # Default: not set # Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n. menuPre = '' # Suffix fer th' title 'n navigat'n menu. # Default: not set # Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n. menuPost = '' # Link th' menu entry t' a different internal plank instead. # Default: not set # This will effectivly hide th' plank an' its rrrambl'n from th' viewer by # link'n t' th' given URL instead. menuPageRef = '' # Link th' menu entry t' an external URL instead o' a plank. # Default: not set # This will effectivly hide th' plank an' its rrrambl'n from th' viewer by # link'n t' th' given URL instead. menuUrl = '' # Th' order o' navigat'n menu submenus. # Default: 'weight' # Submenus can be ordered by 'weight', 'title', 'linktitle', 'modifieddate', # 'expirydate', 'publishdate', 'date', 'length' or 'default' (adher'n t' # Hugo's default sort order). # If not set, th' value o' th' parent menu entry be used. ordersectionsby = 'weight' # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. If not set, th' value o' th' parent menu entry be used. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = '' # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. # If not set, th' set value o' yer site's hugo.toml be used. collapsibleMenu = true # Define yer own sidebar menus. # Default: th' value used below # Th' sidebar menus be built from this parameter. If not set, th' set value # o' yer site's hugo.toml be used an' contains th' below default. # Menus be written from th' sidebar's top t' buttom 'n th' order given 'n # this array. # Each entry can contain th' follow'n keys: # - `type` be mandatory. Either `page` 'n case it should generate a tre from # th' plank structure or `menu` 'n case it should generate a tree from a # defined menu. # - `identifier` be mandatory. In case o' `type=page`, anyth'n can be used, # 'n case o' `type=menu` th' `identifier` key must be identical t' th' # key o' th' menu definit'n. # - `main`, boolean. If `true`, th' first tree level be spaced more generous # an' th' text be emphasized. Default: `true` fer `type=page` an' `false` # fer `type=menu` # - `disableTitle`, boolean. If `true`, there be no title above th' tree. # Default: `true` fer `type=page` an' `false` fer `type=menu`. If a title # should be used, 'n case o' `type=page` it will be taken from th' page's # `menuTitle` front matter an' if not set, from th' translat'n files, us'n # th' menu `identifier` as key. In case o' `type=menu` it will be taken # from th' menu `title` accord'n t' Hugo's documentat'n an' if not set # from th' menu `name` an' if this be not set form th' page's `linkTitle`. # - `pageRef`, optional. In case o' `type=page` this be th' start'n page's # path. If not set, th' home plank will be used. sidebarmenus = [ { type = 'page', identifier = 'home', main = true, disableTitle = true, pageRef = '' }, { type = 'menu', identifier = 'shortcuts', main = false, disableTitle = false }, ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' navigat'n menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide a page's menu entry. # Default: false # If this value be true, th' plank be hidden from th' menu. hidden = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Prefix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n. headingPre = '' # Suffix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be suffixed by this HTML rrrambl'n. headingPost = '' # Display name o' th' page's last editor. # Default: not set # If set, it will be displayed 'n th' default footer. LastModifierDisplayName = '' # Email address o' th' page's last editor. # Default: not set # If set together wit' LastModifierDisplayName, it will be displayed 'n th' # default footer. LastModifierEmail = '' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # If not set, th' set value o' yer site's hugo.toml be used or given as a # parameter t' individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Include # These opt'ns configure how th' include shortcode works. # What t' do when path be not resolved. # Default: '' # Ye can control what should happen if a path can not be resolved t' as # a resource or via th' file system. If not set, no output will be written # fer th' unresolved path. If set t' `warning` th' same happens an' an additional # warning be printed. If set t' `error` an error message be printed an' th' build # be aborted. # If not set, th' set value o' yer site's hugo.toml be used. include.errorlevel = '' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # What t' do when local image link be not resolved. # Default: '' # Ye can control what should happen if a local image can not be resolved t' as # a resource. If not set, th' unresolved link be written as given into th' result'n # output. If set t' `warning` th' same happens an' an additional warning be # printed. If set t' `error` an error message be printed an' th' build be # aborted. # Please note that this can not resolve files inside o' yer `static` directory. # If not set, th' set value o' yer site's hugo.toml be used. image.errorlevel = '' # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effect values default t' th' values o' yer site's hugo.toml an' can be # overridden through URL parameter given t' th' image. See th' documentat'n fer # details. # Default: false imageEffects.border = true # Default: true imageEffects.lazy = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These opt'ns configure how links be displayed. # What t' do when local plank link be not resolved. # Default: '' # Ye can control what should happen if a local link can not be resolved t' a # plank. If not set, th' unresolved link be written as given into th' result'n # output. If set t' `warning` th' same happens an' an additional warning be # printed. If set t' `error` an error message be printed an' th' build be # aborted. # Please note that wit' Cap'n Hugo \u003c 0.123.0 + `uglyURLs=true` this can lead t' false # negatives. # If not set, th' set value o' yer site's hugo.toml be used. link.errorlevel = '' # How t' open external links. # Default: '_blank' # For external links ye can define how they be opened 'n yer browser. All # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th' # default value opens external links 'n a separate browser tab. If ye want # t' open those links 'n th' same tab, use '_self'. # If not set, th' set value o' yer site's hugo.toml be used. externalLinkTarget = '_self' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's hugo.toml be used. mathJaxInitialize = '{}' # Force board Math on every plank. # Default: false # If a, Math shortcode or codefence be found, th' opt'n will be ignored an' # Math will be boarded regardlessly. This opt'n be useful 'n case ye # be us'n passthrough configurat'n t' render yer math. In this case no shortcode or # codefence be involved an' th' library be not boarded by default so ye can # force load'n it by sett'n `math=true`. # This opt'n has an alias `math.force`. # If not set, th' set value o' yer site's hugo.toml be used. math = false # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's hugo.toml be used. customMathJaxURL = '' # 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # If not set, th' set value o' yer site's hugo.toml be used or given as a # parameter t' individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's hugo.toml be used. mermaidInitialize = '{ \"securityLevel\": \"loose\" }' # Force board Merrrmaid on every plank. # Default: false # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. This opt'n be useful 'n case ye # be us'n script'n t' render yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default so ye can # force load'n it by sett'n `mermaid.force=true`. # If not set, th' set value o' yer site's hugo.toml be used. mermaid.force = false # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's hugo.toml be used. customMermaidURL = '' # 'https://unpkg.com/mermaid/dist/mermaid.min.js' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Board OpenAPI on every plank. # Default: false # If a, OpenAPI shortcode or codefence be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. This opt'n be useful 'n case ye # be us'n script'n t' render yer spec. In this case no shortcode or # codefence be involved an' th' library be not boarded by default so ye can # force load'n it by sett'n `openapi.force=true`. # If not set, th' set value o' yer site's hugo.toml be used. oppenapi.force = false # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's hugo.toml be used. customOpenapiURL = '' # 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js' # What t' do when a local OpenAPI spec link be not resolved. # Default: '' # Ye can control what should happen if a local OpenAPI spec link can not be resolved # t' a resource. If not set, th' unresolved link be written as given into th' result'n # output. If set t' `warning` th' same happens an' an additional warning be # printed. If set t' `error` an error message be printed an' th' build be # aborted. # Please note that this can not resolve files inside o' yer `static` directory. # If not set, th' set value o' yer site's hugo.toml be used. openapi.errorlevel = '' +++",
"description": "All front matter for the Relearn theme",
"tags": [],
"title": "Front Matter Reference",
"uri": "/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.html"
},
{
"breadcrumb": "Configurrrat'n",
"content": "This plank explains how t' configure th' Relearrrn theme 'n yer hugo.toml file.\nIn addit'n t' Hugo’s standard opt'ns, th' Relearrrn theme offers extra sett'ns listed here.\nThroughout th' documentat'n, theme-specific opt'ns be marked wit' a Opt'n badge.\nAdd theme opt'ns t' th' params section o' yer hugo.toml. For example:\nhugo. toml yaml json [params] math = true params: math: true { \"params\": { \"math\": true } } Index A AdditionalContentLanguage (1) Alwaysopen (1) Author.email (1) Author.name (1) B BoxStyle (1) BreadcrumbSeparator (1) C CollapsibleMenu (1) CustomMathJaxURL (1) CustomMermaidURL (1) CustomOpenapiURL (1) D DisableAnchorCopy (1) DisableAnchorScroll'n (1) DisableAssetsBust'n (1) DisableBreadcrumb (1) DisableDefaultRelref (1) DisableExplicitIndexURLs (1) DisableGeneratorVersion (1) DisableHoverBlockCopyToClipBoard (1) DisableInlineCopyToClipBoard (1) DisableLandingPageButton (1) DisableLanguageSwitchingButton (1) DisableNextPrev (1) DisableRandomIds (1) DisableRootBreadcrumb (1) DisableSearch (1) DisableSearchHiddenPages (1) DisableSearchIndex (1) DisableSearchPage (1) DisableSeoHiddenPages (1) DisableShortcutsTitle (1) DisableTagHiddenPages (1) DisableTermBreadcrumbs (1) DisableToc (1) E EditURL (2) ExternalLinkTarget (1) H HighlightWrap (1) I Image.errorlevel (1) ImageEffects (1) Include.errorlevel (1) L LandingPageName (1) Link.errorlevel (1) LinkTitle (1) M Math (1) Math.force (1) MathJaxInitialize (1) Merrrmaid.force (1) MermaidInitialize (1) MermaidZoom (1) O Openapi.errorlevel (1) Openapi.force (1) Ordersectionsby (2) R Relearrrn.dependencies (1) S SearchIndexURL (1) SearchPageURL (1) ShowVisitedLinks (1) Sidebarmenus (1) T ThemeVariant (2) TitleSeparator (1) All Configurat'n Opt'ns Here’s a list o' all avail'ble opt'ns wit' example values. Default values be described 'n th' annotated example below 'n each option’s documentat'n.\nhugo. toml yaml json [params] additionalContentLanguage = ['en'] alwaysopen = '' breadcrumbSeparator = '\u003e' collapsibleMenu = true customMathJaxURL = '' customMermaidURL = '' customOpenapiURL = '' disableAnchorCopy = false disableAnchorScroll'n = false disableAssetsBust'n = false disableBreadcrumb = false disableDefaultRelref = false disableExplicitIndexURLs = false disableGeneratorVersion = false disableHoverBlockCopyToClipBoard = false disableInlineCopyToClipBoard = true disableLandingPageButton = true disableLanguageSwitchingButton = false disableNextPrev = false disableRandomIds = false disableRootBreadcrumb = true disableSearch = false disableSearchHiddenPages = false disableSearchIndex = false disableSearchPage = false disableSeoHiddenPages = true disableShortcutsTitle = false disableTagHiddenPages = false disableTermBreadcrumbs = false disableToc = false editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' externalLinkTarget = '_self' highlightWrap = true images = ['images/hero.png'] linkTitle = 'Relearn' math = false mathJaxInitialize = '{}' mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidZoom = true ordersectionsby = 'weight' searchIndexURL = 'searchindex.js' searchPageURL = 'search' showVisitedLinks = true titleSeparator = '::' [params.author] name = 'Sören Weber' [[params.boxStyle]] color = 'gold' i18n = '' ay'con = 'rainbow' identifier = 'magic' title = 'Magic' [params.image] errorlevel = 'error' [params.imageEffects] border = true lazy = true lightbox = true shadow = false [params.include] errorlevel = 'error' [params.link] errorlevel = 'error' [params.mermaid] force = false [params.openapi] errorlevel = 'error' [params.oppenapi] force = false [[params.sidebarmenus]] disableTitle = true identifier = 'home' main = true pageRef = '' type = 'page' [[params.sidebarmenus]] disableTitle = false identifier = 'shortcuts' main = false type = 'menu' [params.social] facebook_admin = '' twitter = '' [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] identifier = 'relearn-bright' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] auto = ['learn', 'neon'] identifier = 'retro-auto' name = 'Retro Learn/Neon' [[params.themeVariant]] identifier = 'neon' [[params.themeVariant]] identifier = 'learn' [[params.themeVariant]] identifier = 'blue' [[params.themeVariant]] identifier = 'green' [[params.themeVariant]] identifier = 'red' params: additionalContentLanguage: - en alwaysopen: \"\" author: name: Sören Weber boxStyle: - color: gold i18n: \"\" ay'con: rainbow identifier: magic title: Magic breadcrumbSeparator: '\u003e' collapsibleMenu: true customMathJaxURL: \"\" customMermaidURL: \"\" customOpenapiURL: \"\" disableAnchorCopy: false disableAnchorScroll'n: false disableAssetsBust'n: false disableBreadcrumb: false disableDefaultRelref: false disableExplicitIndexURLs: false disableGeneratorVersion: false disableHoverBlockCopyToClipBoard: false disableInlineCopyToClipBoard: true disableLandingPageButton: true disableLanguageSwitchingButton: false disableNextPrev: false disableRandomIds: false disableRootBreadcrumb: true disableSearch: false disableSearchHiddenPages: false disableSearchIndex: false disableSearchPage: false disableSeoHiddenPages: true disableShortcutsTitle: false disableTagHiddenPages: false disableTermBreadcrumbs: false disableToc: false editURL: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath} externalLinkTarget: _self highlightWrap: true image: errorlevel: error imageEffects: border: true lazy: true lightbox: true shadow: false images: - images/hero.png include: errorlevel: error link: errorlevel: error linkTitle: Relearrrn math: false mathJaxInitialize: '{}' mermaid: force: false mermaidInitialize: '{ \"securityLevel\": \"loose\" }' mermaidZoom: true openapi: errorlevel: error oppenapi: force: false ordersectionsby: weight searchIndexURL: searchindex.js searchPageURL: search showVisitedLinks: true sidebarmenus: - disableTitle: true identifier: home main: true pageRef: \"\" type: plank - disableTitle: false identifier: shortcuts main: false type: menu social: facebook_admin: \"\" twitter: \"\" themeVariant: - auto: [] identifier: relearn-auto name: Relearrrn Light/Dark - identifier: relearn-light - identifier: relearn-dark - identifier: relearn-bright - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - auto: - learn - neon identifier: retro-auto name: Retro Learn/Neon - identifier: neon - identifier: learn - identifier: blue - identifier: green - identifier: red titleSeparator: '::' { \"params\": { \"additionalContentLanguage\": [ \"en\" ], \"alwaysopen\": \"\", \"author\": { \"name\": \"Sören Weber\" }, \"boxStyle\": [ { \"color\": \"gold\", \"i18n\": \"\", \"icon\": \"rainbow\", \"identifier\": \"magic\", \"title\": \"Magic\" } ], \"breadcrumbSeparator\": \"\\u003e\", \"collapsibleMenu\": true, \"customMathJaxURL\": \"\", \"customMermaidURL\": \"\", \"customOpenapiURL\": \"\", \"disableAnchorCopy\": false, \"disableAnchorScrolling\": false, \"disableAssetsBusting\": false, \"disableBreadcrumb\": false, \"disableDefaultRelref\": false, \"disableExplicitIndexURLs\": false, \"disableGeneratorVersion\": false, \"disableHoverBlockCopyToClipBoard\": false, \"disableInlineCopyToClipBoard\": true, \"disableLandingPageButton\": true, \"disableLanguageSwitchingButton\": false, \"disableNextPrev\": false, \"disableRandomIds\": false, \"disableRootBreadcrumb\": true, \"disableSearch\": false, \"disableSearchHiddenPages\": false, \"disableSearchIndex\": false, \"disableSearchPage\": false, \"disableSeoHiddenPages\": true, \"disableShortcutsTitle\": false, \"disableTagHiddenPages\": false, \"disableTermBreadcrumbs\": false, \"disableToc\": false, \"editURL\": \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\", \"externalLinkTarget\": \"_self\", \"highlightWrap\": true, \"image\": { \"errorlevel\": \"error\" }, \"imageEffects\": { \"border\": true, \"lazy\": true, \"lightbox\": true, \"shadow\": false }, \"images\": [ \"images/hero.png\" ], \"include\": { \"errorlevel\": \"error\" }, \"link\": { \"errorlevel\": \"error\" }, \"linkTitle\": \"Relearn\", \"math\": false, \"mathJaxInitialize\": \"{}\", \"mermaid\": { \"force\": false }, \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\", \"mermaidZoom\": true, \"openapi\": { \"errorlevel\": \"error\" }, \"oppenapi\": { \"force\": false }, \"ordersectionsby\": \"weight\", \"searchIndexURL\": \"searchindex.js\", \"searchPageURL\": \"search\", \"showVisitedLinks\": true, \"sidebarmenus\": [ { \"disableTitle\": true, \"identifier\": \"home\", \"main\": true, \"pageRef\": \"\", \"type\": \"page\" }, { \"disableTitle\": false, \"identifier\": \"shortcuts\", \"main\": false, \"type\": \"menu\" } ], \"social\": { \"facebook_admin\": \"\", \"twitter\": \"\" }, \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"identifier\": \"relearn-bright\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"auto\": [ \"learn\", \"neon\" ], \"identifier\": \"retro-auto\", \"name\": \"Retro Learn/Neon\" }, { \"identifier\": \"neon\" }, { \"identifier\": \"learn\" }, { \"identifier\": \"blue\" }, { \"identifier\": \"green\" }, { \"identifier\": \"red\" } ], \"titleSeparator\": \"::\" } } Annotated Configurat'n Opt'ns ​ hugo.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by giv'n it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes as well. # Th' title t' be used fer links t' th' main plank # Default: not set # This name will be used fer th' link t' th' main plank 'n th' upper section # o' th' menu. If not set, `title` from th' Cap'n Hugo sett'ns will be used. linkTitle = 'Relearn' # Th' author o' yer ship. # Default: not set # This will be used 'n HTML meta tags, th' opengraph protocol an' twitter # cards. # Ye can also set `author.email` if ye want t' publish this informat'n. author.name = 'Sören Weber' # Th' social media image o' yer ship. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. images = [ 'images/hero.png' ] # Admin opt'ns fer social media. # Default: not set # Configurat'n fer th' Open Graph protocol an' Twitter Cards adhere t' Hugo's # implementat'n. See th' Cap'n Hugo docs fer poss'ble values. social.facebook_admin = '' social.twitter = '' ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Brand'n # These opt'ns set yer overall visual appearance. # Used color variants. # Default: 'auto' # This sets one or more color variants, avail'ble t' yer readers t' choose # from. Ye can # - set a single value eg. 'zen-light' # - an array like [ 'neon', 'learn' ] # - an array wit' opt'ns like [ { identifier = 'neon' },{ identifier = 'learn' } ] # Th' last form allows t' set further opt'ns fer each variant. # Th' `identifier` be mandatory. Ye can also set `name` which overrides th' # value displayed 'n th' variant selector. # If th' array has more than one entry, a variant selector # be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th' # default variant, used fer first time visitors. # Th' theme ships wit' th' follow'n variants: 'relearn-bright', # 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn', # 'blue', 'green', 'red'. In addit'n ye can use auto mode variants. See th' # docs fer a detailed explanat'n. # Ye can also define yer own variants. See th' docs how this works. Also, # th' docs provide an interactive theme generator t' help ye wit' this task. themeVariant = [ { identifier = 'relearn-auto', name = 'Relearn Light/Dark', auto = [] }, { identifier = 'relearn-light' }, { identifier = 'relearn-dark' }, { identifier = 'relearn-bright' }, { identifier = 'zen-auto', name = 'Zen Light/Dark', auto = [ 'zen-light', 'zen-dark' ] }, { identifier = 'zen-light' }, { identifier = 'zen-dark' }, { identifier = 'retro-auto', name = 'Retro Learn/Neon', auto = [ 'learn', 'neon' ] }, { identifier = 'neon' }, { identifier = 'learn' }, { identifier = 'blue' }, { identifier = 'green' }, { identifier = 'red' } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These opt'ns be defin'n general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files an' CSS-files get a unique ID on each rebuild. # This makes sure, th' user always has th' latest version an' not some stale # copy o' his browser cache. Anyways, it can be desire'ble t' turn this # off 'n certain circumstances. For example if ye have Hugo's dev server # runn'n. Also some proxies dislike this optimizat'n. disableAssetsBust'n = false # Avoid generator meta tags. # Default: false # Set this t' true if ye want t' dis'ble generat'n fer generator meta tags # o' Cap'n Hugo an' th' theme 'n yer HTML head. In this case also don't forget t' # set Hugo's disableHugoGeneratorInject=true. Otherwise Cap'n Hugo will generate a # meta tag into yer home plank anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situat'ns th' theme generates non st'ble unique ids t' be used # 'n HTML fragment links. This can be undesir'ble fer example when test'n # th' output fer changes. If ye dis'ble th' random id generat'n, th' theme # may not funct'n correctly anymore. disableRandomIds = false # Additional code dependencies. # Default: See hugo.toml o' th' theme # Th' theme provides a mechanism t' board further JavaScript an' CSS # dependencies on demand only if they be needed. This comes 'n handy if ye # want t' add own shorrrtcodes that depend on additional code t' be boarded. # See th' docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # This can be overridden 'n th' page's frontmatter. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false # Th' URL prefix t' edit a plank. # Default: not set # If set, an edit button will be shown 'n th' topbar. If th' button be hidden, # also th' keyboard shortcuts be disabled. Th' value can contain th' macro # `${FilePath}` which will be replaced by th' file path o' yer displayed plank. # If no `${FilePath}` be given 'n th' value, th' value be treated as if th' # `${FilePath}` was appended at th' end o' th' value. This can be overridden # 'n th' planks frontmatter. This be useful if ye want t' give th' opportunity # fer people t' create merge request fer yer rrrambl'n. editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Search # These opt'ns modify various aspects o' th' search functionality. # Dis'ble th' search. # Default: false # If th' search be disabled, no search box will be displayed 'n th' menu, # nor in-page search, search popup or dedicated search plank will be avail'ble. # This will also cause th' keyboard shortcut t' be disabled. disableSearch = false # Dis'ble th' search index generat'n. # Default: false # `disableSearch=false` must be set t' let th' generat'n o' th' search index # file t' be affected by this opt'n. If th' search index be disabled, no # search popup or dedicated search plank will be avail'ble. disableSearchIndex = false # URL o' th' search index file relative t' th' language home. # Default: 'searchindex.js' # Ye have t' set this opt'n if yer plank already has a rrrambl'n file named # `searchindex.js` 'n th' language home. searchIndexURL = 'searchindex.js' # Dis'ble th' dedicated search plank. # Default: false # `disableSearch=false` an' `disableSearchIndex=false` must be set t' let th' # generat'n o' th' dedicated search plank t' be affected by this opt'n. disableSearchPage = false # URL o' th' dedicated search plank relative t' th' language home. # Default: 'search' # In its basic form th' search plank URL be named th' same fer all languages # but ye be free t' override it 'n each language opt'ns t' localised th' # URL. Ye also need t' set this opt'n if yer plank already has a rrrambl'n # plank named `search`. searchPageURL = 'search' # Multilanguage rrrambl'n. # Default: not set # If th' search index be enabled an' yer planks contain further languages # besides th' main one used, add all those auxiliary languages here. This # will create a search index wit' support fer all used languages o' yer ship. # This be handy fer example if ye be writ'n 'n Spanish but have lots o' # source code on yer plank which typically uses English terminology. additionalContentLanguage = [ 'en' ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu appearance. # Hide th' Home entry. # Default: false # If shown, a Home button will appear below th' search bar an' th' main menu. # It links t' yer th' home plank o' th' current language. disableLandingPageButton = true # Hide th' language switcher. # Default: false # If ye have more than one language configured, a language switcher be # displayed 'n th' lower part o' th' menu. This opt'n lets ye explicitly # turn this behavior off. disableLanguageSwitchingButton = false # Shows checkmarks fer visited planks o' th' main menu. # Default: false # This also causes th' display o' th' `Clear History` entry 'n th' lower part # o' th' menu t' remove all checkmarks. Th' checkmarks will also been removed # if ye regenerate yer ship as th' ids be not st'ble. showVisitedLinks = true # Th' order o' main menu submenus. # Default: 'weight' # Submenus can be ordered by 'weight', 'title', 'linktitle', 'modifieddate', # 'expirydate', 'publishdate', 'date', 'length' or 'default' (adher'n t' # Hugo's default sort order). This can be overridden 'n th' planks frontmatter. ordersectionsby = 'weight' # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. This can be overridden 'n th' page's frontmatter. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = '' # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. # This can be overridden 'n th' page's frontmatter. collapsibleMenu = true # Hide head'n above th' shortcuts menu. # Default: false # If a sidebar menu wit' identifier `shortcuts` be configured (see below), # this be th' easy way t' remove th' head'n; # Th' title fer th' head'n can be overwritten 'n yer i18n files. See Hugo's # documentat'n how t' do this. disableShortcutsTitle = false # Define yer own sidebar menus. # Default: th' value used below # Th' sidebar menus be built from this parameter. If not set, it contains # th' below default. # Menus be written from th' sidebar's top t' buttom 'n th' order given 'n # this array. # This can be overridden 'n th' page's frontmatter. # Each entry can contain th' follow'n keys: # - `type` be mandatory. Either `page` 'n case it should generate a tre from # th' plank structure or `menu` 'n case it should generate a tree from a # defined menu. # - `identifier` be mandatory. In case o' `type=page`, anyth'n can be used, # 'n case o' `type=menu` th' `identifier` key must be identical t' th' # key o' th' menu definit'n. # - `main`, boolean. If `true`, th' first tree level be spaced more generous # an' th' text be emphasized. Default: `true` fer `type=page` an' `false` # fer `type=menu` # - `disableTitle`, boolean. If `true`, there be no title above th' tree. # Default: `true` fer `type=page` an' `false` fer `type=menu`. If a title # should be used, 'n case o' `type=page` it will be taken from th' page's # `menuTitle` front matter an' if not set, from th' translat'n files, us'n # th' menu `identifier` as key. In case o' `type=menu` it will be taken # from th' menu `title` accord'n t' Hugo's documentat'n an' if not set # from th' menu `name` an' if this be not set form th' page's `linkTitle`. # - `pageRef`, optional. In case o' `type=page` this be th' start'n page's # path. If not set, th' home plank will be used. sidebarmenus = [ { type = 'page', identifier = 'home', main = true, disableTitle = true, pageRef = '' }, { type = 'menu', identifier = 'shortcuts', main = false, disableTitle = false }, ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide hidden planks from search. # Default: false # Hides hidden planks from th' suggest'ns o' th' search box an' th' dedicated # search plank. disableSearchHiddenPages = false # Hide hidden planks fer web crawlers. # Default: false # Avoids hidden planks from show'n up 'n th' sitemap an' on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden planks fer taxonomies. # Default: false # Hides hidden planks from show'n up on th' taxonomy an' terms planks. If this # reduces term counters t' zero, an empty but not linked term plank will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Title separator. # Default: '::' # Changes th' title separator used when concatenat'n th' plank title wit' th' # ship title. This be consistently used throughout th' theme. titleSeparator = '::' # Breadcrumb separator. # Default: '\u003e' # Changes th' breadcrumb separator used 'n th' topbars breadcrumb area an' fer # search results an' term planks. breadcrumbSeparator = '\u003e' # Hide th' root breadcrumb. # Default: false # Th' root breadcrumb be usually th' home plank o' yer ship. Because this be # always access'ble by click'n on th' logo, ye may want t' reduce clutter # by remov'n this from yer breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term planks. # Default: false # If ye have lots o' taxonomy terms, th' term planks may seem cluttered wit' # breadcrumbs t' ye, so this be th' opt'n t' turn off breadcrumbs on term # planks. Only th' plank title will then be shown on th' term planks. disableTermBreadcrumbs = false # Dis'ble copy'n head'n links t' clipboard # Default: false # If set t' true, this disables th' copy'n o' anchor links t' th' clipboard; # if also `disableAnchorScrolling=true` then no anchor link will be vis'ble # when hover'n a head'n. disableAnchorCopy = false # Dis'ble scroll'n t' head'n link on click # Default: false # If set t' true, this disables th' scroll'n t' th' beginn'n o' th' head'n # when clicked; if also `disableAnchorCopy=true` then no anchor link will # be vis'ble when hover'n a head'n. disableAnchorScroll'n = false # User-defined styles fer shorrrtcodes # Default: not set # Besides th' predefined `style` values, ye be able t' define yer own. Th' # `style` parameter o' th' shortcode must match th' `identifier` defined here. # Th' title fer th' style will be determined from th' `title`. If no `title` # but a `i18n` be set, th' title will be taken from th' translat'n files by # that key. Th' `title` may be empty 'n which case, th' box does not contain a # default title. `icon` an' `color` be work'n similar. boxStyle = [ { identifier = 'magic', i18n = '', title = 'Magic', ay'con = 'rainbow', color = 'gold' } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Hide copy-to-clipboard fer inline code. # Default: false # This removes th' copy-to-clipboard button from yer inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard fer block code. # Default: false # Th' theme only shows th' copy-to-clipboard button if ye hover over th' code # block. Set this t' true t' dis'ble th' hover effect an' always show th' # button. disableHoverBlockCopyToClipBoard = false # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Include # These opt'ns configure how th' include shortcode works. # What t' do when path be not resolved. # Default: '' # Ye can control what should happen if a path can not be resolved t' as # a resource or via th' file system. If not set, no output will be written # fer th' unresolved path. If set t' `warning` th' same happens an' an additional # warning be printed. If set t' `error` an error message be printed an' th' build # be aborted. # This can be overridden 'n th' page's frontmatter. include.errorlevel = 'error' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # What t' do when local image link be not resolved. # Default: '' # Ye can control what should happen if a local image can not be resolved t' as # a resource. If not set, th' unresolved link be written as given into th' result'n # output. If set t' `warning` th' same happens an' an additional warning be # printed. If set t' `error` an error message be printed an' th' build be # aborted. # Please note that this can not resolve files inside o' yer `static` directory. # This can be overridden 'n th' page's frontmatter. image.errorlevel = 'error' # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effects can be overridden 'n th' page's frontmatter or through URL parameter # given t' th' image. See th' documentat'n fer details. # Default: false imageEffects.border = true # Default: true imageEffects.lazy = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These opt'ns configure how links be displayed. # Wether t' use Hugo's default relref shortcode implementat'n # Default: false # Since th' theme provides a link render hook, th' usage o' th' relref shortcode # be obsolete. If a ship still uses that shortcode, it fails t' generate a # correct links if th' baseURL be configured wit' a subdirectory an' relativeURLs=false. # Th' theme provides an overriden relref shortcode that also works 'n th' # above setup but must manually be activated by sett'n this opt'n t' true. # See discussion 'n https://github.com/McShelby/hugo-theme-relearn/discussions/862 disableDefaultRelref = false # Generate link URLs th' Cap'n Hugo way. # Default: false # If set t' true, th' theme behaves like a standard Cap'n Hugo installat'n an' # appends no index.html t' prettyURLs. As a trade off, yer build project will # not be serv'ble from th' file system. disableExplicitIndexURLs = false # What t' do when local plank link be not resolved. # Default: '' # Ye can control what should happen if a local link can not be resolved t' a # plank. If not set, th' unresolved link be written as given into th' result'n # output. If set t' `warning` th' same happens an' an additional warning be # printed. If set t' `error` an error message be printed an' th' build be # aborted. # Please note that wit' Cap'n Hugo \u003c 0.123.0 + `uglyURLs=true` this can lead t' false # negatives. # This can be overridden 'n th' page's frontmatter. link.errorlevel = 'error' # How t' open external links. # Default: '_blank' # For external links ye can define how they be opened 'n yer browser. All # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th' # default value opens external links 'n a separate browser tab. If ye want # t' open those links 'n th' same tab, use '_self'. # This can be overridden 'n th' page's frontmatter. externalLinkTarget = '_self' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mathJaxInitialize = '{}' # Force board Math on every plank. # Default: false # If a, Math shortcode or codefence be found, th' opt'n will be ignored an' # Math will be boarded regardlessly. This opt'n be useful 'n case ye # be us'n passthrough configurat'n t' render yer math. In this case no shortcode or # codefence be involved an' th' library be not boarded by default so ye can # force load'n it by sett'n `math=true`. # This opt'n has an alias `math.force`. # This can be overridden 'n th' page's frontmatter. math = false # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMathJaxURL = '' # 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mermaidInitialize = '{ \"securityLevel\": \"loose\" }' # Force board Merrrmaid on every plank. # Default: false # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. This opt'n be useful 'n case ye # be us'n script'n t' render yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default so ye can # force load'n it by sett'n `mermaid.force=true`. # This can be overridden 'n th' page's frontmatter. mermaid.force = false # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMermaidURL = '' # 'https://unpkg.com/mermaid/dist/mermaid.min.js' #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Force board OpenAPI on every plank. # Default: false # If a, OpenAPI shortcode or codefence be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. This opt'n be useful 'n case ye # be us'n script'n t' render yer spec. In this case no shortcode or # codefence be involved an' th' library be not boarded by default so ye can # force load'n it by sett'n `openapi.force=true`. # This can be overridden 'n th' page's frontmatter. oppenapi.force = false # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customOpenapiURL = '' # 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js' # What t' do when a local OpenAPI spec link be not resolved. # Default: '' # Ye can control what should happen if a local OpenAPI spec link can not be resolved # t' a resource. If not set, th' unresolved link be written as given into th' result'n # output. If set t' `warning` th' same happens an' an additional warning be # printed. If set t' `error` an error message be printed an' th' build be # aborted. # Please note that this can not resolve files inside o' yer `static` directory. # This can be overridden 'n th' page's frontmatter. openapi.errorlevel = 'error'",
"description": "All configuration options for the Relearn theme",
"tags": [],
"title": "Options Reference",
"uri": "/hugo-theme-relearn/pir/configuration/reference/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Customization",
"content": "In addit'n t' th' output formats com'n wit' th' theme, ye can create yer own output formats.\nStart'n from Scratch If ye want t' add a new output format called myformat that outputs HTML an' ye want t' build everyth'n yourself without us'n th' theme’s components:\nCreate a file layouts/_default/baseof.myformat.html Implement all th' necessary code 'n this file Us'n th' Theme’s Structure If ye want t' keep th' general framework an' only change specific parts, ye can override these files:\nlayouts/_default/views/article.html: Controls how a page’s rrrambl'n an' title be displayed layouts/_default/views/body.html: Determines th' plank body structure layouts/_default/views/menu.html: Defines th' sidebar menu layout layouts/_default/views/storeOutputFormat.html: Stores th' output format name fer use 'n th' framework For a real-world example, check out th' print output format implementat'ns\nlayouts/_default/views/body.print.html layouts/_default/views/menu.print.html layouts/_default/views/storeOutputFormat.print.html",
"description": "Adding Custom Output Formats",
"tags": [],
"title": "Output Formats",
"uri": "/hugo-theme-relearn/pir/configuration/customization/outputformats/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Site Management",
"content": "Disabl'n th' Generator Meta Opt'n Th' theme adds a meta tag wit' its version number t' each plank.\nThis isn’t a security risk an' helps us support ye better.\nT' turn this off, set disableGeneratorVersion=true.\nhugo. toml yaml json [params] disableGeneratorVersion = true params: disableGeneratorVersion: true { \"params\": { \"disableGeneratorVersion\": true } } If ye also want t' turn off Hugo’s version meta tag, use disableHugoGeneratorInject=true.\nDisabl'n IDs fer Referenced Assets Opt'n Th' theme creates a unique ID fer each build an' adds it t' each referenced asset’s URL t' make browsers not keep outdated cached assets.\nThis be bloody fer product'n sites but can be problematic dur'n development. It makes compar'n outputs difficult as each build has new IDs.\nT' dis'ble this, set disableAssetsBusting=true.\nhugo. toml yaml json [params] disableAssetsBust'n = true params: disableAssetsBust'n: true { \"params\": { \"disableAssetsBusting\": true } } Disabl'n IDs fer Interactive HTML Elements Opt'n Features like expanders, callouts, an' tabs use unique IDs t' work. These IDs change wit' each build.\nThis be necessary fer th' theme t' work properly, but it can make compar'n outputs between builds difficult.\nT' turn this off, set disableRandomIds=true. Avast, that this will result 'n a non-functional ship!.\nhugo. toml yaml json [params] disableRandomIds = true params: disableRandomIds: true { \"params\": { \"disableRandomIds\": true } }",
"description": "How to make your generated HTML output stable",
"tags": [],
"title": "Stable Output",
"uri": "/hugo-theme-relearn/pir/configuration/sitemanagement/stableoutput/index.html"
},
{
"breadcrumb": "Configurrrat'n \u003e Customization",
"content": "This plank explains how t' show custom taxonomies on yer planks.\nFor more details, check th' official docs on sett'n up custom taxonomies an' us'n them 'n yer rrrambl'n.\nDefault Behavior Th' Relearrrn theme automatically shows Hugo’s default taxonomies tags an' categories out o' th' box.\nTags appear at th' top o' th' plank 'n alphabetical order 'n form o' baggage tags. Categories appear at th' bottom o' th' plank 'n alphabetical order as a list prefixed wit' an ay'con. Each item links t' a plank show'n all articles wit' that term.\nSett'n Up Custom Taxonomies T' add custom taxonomies, update yer hugo.toml file. Ye also have t' add th' default taxonomies if ye want t' use them.\nhugo. toml yaml json [taxonomies] category = 'categories' mycustomtag = 'mycustomtags' tag = 'tags' taxonomies: category: categories mycustomtag: mycustomtags tag: tags { \"taxonomies\": { \"category\": \"categories\", \"mycustomtag\": \"mycustomtags\", \"tag\": \"tags\" } } Show'n Custom Taxonomies T' display yer custom taxonomy terms, add this t' yer plank (usually 'n layouts/partials/content-footer.html):\n{{ partial \"term-list.html\" (dict \"page\" . \"taxonomy\" \"mycustomtags\" \"icon\" \"layer-group\" ) }} Parameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. taxonomy \u003cempty\u003e Th' plural name o' th' taxonomy t' display as used 'n yer front matter. class \u003cempty\u003e Additional CSS classes set on th' outermost generated HTML element.\nIf set t' tags ye will get th' visuals fer display'n th' tags taxonomy, otherwise it will be a simple list o' links as fer th' categories taxonomy. style primary Th' style scheme used if class be tags.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used if class be tags. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con \u003cempty\u003e An optional Font Awesome ay'con name set t' th' left o' th' list.",
"description": "How to display custom taxonomies on your pages",
"tags": [
"Taxonomy"
],
"title": "Taxonomies",
"uri": "/hugo-theme-relearn/pir/configuration/customization/taxonomy/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children",
"content": "This be a demo child plank.\nSubpages o' this plank plank 1-1",
"description": "This be a demo child plank",
"tags": [
"Children",
"Non-Hidden"
],
"title": "plank 1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children",
"content": "This be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.",
"description": "This be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.",
"tags": [
"Children",
"Non-Hidden"
],
"title": "plank 2",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-2/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children",
"content": "This be a demo child plank.\nSubpages o' this plank plank 3-1",
"description": "This be a demo child plank",
"tags": [
"Children",
"Non-Hidden"
],
"title": "plank 3",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-3/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children",
"content": "This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode as long as ye aren’t view'n this plank or its children directly.",
"description": "This be a hidden demo child plank",
"tags": [
"Children",
"hush, matey"
],
"title": "plank 4 (hidden)",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-4/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: AdditionalContentLanguage",
"uri": "/hugo-theme-relearn/pir/options/additionalcontentlanguage/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Alwaysopen",
"uri": "/hugo-theme-relearn/pir/options/alwaysopen/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Alwaysopen",
"uri": "/hugo-theme-relearn/pir/frontmatter/alwaysopen/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Arrr This shortcode be deprecated 'n favor o' th' new resources shortcode. See migrat'n instruct'ns below.\nTh' examples on this plank were removed.\nTh' attachments shortcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.\nMigrat'n While this shortcode will still be avail'ble fer some time, it does not receive support anymore. Start t' migrate early, as it will be removed wit' th' next major update o' th' theme.\nTh' resources shortcode leverages Hugo’s resource feature fer plank bundles. It has all th' same parameter as th' attachments shortcode but applies th' pattern directly on a resources Name attribute.\nT' migrate yer planks apply th' follow'n steps:\nIf a plank be not already a plank bundle convert it Move yer files t' a valid destinat'n inside o' yer plank bundle (depend'n if ye have a branch or a leaf bundle) Change th' calls from th' attachments shortcode t' th' resources shortcode an' adjust th' pattern parameter t' th' new directory layout an' th' resources Name attribute. Multilanguage features be not supported directly by th' shortcode anymore but rely on Hugo’s handl'n fer resource translat'ns.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% attachments sort=\"asc\" /%}} {{ partial \"shortcodes/attachments.html\" (dict \"page\" . \"sort\" \"asc\" )}} Parameter Name Default Notes style transparent Th' style scheme used fer th' box.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYe can also define yer own styles. color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: Attachments\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: paperclip\nIf ye want no ay'con, ye have t' set this parameter t' \" \" (a non empty d wit' spaces) sort asc Sort'n th' output 'n ascend'n or descend'n order. pattern .* A regular expressions, used t' filter th' attachments by file name. For example:\n- t' match a file suffix o' ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- t' match file names end'n 'n jpg or png, use .*\\.(jpg|png) Setup Single language Th' shortcode lists files found 'n a specific directory. Th' name o' th' directory depends on yer plank type (either branch bundle, leaf bundle or page).\nIf yer plank be a leaf bundle, attachments must be placed 'n a nested index.files directory, accordingly.\nrrrambl'n _index.md plank index.md index.files attachment.pdf If yer plank be a branch bundle, attachments must be placed 'n a nested _index.files directory, accordingly.\nArrr This be only avail'ble fer Cap'n Hugo \u003c 0.112.0\nrrrambl'n _index.md plank _index.md _index.files attachment.pdf For simple planks, attachments must be placed 'n a directory named like yer plank an' end'n wit' .files.\nArrr This be only avail'ble fer Cap'n Hugo \u003c 0.112.0\nrrrambl'n _index.md plank.files attachment.pdf plank.md Multilingual Be aware that if ye use a multilingual website, ye will need t' have as many directories as languages an' th' language code must be part o' th' directory name.\nEg. fer a ship 'n English an' Piratish:\nrrrambl'n index.en.md index.pir.md plank index.en.md index.pir.md index.en.files attachment.pdf index.pir.files attachment.pdf",
"description": "Th' Attachments shorrrtcode displays a list o' files attached t' a plank",
"tags": [],
"title": "Attachments",
"uri": "/hugo-theme-relearn/pir/shortcodes/attachments/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Author.email",
"uri": "/hugo-theme-relearn/pir/options/author.email/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Author.name",
"uri": "/hugo-theme-relearn/pir/options/author.name/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' badge shortcode displays little markers 'n yer text wit' adjust'ble color, title an' ay'con.\nImportant Version6.6.6 Captain AhoiNew Awesome\nUsage ​ shortcode partial {{% badge %}}Important{{% /badge %}} {{% badge style=\"primary\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" %}}Captain{{% /badge %}} {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" %}}Awesome{{% /badge %}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"content\" \"Important\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"Version\" \"content\" \"6.6.6\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"red\" \"icon\" \"angle-double-up\" \"content\" \"Captain\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"info\" \"content\" \"New\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"color\" \"fuchsia\" \"icon\" \"fab fa-hackerrank\" \"content\" \"Awesome\" )}} Parameter Name Default Notes style default Th' style scheme used fer th' badge.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYe can also define yer own styles. color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' badge title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text fer th' badge. Examples Style By Severity {{% badge style=\"caution\" %}}Magenta{{% /badge %}} {{% badge style=\"important\" %}}Cyan{{% /badge %}} {{% badge style=\"info\" %}}Blue{{% /badge %}} {{% badge style=\"note\" %}}Orange{{% /badge %}} {{% badge style=\"tip\" %}}Green{{% /badge %}} {{% badge style=\"warning\" %}}Red{{% /badge %}} Caut'nMagenta ImportantCyan AhoiBlue AvastOrange Smarrrt ArrrseGreen ArrrRed\nBy Brand Colors {{% badge style=\"primary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Mandatory{{% /badge %}} {{% badge style=\"secondary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Optional{{% /badge %}} {{% badge style=\"accent\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Special{{% /badge %}} AnnouncementMandatory AnnouncementOptional AnnouncementSpecial\nBy Color {{% badge style=\"blue\" ay'con=\"palette\" title=\"Color\" %}}Blue{{% /badge %}} {{% badge style=\"cyan\" ay'con=\"palette\" title=\"Color\" %}}Cyan{{% /badge %}} {{% badge style=\"green\" ay'con=\"palette\" title=\"Color\" %}}Green{{% /badge %}} {{% badge style=\"grey\" ay'con=\"palette\" title=\"Color\" %}}Grey{{% /badge %}} {{% badge style=\"magenta\" ay'con=\"palette\" title=\"Color\" %}}Magenta{{% /badge %}} {{% badge style=\"orange\" ay'con=\"palette\" title=\"Color\" %}}Orange{{% /badge %}} {{% badge style=\"red\" ay'con=\"palette\" title=\"Color\" %}}Red{{% /badge %}} ColorBlue ColorCyan ColorGreen ColorGrey ColorMagenta ColorOrange ColorRed\nBy Special Color {{% badge style=\"default\" ay'con=\"palette\" title=\"Color\" %}}Default{{% /badge %}} {{% badge style=\"transparent\" ay'con=\"palette\" title=\"Color\" %}}Transparent{{% /badge %}} ColorDefault ColorTransparent\nVariants Without Ay'con an' Title Text {{% badge %}}6.6.6{{% /badge %}} {{% badge style=\"info\" ay'con=\" \" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" %}}Captain{{% /badge %}} 6.6.6 Awesome Captain\nWithout Ay'con {{% badge title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" ay'con=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 AhoiAwesome RankCaptain\nWithout Title Text {{% badge ay'con=\"star\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" %}}Captain{{% /badge %}} 6.6.6 Awesome Captain\nAll Set {{% badge ay'con=\"star\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" %}}Awesome{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 AhoiAwesome RankCaptain\nOverride fer Severity {{% badge style=\"info\" ay'con=\"rocket\" title=\"Feature\" %}}Awesome{{% /badge %}} FeatureAwesome Other Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title an' Rrrambl'n {{% badge color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" title=\"**Font**\" %}}**Awesome**{{% /badge %}} FontAwesome Wit' Ay'con Rrrambl'n Ye can combine th' badge wit' th' ay'con shortcode t' create even more stunn'n visuals.\nIn this case ye need t' declare {{\u003c badge \u003e}} instead o' {{% badge %}}. Avast, that 'n this case it be not poss'ble t' put markdown 'n th' rrrambl'n.\n{{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} Pirate\nRank\nRank Pirate\nRank\nRank Pirate\nInside o' Text Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. {{% badge style=\"blue\" ay'con=\"rocket\" %}}Awesome{{% /badge %}} Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Awesome Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.",
"description": "Marker badges t' display 'n yer text",
"tags": [],
"title": "Badge",
"uri": "/hugo-theme-relearn/pir/shortcodes/badge/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: BoxStyle",
"uri": "/hugo-theme-relearn/pir/options/boxstyle/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: BreadcrumbSeparator",
"uri": "/hugo-theme-relearn/pir/options/breadcrumbseparator/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' button shortcode displays a click'ble button wit' adjust'ble color, title an' ay'con.\nGet Cap'n Hugo Get Cap'n Hugo\nUsage ​ shortcode partial {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" ay'con=\"dragon\" %}}Get Cap'n Hugo{{% /button %}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Parameter Name Default Notes href \u003cempty\u003e Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble.\n- if start'n wit' javascript: all follow'n text will be executed 'n yer browser\n- every other str'n will be interpreted as URL style transparent Th' style scheme used fer th' button.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYe can also define yer own styles. color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) iconposit'n left Places th' ay'con t' th' left or right o' th' title. target see notes Th' destinat'n frame/window if href be an URL. Otherwise th' parameter be not used. This behaves similar t' normal links. If th' parameter be not given it defaults t':\n- th' sett'n o' externalLinkTarget or _blank if not set, fer any address start'n wit' http:// or https://\n- no specific value fer all other links type see notes Th' button type if href be JavaScript. Otherwise th' parameter be not used. If th' parameter be not given it defaults t' button \u003ccontent\u003e see notes Arbitrary text fer th' button title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"caution\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"important\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"cyan\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"magenta\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo\nAy'con Empty {{% button href=\"https://gohugo.io/\" ay'con=\" \" %}}{{% /button %}} Only {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}{{% /button %}} T' th' Left {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo T' th' Right {{% button href=\"https://gohugo.io/\" ay'con=\"download\" iconposit'n=\"right\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Override fer Severity {{% button href=\"https://gohugo.io/\" ay'con=\"dragon\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Target {{% button href=\"https://gohugo.io/\" target=\"_self\" %}}Get Cap'n Hugo 'n same window{{% /button %}} {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo 'n new Window/Frame (default){{% /button %}} Get Cap'n Hugo 'n same Window/Frame Get Cap'n Hugo 'n new Window/Frame (default)\nOther Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title {{% button href=\"https://gohugo.io/\" color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" %}}Get **Cap'n Hugo**{{% /button %}} Get Cap'n Hugo Severity Style wit' All Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Smarrrt Arrrse Button t' Internal Plank {{% button href=\"/index.html\" %}}Home{{% /button %}} Home Button wit' JavaScript Act'n If yer JavaScript act'n does not change th' focus afterwards, make sure t' call this.blur() 'n th' end t' unselect th' button.\n{{% button style=\"primary\" ay'con=\"bullhorn\" href=\"javascript:alert('Hello world!');this.blur();\" %}}Shout it out{{% /button %}} Shout it out Button within a form Element T' use native HTML elements 'n yer Marrrkdown, add this 'n yer hugo.toml\n[marrrkup.goldmark.renderer] unsafe = true \u003cform act'n=\"../../search.html\" method=\"get\"\u003e \u003cinput name=\"search-by-detail\" class=\"search-by\" type=\"search\"\u003e {{% button type=\"submit\" style=\"secondary\" icon=\"search\" %}}Search{{% /button %}} \u003c/form\u003e Search",
"description": "Clickable buttons",
"tags": [],
"title": "Button",
"uri": "/hugo-theme-relearn/pir/shortcodes/button/index.html"
},
{
"breadcrumb": "",
"content": "Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like seeing Merrrmaids and stuff.\nCap'n Hugo Relearrrn Theme A theme fer Cap'n Hugo designed fer documentat'n.\n★ What’s new 'n th' latest version ★\nOverview Th' Relearrrn theme be an enhanced fork o' th' popular Learrrn theme. It aims t' address long-stand'n issues an' incorporate th' latest Cap'n Hugo features while try'n t' maintain compatibility wit' its predecessor.\nKey Features Versatile Usage\nResponsive design fer mobile devices Looks nice on paper - if it has t' Us'ble offline wit' no external dependencies Us'ble from yer local file system without a web server via file:// protocol Integrat'n wit' th' VSCode Front Matter CMS extension fer on-premise CMS capabilities Customiz'ble Appearance\nFlex'ble brand image configurat'n Automatic light/dark mode switch'n based on OS sett'ns Many pre-defined color variants User-select'ble variants Built-in stylesheet generator Customiz'ble rules highlight'n Advanced Functionality\nChapter an' site-wide print'n capabilities Versatile search opt'ns: in-page, popup, an' dedicated search plank Customiz'ble top bar buttons Configur'ble menus Support fer hidden planks Comprehensive taxonomy support Social media integrat'n Multilingual Support\nFull right-to-left (RTL) language support Extensive list o' supported languages: Arabic, Chinese (Simplified an' Traditional), Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese Multilingual rrrambl'n search capabilities Enhanced Marrrkdown Features\nCommonMark an' other Marrrkdown extensions Support fer Obsidian callouts Advanced image manipulat'n like lightbox, siz'n, shadows, borders, an' alignment Rich Shortcode Library\nCustomiz'ble marker badges Flex'ble buttons Child plank list'n Expand'ble rrrambl'n areas Font Awesome ay'con integrat'n File inclusion capabilities Math support fer mathematical an' chemical formulae Merrrmaid diagram integrat'n Styled notice boxes OpenAPI specificat'n render'n Plank bundle resource display Ship configurat'n parameter display Tab-based rrrambl'n organizat'n an' multi-tab panels Gett'n Started For a comprehensive guide on th' theme’s capabilities, please refer t' th' official documentat'n.\nUpdates an' Changes Visit th' What’s New plank fer feature highlights or th' detailed changelog fer a complete list o' updates.\nContribut'n We welcome contribut'ns fer bug fixes an' new features. Please see th' contribut'n guidelines before gett'n started.\nLicens'n Th' Relearrrn theme be distributed under th' MIT License.\nCredits This theme builds upon th' work o' many contributors.",
"description": "A theme fer Cap'n Hugo designed fer documentat'n.",
"tags": [],
"title": "Cap'n Hugo Relearrrn Theme",
"uri": "/hugo-theme-relearn/pir/index.html"
},
{
"breadcrumb": "",
"content": "",
"description": "",
"tags": [],
"title": "Categorrries",
"uri": "/hugo-theme-relearn/pir/categories/index.html"
},
{
"breadcrumb": "Tag-a-taggs",
"content": "",
"description": "",
"tags": [],
"title": "Tagga :: Children",
"uri": "/hugo-theme-relearn/pir/tags/children/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' children shortcode lists th' child planks o' th' current plank an' its descendants.\nplank 1 plank 2 plank 3 plank X Usage ​ shortcode partial {{% children sort=\"title\" %}} {{ partial \"shortcodes/children.html\" (dict \"page\" . \"sort\" \"title\" )}} Parameter Name Default Notes containerstyle ul Choose th' style used t' group all children. It could be any HTML tag name. style li Choose th' style used t' display each descendant. It could be any HTML tag name. showhidden false When true, child planks hidden from th' menu will be displayed as well. descript'n false When true shows a short text under each plank 'n th' list. When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken - read more info about summaries on gohugo.io. depth 1 Th' depth o' descendants t' display. For example, if th' value be 2, th' shortcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. 999. sort auto Th' sort criteria o' th' displayed list.\n- auto defaults t' ordersectionsby o' th' page’s Front Matter\nor t' ordersectionsby o' th' configurat'n Opt'n\nor t' weight\n- weight\n- title\n- modifieddate\n- expirydate\n- publishdate\n- date\n- length\n- default adher'n t' Hugo’s default sort criteria Examples All Default {{% children %}} plank X plank 1 plank 2 plank 3 Wit' Descript'n {{% children descript'n=\"true\" %}} plank XThis be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1This be a demo child plank\nplank 2This be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.\nplank 3This be a demo child plank\nInfinite Depth an' Hidden Planks {{% children depth=\"999\" showhidden=\"true\" %}} plank X plank 1 plank 1-1 plank 1-1-1 (hidden) plank 1-1-1-1 plank 1-1-1-1-1 (hidden) plank 1-1-1-1-1-1 plank 1-1-2 (headless) plank 1-1-2-1 plank 1-1-2-2 plank 1-1-3 plank 2 plank 3 plank 3-1 plank 4 (hidden) Head'n Styles fer Container an' Elements {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" descript'n=\"true\" %}} plank XThis be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1This be a demo child plank\nplank 1-1This be a demo child plank\nplank 1-1-2 (headless)This be a demo child plank\nplank 1-1-3This be a demo child plank\nplank 2This be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.\nplank 3This be a demo child plank\nplank 3-1This be a plain plank test nested 'n a parent\nDivs fer Group an' Element Styles {{% children containerstyle=\"div\" style=\"div\" depth=\"3\" %}} plank X plank 1 plank 1-1 plank 1-1-2 (headless) plank 1-1-3 plank 2 plank 3 plank 3-1",
"description": "List th' child planks on a plank",
"tags": [],
"title": "Children",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: CollapsibleMenu",
"uri": "/hugo-theme-relearn/pir/options/collapsiblemenu/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: CollapsibleMenu",
"uri": "/hugo-theme-relearn/pir/frontmatter/collapsiblemenu/index.html"
},
{
"breadcrumb": "Development",
"content": "Code Quality A new release can happen at any time from th' main branch o' th' GitHub project without further acknowledgment. This makes it necessary that, every pushed set o' changesets into th' main branch must be self-contained an' correct, result'n 'n a releas'ble version.\nStay simple fer th' user by focus'n on th' mantra “convent'n over configuration”.\nAt installat'n th' ship should work reason'ble without (m)any configurat'n.\nStay close t' th' Cap'n Hugo way.\nDon’t use npm or any preprocess'n, our contributors may not be front-end developers.\nDocument new features 'n th' exampleSite. This also contains entries t' th' What’s new plank.\nDon’t break exist'n features if ye don’t have t'.\nRemove reported issue from th' browser’s console.\nCheck fer unnecessary whitespace an' correct indent'n o' yer result'n HTML.\nConventional Commits Write commit messages 'n th' conventional commit format.\nFollow'n be an inpomplete list o' some o' th' used conventional commit types. Be creative.\nCommon Feature Structure Shorrrtcodes build a11y favicon attachments browser archetypes search badge chore alias menu button docs generator history children shorrrtcodes i18n scrollbar expand theme mobile nav ay'con print toc include rss clipboard math variant syntaxhighlight mermaid boxes notice openapi piratify siteparam tabs",
"description": "What to know if you want to contribute",
"tags": [],
"title": "Contributing",
"uri": "/hugo-theme-relearn/pir/development/contributing/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: CustomMathJaxURL",
"uri": "/hugo-theme-relearn/pir/options/custommathjaxurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: CustomMathJaxURL",
"uri": "/hugo-theme-relearn/pir/frontmatter/custommathjaxurl/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: CustomMermaidURL",
"uri": "/hugo-theme-relearn/pir/options/custommermaidurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: CustomMermaidURL",
"uri": "/hugo-theme-relearn/pir/frontmatter/custommermaidurl/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: CustomOpenapiURL",
"uri": "/hugo-theme-relearn/pir/options/customopenapiurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: CustomOpenapiURL",
"uri": "/hugo-theme-relearn/pir/frontmatter/customopenapiurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Description",
"uri": "/hugo-theme-relearn/pir/frontmatter/description/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableAnchorCopy",
"uri": "/hugo-theme-relearn/pir/options/disableanchorcopy/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableAnchorScrolling",
"uri": "/hugo-theme-relearn/pir/options/disableanchorscrolling/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableAssetsBusting",
"uri": "/hugo-theme-relearn/pir/options/disableassetsbusting/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableBreadcrumb",
"uri": "/hugo-theme-relearn/pir/options/disablebreadcrumb/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: DisableBreadcrumb",
"uri": "/hugo-theme-relearn/pir/frontmatter/disablebreadcrumb/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableDefaultRelref",
"uri": "/hugo-theme-relearn/pir/options/disabledefaultrelref/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableExplicitIndexURLs",
"uri": "/hugo-theme-relearn/pir/options/disableexplicitindexurls/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableGeneratorVersion",
"uri": "/hugo-theme-relearn/pir/options/disablegeneratorversion/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableHoverBlockCopyToClipBoard",
"uri": "/hugo-theme-relearn/pir/options/disablehoverblockcopytoclipboard/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableInlineCopyToClipBoard",
"uri": "/hugo-theme-relearn/pir/options/disableinlinecopytoclipboard/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableLandingPageButton",
"uri": "/hugo-theme-relearn/pir/options/disablelandingpagebutton/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableLanguageSwitchingButton",
"uri": "/hugo-theme-relearn/pir/options/disablelanguageswitchingbutton/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableNextPrev",
"uri": "/hugo-theme-relearn/pir/options/disablenextprev/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: DisableNextPrev",
"uri": "/hugo-theme-relearn/pir/frontmatter/disablenextprev/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableRandomIds",
"uri": "/hugo-theme-relearn/pir/options/disablerandomids/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableRootBreadcrumb",
"uri": "/hugo-theme-relearn/pir/options/disablerootbreadcrumb/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSearch",
"uri": "/hugo-theme-relearn/pir/options/disablesearch/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSearchHiddenPages",
"uri": "/hugo-theme-relearn/pir/options/disablesearchhiddenpages/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSearchIndex",
"uri": "/hugo-theme-relearn/pir/options/disablesearchindex/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSearchPage",
"uri": "/hugo-theme-relearn/pir/options/disablesearchpage/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableSeoHiddenPages",
"uri": "/hugo-theme-relearn/pir/options/disableseohiddenpages/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableShortcutsTitle",
"uri": "/hugo-theme-relearn/pir/options/disableshortcutstitle/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableTagHiddenPages",
"uri": "/hugo-theme-relearn/pir/options/disabletaghiddenpages/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableTermBreadcrumbs",
"uri": "/hugo-theme-relearn/pir/options/disabletermbreadcrumbs/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: DisableToc",
"uri": "/hugo-theme-relearn/pir/options/disabletoc/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: DisableToc",
"uri": "/hugo-theme-relearn/pir/frontmatter/disabletoc/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: EditURL",
"uri": "/hugo-theme-relearn/pir/options/editurl/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: EditURL",
"uri": "/hugo-theme-relearn/pir/frontmatter/editurl/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' expand shortcode displays an expandable/collaps'ble section o' text.\nExpand me… Thank ye!\nThat’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nUsage ​ shortcode shortcode (positional) partial {{% expand title=\"Expand me...\" %}}Thank ye!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank ye!{{% /expand %}} {{ partial \"shortcodes/expand.html\" (dict \"page\" . \"title\" \"Expand me...\" \"content\" \"Thank ye!\" )}} Th' notice shortcode be also cap'ble o' display'n expandable/collaps'ble sections o' text but wit' color opt'ns.\nParameter Name Posit'n Default Notes title 1 \"Expand me...\" Arbitrary text t' appear next t' th' expand/collapse ay'con. expanded 2 false How th' rrrambl'n be displayed.\n- true: th' rrrambl'n be initially shown\n- false: th' rrrambl'n be initially hidden \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed on expand. Examples All Defaults {{% expand %}}Yes, ye did it!{{% /expand %}} Expand me… Yes, ye did it! Initially Expanded {{% expand title=\"Expand me...\" expanded=\"true\" %}}No need t' press ye!{{% /expand %}} Expand me… No need t' press ye! Arbitrary Text {{% expand title=\"Show me almost **endless** possibilities\" %}} Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even **_bold emphasized_** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /expand %}} Show me almost endless possibilities Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)",
"description": "Expand'ble/collaps'ble sections of text",
"tags": [],
"title": "Expand",
"uri": "/hugo-theme-relearn/pir/shortcodes/expand/index.html"
},
{
"breadcrumb": "Categorrries",
"content": "",
"description": "",
"tags": [],
"title": "Categorrry :: Explanation",
"uri": "/hugo-theme-relearn/pir/categories/explanation/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: ExternalLinkTarget",
"uri": "/hugo-theme-relearn/pir/options/externallinktarget/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: ExternalLinkTarget",
"uri": "/hugo-theme-relearn/pir/frontmatter/externallinktarget/index.html"
},
{
"breadcrumb": "",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter",
"uri": "/hugo-theme-relearn/pir/frontmatter/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: HeadingPost",
"uri": "/hugo-theme-relearn/pir/frontmatter/headingpost/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: HeadingPre",
"uri": "/hugo-theme-relearn/pir/frontmatter/headingpre/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Hidden",
"uri": "/hugo-theme-relearn/pir/frontmatter/hidden/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' highlight shortcode renders yer code wit' a rules highlighter.\n​ python 1print(\"Hello World!\") Usage ​ codeodefence shortcode shortcode (positional) partial partial (compat) ```py {lineNos=\"true\" wrap=\"true\" title=\"python\"} print(\"Hello World!\") ``` {{\u003c highlight lineNos=\"true\" type=\"py\" wrap=\"true\" title=\"python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{\u003c highlight py \"lineNos=true,wrap=true,title=python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"lineNos\" \"true\" \"type\" \"py\" \"wrap\" \"true\" \"title\" \"python\" )}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"options\" \"lineNos=true,wrap=true,title=python\" \"type\" \"py\" )}} This shortcode be fully compat'ble wit' Hugo’s highlight shortcode but offers some extensions.\nIt be called interchangeably 'n th' same way as Hugo’s own shortcode by provid'n positional parameter or simply by us'n Marrrkdown codefences.\nYe be free t' also call this shortcode from yer own partials. In this case it resembles Hugo’s highlight funct'n rules if ye call it us'n compatibility rules.\nCodefence rules be widely avail'ble 'n other Marrrkdown parsers like GitHub an' therefore be th' recommend rules fer generat'n port'ble Marrrkdown.\nTh' tab shortcode be also cap'ble o' display'n code but wit' limited opt'ns.\nParameter Name Posit'n Default Notes type 1 \u003cempty\u003e Th' language o' th' code t' highlight. Choose from one o' th' supported languages. Case-insensitive. title \u003cempty\u003e Extension. Arbitrary title fer code. This displays th' code like a single tab if hl_inline=false (which be Hugo’s default). wrap see notes Extension. When true th' rrrambl'n may wrap on long lines otherwise it will be scroll'ble.\nTh' default value can be set 'n yer hugo.toml an' overwritten via front matter. See below. opt'ns 2 \u003cempty\u003e An optional, comma-separated list o' zero or more Cap'n Hugo supported opt'ns as well as extension parameter from this t'ble. \u003coption\u003e \u003cempty\u003e Any o' Hugo’s supported opt'ns. \u003ccontent\u003e \u003cempty\u003e Yer code t' highlight. Sett'ns Sett'n Default Values fer Hugo’s Opt'ns Default values fer Hugo’s supported opt'ns can be set via goldmark sett'ns.\nIf used together wit' wrapp'n o' long lines, use this recommended sett'ns. Otherwise, line numbers will shift if code wraps.\nhugo. toml yaml json [marrrkup] [marrrkup.highlight] lineNumbersInT'ble = false marrrkup: highlight: lineNumbersInT'ble: false { \"markup\": { \"highlight\": { \"lineNumbersInTable\": false } } } Sett'n Wrap o' Long Lines Opt'n Front Matter By default, code will be wrapped if th' line be not long enough.\nYe can dis'ble wrapp'n by sett'n highlightWrap=false or by sett'n th' wrap parameter individually fer each code block.\n​ toml yaml json highlightWrap = false highlightWrap: false { \"highlightWrap\": false } Copy t' Clipboard fer Inline Code Opt'n By default inline code has a button t' copy th' code t' th' clipboard.\nIf ye want t' dis'ble this feature, set disableInlineCopyToClipBoard=true.\nhugo. toml yaml json [params] disableInlineCopyToClipBoard = true params: disableInlineCopyToClipBoard: true { \"params\": { \"disableInlineCopyToClipBoard\": true } } Copy t' Clipboard fer Block Code Opt'n By default block code has a button t' copy th' code t' th' clipboard that be only vis'ble on hover.\nSet disableHoverBlockCopyToClipBoard=true t' dis'ble th' hover effect an' always show th' button.\nhugo. toml yaml json [params] disableHoverBlockCopyToClipBoard = true params: disableHoverBlockCopyToClipBoard: true { \"params\": { \"disableHoverBlockCopyToClipBoard\": true } } Sett'n a Specific Color Scheme Ye can configure th' color style used fer code blocks 'n yer color variants stylesheet file us'n th' --CODE-theme vari'ble. This requires further configurat'n as described 'n th' above link.\nExamples Line Numbers wit' Start'n Offset As mentioned above, line numbers 'n a t'ble layout will shift if code be wrapp'n, so better use inline. T' make th'ns easier fer ye, set lineNumbersInT'ble = false 'n yer hugo.toml an' add lineNos = true when call'n th' shortcode instead o' th' specific values t'ble or inline.\n{{\u003c highlight lineNos=\"true\" lineNoStart=\"666\" type=\"py\" \u003e}} # th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits print(\"Hello\") print(\" \") print(\"World\") print(\"!\") {{\u003c /highlight \u003e}} 666# th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits 667print(\"Hello\") 668print(\" \") 669print(\"World\") 670print(\"!\") Marrrkdown Codefence wit' Title ```py { title=\"python\" } # a bit shorter print(\"Hello World!\") ``` ​ python # a bit shorter print(\"Hello World!\") Wit' Wrap {{\u003c highlight type=\"py\" wrap=\"true\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff Without Wrap {{\u003c highlight type=\"py\" wrap=\"false\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff",
"description": "Render code with a syntax highlighter",
"tags": [],
"title": "Highlight",
"uri": "/hugo-theme-relearn/pir/shortcodes/highlight/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: HighlightWrap",
"uri": "/hugo-theme-relearn/pir/options/highlightwrap/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: HighlightWrap",
"uri": "/hugo-theme-relearn/pir/frontmatter/highlightwrap/index.html"
},
{
"breadcrumb": "Categorrries",
"content": "",
"description": "",
"tags": [],
"title": "Categorrry :: Howto",
"uri": "/hugo-theme-relearn/pir/categories/howto/index.html"
},
{
"breadcrumb": "Tag-a-taggs",
"content": "This lists all planks that be hidden from th' home plank. This includes planks that define hidden=true 'n their front matter as well as descendents o' hidden planks.\nWhen giv'n term planks, ye should give it a title. Otherwise it will print out a warning an' will use th' urlized title, which may looks weird.\nWhile internally this term be called hidden, it be referenced 'n th' result'n english planks as a secret an' as hush, matey 'n th' piratish translat'n.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.",
"description": "This lists all planks that be hidden from th' home plank. This includes planks that define hidden=true 'n their front matter as well as descendents o' hidden planks.",
"tags": [],
"title": "Tagga :: hush, matey",
"uri": "/hugo-theme-relearn/pir/tags/the-hidden/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' ay'con shortcode displays ay'cons us'n th' Font Awesome library.\nUsage ​ shortcode shortcode (positional) partial {{% ay'con ay'con=\"exclamation-triangle\" %}} {{% ay'con ay'con=\"angle-double-up\" %}} {{% ay'con ay'con=\"skull-crossbones\" %}} {{% ay'con exclamat'n-triangle %}} {{% ay'con angle-do'ble-up %}} {{% ay'con skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Posit'n Default Notes ay'con 1 \u003cempty\u003e Font Awesome ay'con name t' be displayed. It will be displayed 'n th' text color o' its accord'n context. Find'n an ay'con Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.\nOnce on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' ay'con name an' paste into th' Marrrkdown rrrambl'n.\nCustomis'n Ay'cons Font Awesome provides many ways t' modify th' ay'con\nChange color (by default th' ay'con will inherit th' parent color) Increase or decrease size Rotate Combine wit' other ay'cons Check th' full documentat'n on web fonts wit' CSS fer more.\nExamples Standard Usage Built wit' {{% ay'con heart %}} by Relearrrn an' Cap'n Hugo Built wit' by Relearrrn an' Cap'n Hugo\nAdvanced HTML Usage While th' shortcode simplifies us'n standard ay'cons, th' ay'con customizat'n an' other advanced features o' th' Font Awesome library require ye t' use HTML directly. Paste th' \u003ci\u003e HTML into marrrkup, an' Font Awesome will board th' relevant ay'con.\nBuilt wit' \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearrrn an' Cap'n Hugo Built wit' by Relearrrn an' Cap'n Hugo\nT' use these native HTML elements 'n yer Marrrkdown, add this 'n yer hugo.toml:\n[marrrkup.goldmark.renderer] unsafe = true",
"description": "Nice ay'cons fer yer plank",
"tags": [],
"title": "Icon",
"uri": "/hugo-theme-relearn/pir/shortcodes/icon/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Image.errorlevel",
"uri": "/hugo-theme-relearn/pir/options/image.errorlevel/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Image.errorlevel",
"uri": "/hugo-theme-relearn/pir/frontmatter/image.errorlevel/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: ImageEffects",
"uri": "/hugo-theme-relearn/pir/options/imageeffects/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: ImageEffects",
"uri": "/hugo-theme-relearn/pir/frontmatter/imageeffects/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' include shortcode includes other planks, resources or files from yer project.\nUsage ​ shortcode shortcode (positional) partial {{% include file=\"shortcodes/include/INCLUDE_ME.md\" %}} {{% include \"shortcodes/include/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"page\" . \"file\" \"shortcodes/include/INCLUDE_ME.md\" )}} Th' included files can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.\nParameter Name Posit'n Default Notes file 1 \u003cempty\u003e Th' path t' th' plank, resource or file t' be included. Plank an' resource paths adhere t' Hugo’s logical path. If not found by logical path it falls back t' Hugo’s build-in readFile funct'n hidefirsthead'n 2 false When true an' th' included file contains head'ns, th' first head'n will be hidden. This comes 'n handy, eg. if ye include otherwise standalone Marrrkdown files. Sett'ns Enabl'n Link Warn'ns Opt'n Front Matter Ye can use include.errorlevel t' control what should happen if a local link can not be resolved t' a resource.\nIf not set or empty, any unresolved link be written as given into th' result'n output. If set t' warning th' same happens an' an additional warning be printed 'n th' built console. If set t' error an error message be printed an' th' build be aborted.\nPlease note that this can not resolve files inside o' yer static directory. Th' file must be a resource o' th' plank or th' ship.\nLink warnings be also avail'ble fer images \u0026 links an' th' openapi shortcode.\n​ toml yaml json [include] errorlevel = 'warning' include: errorlevel: warning { \"include\": { \"errorlevel\": \"warning\" } } Examples Arbitrary Rrrambl'n {{% include \"shortcodes/include/INCLUDE_ME.md\" %}} Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc.1 ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)\nEt Cetera (English: /ɛtˈsɛtərə/), abbreviated t' etc., etc, et cet., be a Latin expression that be used 'n English t' mean “and other similar things”, or “and so forth” ↩︎",
"description": "Displays content from other Marrrkdown files",
"tags": [],
"title": "Include",
"uri": "/hugo-theme-relearn/pir/shortcodes/include/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Include.errorlevel",
"uri": "/hugo-theme-relearn/pir/options/include.errorlevel/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Include.errorlevel",
"uri": "/hugo-theme-relearn/pir/frontmatter/include.errorlevel/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: LandingPageName",
"uri": "/hugo-theme-relearn/pir/options/landingpagename/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: LastModifierDisplayName",
"uri": "/hugo-theme-relearn/pir/frontmatter/lastmodifierdisplayname/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: LastModifierEmail",
"uri": "/hugo-theme-relearn/pir/frontmatter/lastmodifieremail/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Link.errorlevel",
"uri": "/hugo-theme-relearn/pir/options/link.errorlevel/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Link.errorlevel",
"uri": "/hugo-theme-relearn/pir/frontmatter/link.errorlevel/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: LinkTitle",
"uri": "/hugo-theme-relearn/pir/options/linktitle/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: LinkTitle",
"uri": "/hugo-theme-relearn/pir/frontmatter/linktitle/index.html"
},
{
"breadcrumb": "Development",
"content": "Semver This project tries t' follow th' semver policy - although not followed 100% 'n th' past.\nUsually an entry o' Break'n on th' What’s new plank causes a new major release number.\nAll other entries on th' What’s new plank will increase th' minor release number.\nReleases result'n 'n a new major or minor number be called main release.\nReleases contain'n bugfixes only, be only increas'n th' patch release number. Those releases don’t result 'n announcements on th' What’s new plank.\nEntries on th' What’s new plank be checked an' enforced dur'n th' version-release GitHub Act'n.\nManag'n Issues Issues be categorized an' managed by assign'n labels t' it.\nOnce work'n on an issue, assign it t' a fitt'n maintainer.\nWhen done, close th' ticket. Once an issue be closed, it needs t' be assigned t' next release milestone.\nA once released ticket be not allowed t' be reopened an' rereleased 'n a different milestone. This would cause th' changelog t' be changed even fer th' milestone th' issue was previously released 'n. Instead write a new ticket.\nManag'n Pull Requests If a PR be merged an' closed it needs an accompanied issue assigned t'. If there be no issue fer a PR, th' maintainer needs t' create one.\nYe can assign multiple PRs t' one issue as long as they belong together.\nUsually set th' same labels an' milestone fer th' PR as fer th' accompanied issue.\nLabels Kind An issue that results 'n changesets must have exactly one o' th' follow'n labels. This needs t' be assigned latest before release.\nLabel Descript'n Changelog section documentat'n Improvements or addit'ns t' documentat'n - discussion This issue was converted t' a discussion - task Maintenance work Maintenance feature New feature or request Features bug Someth'n isn’t work'n Fixes Impact If th' issue would cause a new main release due t' semver semantics it needs one o' th' accord'n labels an' th' match'n badge on th' What’s new plank.\nLabel Descript'n change Introduces changes wit' exist'n installat'ns break'n Introduces break'n changes wit' exist'n installat'ns Declinat'n If an issue does not result 'n changesets but be closed anyways, it must have exactly one o' th' follow'n labels.\nLabel Descript'n duplicate This issue or pull request already exists invalid This doesn’t seem right support Request fer achiev'n a special goal unresolved No progress on this issue update A change 'n behavior after updat wontchange This will not be worked on Halt Ye can assign one further label out o' th' follow'n list t' signal readers that development on an open issue be currently halted fer different reasons.\nLabel Descript'n blocked Depends on other issue t' be fixed first idea A valu'ble idea that’s currently not worked on undecided No decision was made yet helpwanted Great idea, send 'n a PR needsfeedback Further informat'n be needed 3rd-Party If th' issue be not caused by a programm'n error 'n th' themes own code, ye can label th' caus'n program or library.\nLabel Descript'n asciidoc This be a topic related t' process'n o' AsciiDoc browser This be a topic related t' th' browser but not th' theme device This be a topic related t' a certain device hugo This be a topic related t' Cap'n Hugo itself but not th' theme mermaid This be a topic related t' Merrrmaid itself but not th' theme Sett'n Up a Development Environment Git Hooks be used t' automate some tasks. They be stored 'n th' .githooks root folder.\nDocumentat'n fer each hook be contained 'n each file.\nAt least th' pre-commit hook be required, as it updates th' version number on each commit. This helps t' help debugg'n o' user related issues.\nMak'n Releases A release be based on a milestone named like th' release itself - just th' version number, eg: 1.2.3. It’s 'n th' maintainers responsibility t' check semver semantics o' th' milestone’s name prior t' release an' change it if necessary.\nMak'n releases be automated by th' version-release GitHub Act'n. It requires th' version number o' th' milestone that should be released. Th' release will be created from th' main branch o' th' repository.\nTreat released milestones as immut'ble. Don’t rerelease an already released milestone. An already released milestone may already been consumed by yer users.\nDur'n execut'n o' th' act'n a few th'ns be checked. If a check fails th' act'n fails, result'n 'n no new release. Ye can correct th' errors afterwards an' rerun th' act'n.\nTh' follow'n checks will be enforced\nth' milestone exists there be at least one closed issue assigned t' th' milestone all assigned issues fer this milestone be closed if it’s a main release, there must be an accompany'n releasenotes file present 'n th' repo at introduction/releasenotes/\u003cmajor\u003e/\u003cminor\u003e.en.md Aft a successful run o' th' act'n\nth' changelog at introduction/changelog/\u003cmajor\u003e/\u003cminor\u003e/\u003cpatch\u003e.\u003clang\u003e.md be created fer english an' piratish, includ'n miss'n generic upper level files th' CHANGELOG.md be updated th' releasenotes at introduction/releasenotes/\u003cmajor\u003e/\u003cminor\u003e.en.md be updated, includ'n release version an' release date miss'n generic upper level files fer english an' piratish be created th' version number fer th' \u003cmeta generator\u003e be updated th' updated files be committed th' milestone be closed th' repository be tagged wit' th' version number (eg. 1.2.3), th' main version number (eg. 1.2.x) an' th' major version number (eg. 1.x) a new entry 'n th' GitHub release list wit' th' accord'n changelog will be created th' official documentat'n be built an' deployed th' version number fer th' \u003cmeta generator\u003e be updated t' a temporary an' committed (this helps t' determine if users be runn'n directly on th' main branch or be us'n releases) a new milestone fer th' next patch release be created (this can later be renamed t' a main release if necessary)",
"description": "What to know as a maintainer",
"tags": [],
"title": "Maintaining",
"uri": "/hugo-theme-relearn/pir/development/maintaining/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Math",
"uri": "/hugo-theme-relearn/pir/options/math/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Math",
"uri": "/hugo-theme-relearn/pir/frontmatter/math/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "If this be not enough, th' math shortcode helps ye render'n math an' chemical formulae us'n th' MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Usage ​ passthrough codefence shortcode partial $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ```math {align=\"center\"} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"page\" . \"content\" \"$$left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\" \"align\" \"center\" )}} Ye can also use pure Marrrkdown fer writ'n simple math expressions.\nPassthrough rules be only avail'ble by further configurat'n an' has limited features as it does not provide any o' th' below parameter. Nevertheless, it be widely avail'ble 'n other Marrrkdown parsers like GitHub an' therefore be th' recommend rules fer generat'n port'ble Marrrkdown.\nParameter Name Default Notes align center Th' vertical alignment.\nAllowed values be left, center or right. \u003ccontent\u003e \u003cempty\u003e Yer formulae. Sett'ns Provid'n Initializat'n Opt'ns fer th' MathJax Library Opt'n Front Matter Th' MathJax library be configured wit' default sett'ns fer initializat'n.\nYe can overwrite th' sett'ns by provid'n a JSON object 'n mathJaxInitialize. See MathJax’s documentat'n fer all allowed sett'ns.\nKeep 'n mind that initializat'n sett'ns o' yer planks front matter overwrite all sett'ns o' yer configurat'n opt'ns.\n​ toml yaml json mathJaxInitialize = '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' mathJaxInitialize: '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' { \"mathJaxInitialize\": \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" }, { \\\"tex\\\": { \\\"inlineMath\\\": [[\\\"\\\\(\\\", \\\"\\\\)\\\"], [\\\"@\\\", \\\"@\\\"]], displayMath: [[\\\"\\\\[\\\", \\\"\\\\]\\\"], [\\\"@@\\\", \\\"@@\\\"]] }, \\\"options\\\": { \\\"enableMenu\\\": false }\" } Load'n an External Version o' th' MathJax Library Opt'n Front Matter Th' theme uses th' shipped MathJax library by default.\nIn case ye want do use a different version o' th' MathJax library but don’t want t' override th' shipped version, ye can set customMathJaxURL t' th' URL o' th' external MathJax library.\n​ toml yaml json customMathJaxURL = 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js' customMathJaxURL: https://unpkg.com/mathjax/es5/tex-mml-chtml.js { \"customMathJaxURL\": \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" } Force Load'n o' th' MathJax Library Opt'n Front Matter Th' MathJax library will be boarded if th' plank contains a math shortcode or codefence.\nYe can force load'n th' MathJax library if no shortcode or codefence was used by sett'n math=true. If a shortcode or codefence was found, th' opt'n has no effect. This must be set 'n case ye be us'n th' passthrough configurat'n t' render math.\nInstead o' math=true ye can also use th' alias math.force=true.\n​ toml yaml json math = true math: true { \"math\": true } Passthrough Configurat'n Ye can use yer math without enclos'n it 'n a shortcode or codefence by us'n a passthrough configurat'n\nhugo. toml yaml json [marrrkup] [marrrkup.goldmark] [marrrkup.goldmark.extensions] [marrrkup.goldmark.extensions.passthrough] en'ble = true [marrrkup.goldmark.extensions.passthrough.delimiters] block = [['\\[', '\\]'], ['$$', '$$']] inline = [['\\(', '\\)'], ['$', '$']] marrrkup: goldmark: extensions: passthrough: delimiters: block: - - \\[ - \\] - - $$ - $$ inline: - - \\( - \\) - - $ - $ en'ble: true { \"markup\": { \"goldmark\": { \"extensions\": { \"passthrough\": { \"delimiters\": { \"block\": [ [ \"\\\\[\", \"\\\\]\" ], [ \"$$\", \"$$\" ] ], \"inline\": [ [ \"\\\\(\", \"\\\\)\" ], [ \"$\", \"$\" ] ] }, \"enable\": true } } } } } In this case ye have t' force board th' MathJax library either 'n yer hugo.toml or 'n yer page’s front matter as th' theme doesn’t know if math be used.\nSee th' example on how a passthrough configurat'ns makes us'n math really easy.\nExamples Passthrough Block Math Wit' passthrough configurat'n enabled ye can just drop yer math without enclos'n it by shorrrtcodes or codefences but no other parameters be avail'ble.\nIn this case ye have t' force board th' MathJax library by sett'n math=true either 'n yer hugo.toml or 'n yer page’s front matter.\nIn passthrough default configurat'n, block math be generated if ye use two consecutive $$ as a delimiter around yer formulae.\n$$\\left| \\begin{array}{cc} a \u0026 b \\\\ c \u0026 d \\end{array}\\right|$$ $$\\left| \\begin{array}{cc} a \u0026 b \\\\ c \u0026 d \\end{array}\\right|$$Passthrough Inline Math Th' same usage restrict'ns as o' th' previous example apply here as well.\nIn passthrough default configurat'n, inline math be generated if ye use a single $ as a delimiter around yer formulae.\nEuclid already knew, $\\sqrt{2}$ be irrational. Euclid already knew, $\\sqrt{2}$ be irrational.\nCodefence Block Math wit' Right Alignment If ye be us'n codefences, more parameter be avail'ble. Yer formulae still needs t' be enclosed by $ or $$ as delimiters respectively.\n```math {align=\"right\"} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Shortcode Block Math wit' Right Alignment Ye can also use shortcode rules. Yer formulae still needs t' be enclosed by $ or $$ as delimiters respectively.\n{{\u003c math align=\"right\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Chemical Formulae Th' MathJax library can also be used fer chemical formulae.\n$$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$",
"description": "Beaut'fl math and chemical formulae",
"tags": [],
"title": "Math",
"uri": "/hugo-theme-relearn/pir/shortcodes/math/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Math.force",
"uri": "/hugo-theme-relearn/pir/options/math.force/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Math.force",
"uri": "/hugo-theme-relearn/pir/frontmatter/math.force/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: MathJaxInitialize",
"uri": "/hugo-theme-relearn/pir/options/mathjaxinitialize/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MathJaxInitialize",
"uri": "/hugo-theme-relearn/pir/frontmatter/mathjaxinitialize/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MenuPost",
"uri": "/hugo-theme-relearn/pir/frontmatter/menupost/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MenuPre",
"uri": "/hugo-theme-relearn/pir/frontmatter/menupre/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Mermaid.force",
"uri": "/hugo-theme-relearn/pir/options/mermaid.force/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Mermaid.force",
"uri": "/hugo-theme-relearn/pir/frontmatter/mermaid.force/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: MermaidInitialize",
"uri": "/hugo-theme-relearn/pir/options/mermaidinitialize/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MermaidInitialize",
"uri": "/hugo-theme-relearn/pir/frontmatter/mermaidinitialize/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: MermaidZoom",
"uri": "/hugo-theme-relearn/pir/options/mermaidzoom/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: MermaidZoom",
"uri": "/hugo-theme-relearn/pir/frontmatter/mermaidzoom/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like seeing Merrrmaids and stuff.\nTh' mermaid shortcode generates diagrams an' flowcharts from text 'n a similar manner as Marrrkdown us'n th' Merrrmaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Usage ​ codefence shortcode partial ```mermaid {align=\"center\" zoom=\"true\"} graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"page\" . \"content\" \"graph LR;\\n If --\u003e Then\\n Then --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} Codefence rules be widely avail'ble 'n other Marrrkdown parsers like GitHub an' therefore be th' recommend rules fer generat'n port'ble Marrrkdown.\nParameter Name Default Notes align center Th' vertical alignment.\nAllowed values be left, center or right. zoom see notes Whether th' graph be pan- an' zoom'ble.\nIf not set th' value be determined by th' mermaidZoom sett'n o' yer configurat'ns opt'ns or th' planks front matter or false if not set at all.\n- false: no pan or zoom\n- true: pan an' zoom active \u003ccontent\u003e \u003cempty\u003e Yer Merrrmaid graph. Sett'ns Configur'n Pan an' Zoom Opt'n Front Matter Th' generated graphs can be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.\nBy default this be disabled. Set mermaidZoom=true t' en'ble it.\nIndividual sett'ns o' a graphs zoom parameter have precedence over th' page’s front matter an' configurat'n opt'ns 'n that order.\n​ toml yaml json mermaidZoom = true mermaidZoom: true { \"mermaidZoom\": true } Provid'n Initializat'n Opt'ns fer th' Merrrmaid Library Opt'n Front Matter Th' Merrrmaid library be configured wit' default sett'ns fer initializat'n.\nYe can overwrite th' sett'ns by provid'n a JSON object 'n mermaidInitialize. See Mermaid’s documentat'n fer all allowed sett'ns.\nKeep 'n mind that initializat'n sett'ns o' yer planks front matter overwrite all sett'ns o' yer configurat'n opt'ns.\nIn addit'n, ye can merge sett'ns fer each individual graph through diagram directives on top o' th' sett'ns o' yer page’s front matter or configurat'n opt'ns.\n​ toml yaml json mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidInitialize: '{ \"securityLevel\": \"loose\" }' { \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" } Load'n an External Version o' th' Merrrmaid Library Opt'n Front Matter Th' theme uses th' shipped Merrrmaid library by default.\nIn case ye want do use a different version o' th' Merrrmaid library but don’t want t' override th' shipped version, ye can set customMermaidURL t' th' URL o' th' external Merrrmaid library.\n​ toml yaml json customMermaidURL = 'https://unpkg.com/mermaid/dist/mermaid.min.js' customMermaidURL: https://unpkg.com/mermaid/dist/mermaid.min.js { \"customMermaidURL\": \"https://unpkg.com/mermaid/dist/mermaid.min.js\" } Force Load'n o' th' Merrrmaid Library Opt'n Front Matter Th' Merrrmaid library will be boarded if th' plank contains an mermaid shortcode or codefence.\nYe can force load'n th' Merrrmaid library if no shortcode or codefence was used by sett'n mermaid.force=true. If a shortcode or codefence was found, this opt'n has no effect. This comes handy 'n case ye be us'n script'n t' render a graph.\n​ toml yaml json [mermaid] force = true mermaid: force: true { \"mermaid\": { \"force\": true } } Sett'n a Specific Merrrmaid Theme While ye can configure th' Merrrmaid theme t' render yer graph by us'n one o' th' initializat'n opt'ns, th' recommended way be t' set th' default value us'n th' --MERMAID-theme vari'ble 'n yer color variant stylesheet. This allows yer graphs t' look pretty when th' user switches th' color variant.\nExamples Flowchart wit' YAML-Title ```mermaid --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] ``` --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] Sequence Diagram wit' Configurat'n Directive ```mermaid %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! ``` %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! Class Diagram ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } ``` classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } State Diagram Aligned t' th' Right Us'n Shortcode Rules {{\u003c mermaid align=\"right\" \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open {{\u003c /mermaid \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open Entity Relationship Model wit' Non-Default Merrrmaid Theme ```mermaid %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" ``` %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" User Journey ```mermaid journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me ``` journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me GANTT Chart ```mermaid gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, after des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d ``` gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, after des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d Pie Chart without Zoom ```mermaid {zoom=\"false\"} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 ``` pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 Quadrant Chart ```mermaid quadrantChart title Reach an' engagement o' campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need t' promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] ``` quadrantChart title Reach an' engagement o' campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need t' promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] Requirement Diagram ```mermaid requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req ``` requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req Git Graph ```mermaid gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit ``` gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit C4 Diagrams ```mermaid C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") ``` C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") Mindmaps ```mermaid mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisat'n British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creat'n Uses Creative techniques Strategic plann'n Argument mapp'n Tools Pen an' paper Merrrmaid ``` mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisat'n British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creat'n Uses Creative techniques Strategic plann'n Argument mapp'n Tools Pen an' paper Merrrmaid Timeline ```mermaid timeline title History o' Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter ``` timeline title History o' Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter Sankey ```mermaid sankey-beta %% source,target,value Electricity grid,Over generat'n / exports,104.453 Electricity grid,Heat'n an' cool'n - homes,113.726 Electricity grid,H2 conversion,27.14 ``` sankey-beta %% source,target,value Electricity grid,Over generat'n / exports,104.453 Electricity grid,Heat'n an' cool'n - homes,113.726 Electricity grid,H2 conversion,27.14 XYChart ```mermaid xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] ``` xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] Block Diagram ```mermaid block-beta columns 1 db((\"DB\")) blockArrowId6\u003c[\"\u0026nbsp;\u0026nbsp;\u0026nbsp;\"]\u003e(down) block:ID A B[\"A wide one 'n th' middle\"] C end space D ID --\u003e D C --\u003e D style B fill:#969,stroke:#333,stroke-width:4px ``` block-beta columns 1 db((\"DB\")) blockArrowId6\u003c[\"\u0026nbsp;\u0026nbsp;\u0026nbsp;\"]\u003e(down) block:ID A B[\"A wide one 'n th' middle\"] C end space D ID --\u003e D C --\u003e D style B fill:#969,stroke:#333,stroke-width:4px Packet ```mermaid --- title: \"TCP Packet\" --- packet-beta 0-15: \"Source Port\" 16-31: \"Destinat'n Port\" 32-63: \"Sequence Number\" 64-95: \"Acknowledgment Number\" 96-99: \"Data Offset\" 100-105: \"Reserved\" 106: \"URG\" 107: \"ACK\" 108: \"PSH\" 109: \"RST\" 110: \"SYN\" 111: \"FIN\" 112-127: \"Window\" 128-143: \"Checksum\" 144-159: \"Urgent Pointer\" 160-191: \"(Opt'ns an' Padding)\" 192-255: \"Data (vari'ble length)\" ``` --- title: \"TCP Packet\" --- packet-beta 0-15: \"Source Port\" 16-31: \"Destinat'n Port\" 32-63: \"Sequence Number\" 64-95: \"Acknowledgment Number\" 96-99: \"Data Offset\" 100-105: \"Reserved\" 106: \"URG\" 107: \"ACK\" 108: \"PSH\" 109: \"RST\" 110: \"SYN\" 111: \"FIN\" 112-127: \"Window\" 128-143: \"Checksum\" 144-159: \"Urgent Pointer\" 160-191: \"(Opt'ns an' Padding)\" 192-255: \"Data (vari'ble length)\" Architecture ```mermaid architecture-beta group api(cloud)[API] service db(database)[Database] 'n api service disk1(disk)[Storage] 'n api service disk2(disk)[Storage] 'n api service server(server)[Server] 'n api db:L -- R:server disk1:T -- B:server disk2:T -- B:db ``` architecture-beta group api(cloud)[API] service db(database)[Database] 'n api service disk1(disk)[Storage] 'n api service disk2(disk)[Storage] 'n api service server(server)[Server] 'n api db:L -- R:server disk1:T -- B:server disk2:T -- B:db",
"description": "Generrrat'n o' diagrrram an' flowcharrrt frrrom text",
"tags": [],
"title": "Merrrmaid",
"uri": "/hugo-theme-relearn/pir/shortcodes/mermaid/index.html"
},
{
"breadcrumb": "Tag-a-taggs",
"content": "",
"description": "",
"tags": [],
"title": "Tagga :: Non-Hidden",
"uri": "/hugo-theme-relearn/pir/tags/non-hidden/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' notice shortcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.\nThere may be pirates It be all about th' boxes.\nUsage ​ callout shortcode shortcode (positional) partial \u003e [!primary] There may be pirates \u003e It be all about th' boxes. {{% notice style=\"primary\" title=\"There may be pirates\" ay'con=\"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{ partial \"shortcodes/notice.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"There may be pirates\" \"icon\" \"skull-crossbones\" \"content\" \"It be all about th' boxes.\" )}} Callout rules has limited features as it does not provide all o' th' below parameter. Nevertheless, it be widely avail'ble 'n other Marrrkdown parsers like wit' GitHub alerts or Obsidian callouts an' therefore be th' recommend rules fer generat'n port'ble Marrrkdown.\nIf ye want t' display a transparent expand'ble box without any border, ye can also use th' expand shortcode.\nParameter Name Posit'n Default Notes style 1 default Th' style scheme used fer th' box.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYe can also define yer own styles. color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color\nThis be not avail'ble us'n callout rules. title 2 see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con 3 see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces)\nThis be not avail'ble us'n callout rules. expanded \u003cempty\u003e Whether t' draw an expander an' how th' rrrambl'n be displayed.\n- \u003cempty\u003e: no expander be drawn an' th' rrrambl'n be permanently shown\n- true: th' expander be drawn an' th' rrrambl'n be initially shown\n- false: th' expander be drawn an' th' rrrambl'n be initially hidden \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed 'n box. Sett'ns Defin'n own Styles Opt'n Besides th' predefined style values from above, ye be able t' define yer own.\nhugo. toml yaml json [params] [[params.boxStyle]] color = 'gold' i18n = '' ay'con = 'rainbow' identifier = 'magic' title = 'Magic' params: boxStyle: - color: gold i18n: \"\" ay'con: rainbow identifier: magic title: Magic { \"params\": { \"boxStyle\": [ { \"color\": \"gold\", \"i18n\": \"\", \"icon\": \"rainbow\", \"identifier\": \"magic\", \"title\": \"Magic\" } ] } } Th' style parameter used 'n a shortcode must match th' identifier 'n th' configurat'n. Th' title fer th' style will be determined from th' configured title. If no title but a i18n be set, th' title will be taken from th' translat'n files by that key. Th' title may be empty 'n which case, th' box does not contain a default title. ay'con an' color be work'n similar.\nYe can also redefine th' predefined styles if you’re not satisfied wit' th' default values.\nBelow be a usage example.\nExamples By Severity Us'n Callout Rules \u003e [!CAUTION] \u003e Advises about risks or negative outcomes o' certain act'ns. \u003e [!IMPORTANT] \u003e Key informat'n users need t' know t' achieve their goal. \u003e [!INFO] \u003e Informat'n that users \u003cins\u003e_might_\u003c/ins\u003e find interest'n. \u003e [!NOTE] \u003e Useful informat'n that users should know, even when skimm'n rrrambl'n. \u003e [!TIP] \u003e Helpful advice fer do'n th'ns better or more easily. \u003e [!WARNING] \u003e Urgent info that needs immediate user attent'n t' avoid problems. Caut'n Advises about risks or negative outcomes o' certain act'ns.\nImportant Key informat'n users need t' know t' achieve their goal.\nAhoi Informat'n that users might find interest'n.\nAvast Useful informat'n that users should know, even when skimm'n rrrambl'n.\nSmarrrt Arrrse Helpful advice fer do'n th'ns better or more easily.\nArrr Urgent info that needs immediate user attent'n t' avoid problems.\nBy Brand Colors wit' Title an' Ay'con Variant'n {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} {{% notice style=\"secondary\" title=\"Secondary\" %}} A **secondary** disclaimer {{% /notice %}} {{% notice style=\"accent\" ay'con=\"stopwatch\" %}} An **accent** disclaimer {{% /notice %}} Primary A primary disclaimer\nSecondary A secondary disclaimer\nAn accent disclaimer\nBy Color {{% notice style=\"blue\" title=\"Blue\"%}} A **blue** disclaimer {{% /notice %}} {{% notice style=\"cyan\" title=\"Cyan\" %}} A **cyan** disclaimer {{% /notice %}} {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} {{% notice style=\"grey\" ay'con=\"bug\" %}} A **grey** disclaimer {{% /notice %}} {{% notice style=\"magenta\" title=\"Magenta\" %}} A **magenta** disclaimer {{% /notice %}} {{% notice style=\"orange\" title=\"Orange\" ay'con=\"bug\" %}} A **orange** disclaimer {{% /notice %}} {{% notice style=\"red\" title=\"Red\" %}} A **red** disclaimer {{% /notice %}} Blue A blue disclaimer\nCyan A cyan disclaimer\nGreen A green disclaimer\nA grey disclaimer\nMagenta A magenta disclaimer\nOrange A orange disclaimer\nRed A red disclaimer\nBy Special Color {{% notice style=\"default\" title=\"Default\" ay'con=\"skull-crossbones\" %}} Just some grey default color. {{% /notice %}} {{% notice style=\"code\" title=\"Code\" ay'con=\"skull-crossbones\" %}} Colored like a code fence. {{% /notice %}} {{% notice style=\"transparent\" title=\"Transparent\" ay'con=\"skull-crossbones\" %}} No vis'ble borders. {{% /notice %}} Default Just some grey default color.\nCode Colored like a code fence.\nTransparent No vis'ble borders.\nVarious Features Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown 'n Title an' Rrrambl'n {{% notice color=\"fuchsia\" title=\"**Hugo** be _awesome_\" ay'con=\"fa-fw fab fa-hackerrank\" %}} Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even **_bold emphasized_** text - [links](https://example.com) - etc.[^etc] [^etc]: Et Cetera (English: /ɛtˈsɛtərə/), abbreviated t' etc., etc, et cet., be a Latin expression that be used 'n English t' mean \"and other similar things\", or \"and so forth\" ```plaintext ...and even source code ``` \u003e th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work) {{% /notice %}} Cap'n Hugo be awesome Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc.1 ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)\nEt Cetera (English: /ɛtˈsɛtərə/), abbreviated t' etc., etc, et cet., be a Latin expression that be used 'n English t' mean “and other similar things”, or “and so forth” ↩︎\nExpand'ble Rrrambl'n Area {{% notice style=\"green\" title=\"Expand me...\" expanded=\"true\" %}} No need t' press ye! {{% /notice %}} {{% notice style=\"red\" title=\"Expand me...\" expanded=\"false\" %}} Thank ye! {{% /notice %}} Expand me… No need t' press ye!\nExpand me… Thank ye!\nNo Rrrambl'n or No Title {{% notice style=\"accent\" title=\"Just a bar\" %}} {{% /notice %}} {{% notice style=\"accent\" %}} Just a box {{% /notice %}} Just a bar Just a box\nVarious Callouts \u003e [!caut'n] Callouts can have custom titles \u003e Like this one. \u003e [!caut'n] Title-only callout \u003e [!note]- Be callouts fold'ble? \u003e Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed \u003e [!note]+ Be callouts fold'ble? \u003e Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed \u003e [!info] Can callouts be nested? \u003e \u003e [!important] Yes!, they can. \u003e \u003e \u003e [!tip] Ye can even use multiple layers o' nest'n. Callouts can have custom titles Like this one.\nTitle-only callout Be callouts fold'ble? Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed\nBe callouts fold'ble? Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed\nCan callouts be nested? Yes!, they can. Ye can even use multiple layers o' nest'n. Code wit' Collapsed Colored Borders \u003e [!secondary] \u003e ```c \u003e // Wit' colored border 'n Marrrkdown rules \u003e printf(\"Hello World!\"); \u003e ``` {{% notice style=\"red\" %}} ```c // Wit' colored border 'n Shortcode rules printf(\"Hello World!\"); ``` {{% /notice %}} // Wit' colored border 'n Marrrkdown rules printf(\"Hello World!\"); // Wit' colored border 'n Shortcode rules printf(\"Hello World!\"); User-defined Style Self-defined styles can be configured 'n yer hugo.toml an' used fer every shortcode, that accepts a style parameter.\n\u003e [!magic] \u003e Maaagic! Magic Maaagic!",
"description": "Disclaimers to help you structure your page",
"tags": [],
"title": "Notice",
"uri": "/hugo-theme-relearn/pir/shortcodes/notice/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' openapi shortcode displays yer OpenAPI / Swagger specificat'ns us'n th' Swagger UI library.\nUsage ​ shortcode partial {{\u003c openapi src=\"https://petstore3.openapi.io/api/v3/openapi.json\" \u003e}} {{ partial \"shortcodes/openapi.html\" (dict \"page\" . \"src\" \"https://petstore3.openapi.io/api/v3/openapi.json\" )}} If ye want t' print out (or generate a PDF) from yer OpenAPI documentat'n, don’t initiate print'n directly from th' plank because th' elements be optimized fer interactive usage 'n a browser.\nInstead, open th' print preview 'n yer browser an' initiate print'n from that plank. This plank be optimized fer read'n an' expands most o' th' avail'ble sections.\nParameter Name Default Notes src \u003cempty\u003e Th' path t' th' t' th' OpenAPI specificat'n resource or URL t' be used. Resource paths adhere t' Hugo’s logical path. Sett'ns Enabl'n Link Warn'ns Opt'n Front Matter Ye can use openapi.errorlevel t' control what should happen if a local OpenAPI specificat'n link can not be resolved t' a resource.\nIf not set or empty, any unresolved link be written as given into th' result'n output. If set t' warning th' same happens an' an additional warning be printed 'n th' built console. If set t' error an error message be printed an' th' build be aborted.\nPlease note that this can not resolve files inside o' yer static directory. Th' file must be a resource o' th' plank or th' ship.\nLink warnings be also avail'ble fer images \u0026 links an' th' include shortcode.\n​ toml yaml json [openapi] errorlevel = 'warning' openapi: errorlevel: warning { \"openapi\": { \"errorlevel\": \"warning\" } } Load'n an External Version o' th' Swagger UI Library Opt'n Front Matter Th' theme uses th' shipped Swagger UI library by default.\nIn case ye want do use a different version o' th' Swagger UI library but don’t want t' override th' shipped version, ye can set customOpenapiURL t' th' URL o' th' external Swagger UI library.\n​ toml yaml json customOpenapiURL = 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js' customOpenapiURL: https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js { \"customOpenapiURL\": \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" } Force Load'n o' th' Swagger UI Library Opt'n Front Matter Th' Swagger UI library will be boarded if th' plank contains an openapi shortcode or codefence.\nYe can force load'n th' Swagger UI library if no shortcode or codefence was used by sett'n openapi.force=true. If a shortcode or codefence was found, th' opt'n has no effect. This comes handy 'n case ye be us'n script'n t' render a spec.\n​ toml yaml json [openapi] force = true openapi: force: true { \"openapi\": { \"force\": true } } Sett'n a Specific Swagger UI Theme Th' recommended way t' configure yer Swagger UI theme be t' set th' default value us'n th' --OPENAPI-theme vari'ble 'n yer color variant stylesheet. This allows yer specs t' look pretty when th' user switches th' color variant.\nExample Us'n Local File {{\u003c openapi src=\"petstore.json\" \u003e}}",
"description": "UI fer yer OpenAPI / Swaggerrr Specificat'ns",
"tags": [],
"title": "OpenAPI",
"uri": "/hugo-theme-relearn/pir/shortcodes/openapi/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Openapi.errorlevel",
"uri": "/hugo-theme-relearn/pir/options/openapi.errorlevel/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Openapi.errorlevel",
"uri": "/hugo-theme-relearn/pir/frontmatter/openapi.errorlevel/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Openapi.force",
"uri": "/hugo-theme-relearn/pir/options/openapi.force/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Openapi.force",
"uri": "/hugo-theme-relearn/pir/frontmatter/openapi.force/index.html"
},
{
"breadcrumb": "",
"content": "",
"description": "",
"tags": [],
"title": "Options",
"uri": "/hugo-theme-relearn/pir/options/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Ordersectionsby",
"uri": "/hugo-theme-relearn/pir/options/ordersectionsby/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Ordersectionsby",
"uri": "/hugo-theme-relearn/pir/frontmatter/ordersectionsby/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1",
"content": "This be a demo child plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1 (hidden) plank 1-1-2 (headless) plank 1-1-3",
"description": "This be a demo child plank",
"tags": [
"Children",
"Non-Hidden"
],
"title": "plank 1-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1",
"content": "This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode as long as ye aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1",
"description": "This be a hidden demo child plank",
"tags": [
"Children",
"hush, matey"
],
"title": "plank 1-1-1 (hidden)",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1 \u003e plank 1-1-1 (hidden)",
"content": "This be a non-hidden demo child plank o' a hidden parent plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1-1-1 (hidden)",
"description": "This be a non-hidden demo child plank o' a hidden parrrent plank",
"tags": [
"Children",
"hush, matey"
],
"title": "plank 1-1-1-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1 \u003e plank 1-1-1 (hidden) \u003e plank 1-1-1-1",
"content": "This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode as long as ye aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1-1-1",
"description": "This be a hidden demo child plank",
"tags": [
"Children",
"hush, matey"
],
"title": "plank 1-1-1-1-1 (hidden)",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1 \u003e plank 1-1-1 (hidden) \u003e plank 1-1-1-1 \u003e plank 1-1-1-1-1 (hidden)",
"content": "This be a non-hidden demo child plank o' a hidden parent plank.",
"description": "This be a non-hidden demo child plank on a hidden parrrent plank",
"tags": [
"Children",
"hush, matey"
],
"title": "plank 1-1-1-1-1-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1 \u003e plank 1-1-2 (headless)",
"content": "This be a plain demo child plank 1-1-2-1.",
"description": "This be a demo child plank",
"tags": [
"Children",
"Non-Hidden"
],
"title": "plank 1-1-2-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1 \u003e plank 1-1-2 (headless)",
"content": "This be a plain demo child plank 1-1-2-2.",
"description": "This be a demo child plank",
"tags": [
"Children",
"Non-Hidden"
],
"title": "plank 1-1-2-2",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1",
"content": "This be a plain demo child plank 1-1-3.",
"description": "This be a demo child plank",
"tags": [
"Children",
"Non-Hidden"
],
"title": "plank 1-1-3",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html"
},
{
"breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 3",
"content": "This be a plain demo child plank 3-1.",
"description": "This be a plain plank test nested 'n a parrrent",
"tags": [
"Children",
"Non-Hidden"
],
"title": "plank 3-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/index.html"
},
{
"breadcrumb": "Categorrries",
"content": "",
"description": "",
"tags": [],
"title": "Categorrry :: Reference",
"uri": "/hugo-theme-relearn/pir/categories/reference/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Relearn.dependencies",
"uri": "/hugo-theme-relearn/pir/options/relearn.dependencies/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Attachments hugo.png (17 KB) MaybeTreasure.txt (31 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Th' resources shortcode displays links t' resources contained 'n a plank bundle.\nAttachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Usage ​ shortcode partial {{% resources sort=\"asc\" /%}} {{ partial \"shortcodes/resources.html\" (dict \"page\" . \"sort\" \"asc\" )}} Multilanguage features be not supported directly by th' shortcode but rely on Hugo’s handl'n fer resource translat'ns applied when th' theme iterates over all avail'ble resources.\nParameter Name Default Notes style transparent Th' style scheme used fer th' box.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYe can also define yer own styles. color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: Resources\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: paperclip\nIf ye want no ay'con, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) expanded \u003cempty\u003e Whether t' draw an expander an' how th' resource list be displayed.\n- \u003cempty\u003e: no expander be drawn an' th' resource list be permanently shown\n- true: th' expander be drawn an' th' resource list be initially shown\n- false: th' expander be drawn an' th' resource list be initially hidden sort asc Sort'n th' output 'n ascend'n or descend'n order. pattern .* A regular expressions, used t' filter th' resources by name. For example:\n- t' match a file suffix o' ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- t' match file names end'n 'n jpg or png, use .*\\.(jpg|png) Examples Custom Title, List o' Resources End'n 'n png, jpg or gif {{% resources title=\"Related **files**\" pattern=\".*\\.(png|jpg|gif)\" /%}} Related files hugo.png (17 KB) Ahoi Styled Box, Descend'n Sort Order {{% resources style=\"info\" sort=\"desc\" /%}} Ahoi Treasure.pir.txt (31 B) NoTreasure.en.txt (23 B) MaybeTreasure.txt (23 B) hugo.png (17 KB) Wit' User-Defined Color an' Font Awesome Brand Ay'con {{% resources color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" /%}} Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Expander wit' Initially Hidden Resource List {{% resources style=\"primary\" expanded=\"false\" /%}} Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Style, Color, Title an' Ay'cons For further examples fer style, color, title an' ay'con, see th' notice shortcode documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.",
"description": "List Rrresources shorrrtcode contained in a plank bundle",
"tags": [],
"title": "Resources",
"uri": "/hugo-theme-relearn/pir/shortcodes/resources/index.html"
},
{
"breadcrumb": "Development",
"content": "Sometimes screenshots need t' be redone. This plank explains how t' create th' different screenshots, tools an' sett'ns\nCommon Creat'n:\nUse English translat'n Empty search Remove history checkmarks but leave it on th' plank thats used fer th' screenshot Aft resize o' th' plank into th' required resolut'n, reload th' plank t' have all scrollbars 'n default load'n posit'n Demo Screenshot Rrrambl'n:\nA meaningful full-screen screenshot o' an interest'n plank.\nTh' rrrambl'n should be:\ntimeless: not show'n any dates or often edited rrrambl'n interest'n: show a bunch o' interest'n elements like head'ns, code, etc balanced: no clutter'n wit' overpresent elements or color'n aligned: aligned outlines Used by:\nCap'n Hugo Themes info: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1000 x 1500 @ 1 (images/screenshot.png) Cap'n Hugo Themes gallery: https://themes.gohugo.io/tags/docs/ 900 x 600 @ 1 (images/tn.png) Plank URL: Screenshot Link\nCreat'n:\nsave as images/screenshot.png from original screenshot, scale t' 900 x 600 an' save as images/tn.png Remarks:\nTh' locat'ns be mandatory due t' Hugo’s theme ship builder.\nPreview images/screenshot.png:\nPreview images/tn.png:\nHero Image Rrrambl'n:\nShow th' Demo Screenshot plank on different devices an' different themes. Composit'n o' th' different device screenshots into a template.\nTh' rrrambl'n should be:\nconsistent: always use th' same plank fer all devices pleas'n: use a delightful background Used by:\nCap'n Hugo Themes notes: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1280 x 640 GitHub project ship: https://github.com/McShelby/hugo-theme-relearn 1280 x 640 GitHub social media preview: https://github.com/McShelby/hugo-theme-relearn/sett'ns 1280 x 640 Plank URL: Hero Image Link\nCreat'n:\nTemplate: http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase Desktop: light theme 1440 x 900 @ 1 Tablet: light theme 778 x 1038 @ 1 Phone: dark theme 450 x 801 @ .666 From original template resize t' 3000 x 1500 offset y: -330, scale t' 1280 x 640 an' save as images/hero.png Preview images/hero.png:",
"description": "Recipe t' create various documentat'n scrrreenshots",
"tags": [],
"title": "Scrrrenshots",
"uri": "/hugo-theme-relearn/pir/development/screenshots/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: SearchIndexURL",
"uri": "/hugo-theme-relearn/pir/options/searchindexurl/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: SearchPageURL",
"uri": "/hugo-theme-relearn/pir/options/searchpageurl/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: ShowVisitedLinks",
"uri": "/hugo-theme-relearn/pir/options/showvisitedlinks/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: Sidebarmenus",
"uri": "/hugo-theme-relearn/pir/options/sidebarmenus/index.html"
},
{
"breadcrumb": "Front Matter",
"content": "",
"description": "",
"tags": [],
"title": "Front Matter :: Sidebarmenus",
"uri": "/hugo-theme-relearn/pir/frontmatter/sidebarmenus/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' siteparam shortcode prints values o' params contained 'n yer hugo.toml.\nUsage ​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Posit'n Default Notes name 1 \u003cempty\u003e Th' name o' th' ship param t' be displayed. Examples editURL `editURL` value: {{% siteparam name=\"editURL\" %}} editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\nNested Parameter wit' Marrrkdown an' HTML Formatt'n T' use formatted parameter, add this 'n yer hugo.toml:\nhugo. toml yaml json [marrrkup] [marrrkup.goldmark] [marrrkup.goldmark.renderer] unsafe = true marrrkup: goldmark: renderer: unsafe: true { \"markup\": { \"goldmark\": { \"renderer\": { \"unsafe\": true } } } } Now values contain'n Marrrkdown will be formatted correctly.\nhugo. toml yaml json [params] [params.siteparam] [params.siteparam.test] text = 'A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting' params: siteparam: test: text: A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatt'n { \"params\": { \"siteparam\": { \"test\": { \"text\": \"A **nested** parameter \\u003cb\\u003ewith\\u003c/b\\u003e formatting\" } } } } Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}} Formatted parameter: A nested opt'n \u003cb\u003ewith\u003c/b\u003e formatt'n",
"description": "Get value o' ship parrrams",
"tags": [],
"title": "SiteParam",
"uri": "/hugo-theme-relearn/pir/shortcodes/siteparam/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Ye can use a tab shortcode t' display a single tab wit' a title.\n​ c printf(\"Hello World!\"); Usage ​ shortcode partial {{% tab title=\"c\" %}} ```c printf(\"Hello World!\"); ``` {{% /tab %}} {{ partial \"shortcodes/tab.html\" (dict \"page\" . \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\")\\n```\" | .RenderStr'n) )}} If ye want multiple tabs grouped together ye can wrap yer tabs into th' tabs shortcode.\nIf ye want further opt'ns when us'n a single code tab, ye can also use th' highlight shortcode.\nParameter Name Default Notes style see notes Th' style scheme used fer th' tab. If ye don’t set a style an' ye display a single code block inside o' th' tab, its default styl'n will adapt t' that o' a code block. Otherwise default be used.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code\nYe can also define yer own styles. color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary title fer th' tab. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed 'n th' tab. Examples Single Code Block wit' Collapsed Margins {{% tab title=\"Code\" %}} ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Code printf(\"Hello World!\"); Mixed Marrrkdown Rrrambl'n {{% tab title=\"_**Mixed**_\" %}} A tab can not only contain code but arbitrary text. In this case text **an'** code will get a margin. ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Mixed A tab can not only contain code but arbitrary text. In this case text an' code will get a margin.\nprintf(\"Hello World!\"); Understand'n style an' color Behavior Th' style parameter affects how th' color parameter be applied.\n{{\u003c tabs \u003e}} {{% tab title=\"just colored style\" style=\"blue\" %}} Th' `style` parameter be set t' a color style. This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant. {{% /tab %}} {{% tab title=\"just color\" color=\"blue\" %}} Only th' `color` parameter be set. This will set th' background t' a lighter version o' th' chosen CSS color value. {{% /tab %}} {{% tab title=\"default style an' color\" style=\"default\" color=\"blue\" %}} Th' `style` parameter affects how th' `color` parameter be applied. Th' `default` style will set th' background t' yer `--MAIN-BG-color` as configured fer yer theme variant resembl'n th' default style but wit' different color. {{% /tab %}} {{% tab title=\"just severity style\" style=\"info\" %}} Th' `style` parameter be set t' a severity style. This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant an' also affects th' chosen ay'con. {{% /tab %}} {{% tab title=\"severity style an' color\" style=\"info\" color=\"blue\" %}} Th' `style` parameter affects how th' `color` parameter be applied. This will set th' background t' a lighter version o' th' chosen CSS color value an' also affects th' chosen ay'con. {{% /tab %}} {{\u003c /tabs \u003e}} ​ just colored style just color default style an' color just severity style severity style an' color Th' style parameter be set t' a color style.\nThis will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant.\nOnly th' color parameter be set.\nThis will set th' background t' a lighter version o' th' chosen CSS color value.\nTh' style parameter affects how th' color parameter be applied.\nTh' default style will set th' background t' yer --MAIN-BG-color as configured fer yer theme variant resembl'n th' default style but wit' different color.\nTh' style parameter be set t' a severity style.\nThis will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant an' also affects th' chosen ay'con.\nTh' style parameter affects how th' color parameter be applied.\nThis will set th' background t' a lighter version o' th' chosen CSS color value an' also affects th' chosen ay'con.",
"description": "Show rrrambl'n 'n a single tab",
"tags": [],
"title": "Tab",
"uri": "/hugo-theme-relearn/pir/shortcodes/tab/index.html"
},
{
"breadcrumb": "Shorrrtcodes",
"content": "Th' tabs shortcode displays arbitrary rrrambl'n 'n an unlimited number o' tabs.\nhello. py sh c print(\"Hello World!\") echo \"Hello World!\" printf(\"Hello World!\"); Usage ​ shortcode partial {{\u003c tabs title=\"hello.\" \u003e}} {{% tab title=\"py\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab title=\"sh\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{% tab title=\"c\" %}} ```c printf\"Hello World!\"); ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{ partial \"shortcodes/tabs.html\" (dict \"page\" . \"title\" \"hello.\" \"content\" (slice (dict \"title\" \"py\" \"content\" (\"```python\\nprint(\\\"Hello World!\\\")\\n```\" | .RenderStr'n) ) (dict \"title\" \"sh\" \"content\" (\"```bash\\necho \\\"Hello World!\\\"\\n```\" | .RenderStr'n) ) (dict \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\");\\n```\" | .RenderStr'n) ) ) )}} If ye just want a single tab ye can instead call th' tab shortcode standalone.\nAlso follow th' above link t' see th' parameter fer a nested tab.\nParameter Name Default Notes groupid \u003crandom\u003e Arbitrary name o' th' group th' tab view belongs t'.\nTab views wit' th' same groupid sychr'nize their selected tab. Th' tab select'n be restored automatically based on th' groupid fer tab view. If th' selected tab can not be found 'n a tab group th' first tab be selected instead.\nThis sychronizat'n applies t' th' whole ship! style \u003cempty\u003e Sets a default value fer every contained tab. Can be overridden by each tab. See th' tab shortcode fer poss'ble values. color \u003cempty\u003e Sets a default value fer every contained tab. Can be overridden by each tab. See th' tab shortcode fer poss'ble values. title \u003cempty\u003e Arbitrary title written 'n front o' th' tab view. ay'con \u003cempty\u003e Font Awesome ay'con name set t' th' left o' th' title. \u003ccontent\u003e \u003cempty\u003e Arbitrary number o' tabs defined wit' th' tab sub-shortcode. Examples Behavior o' th' groupid See what happens t' th' tab views while ye select different tabs.\nWhile press'n a tab o' Group A switches all tab views o' Group A 'n sync (if th' tab be available), th' tabs o' Group B be left untouched.\n​ Group A, Tab View 1 Group A, Tab View 2 Group B {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"_**XML**_ stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{% tab title=\"text\" %}} Hello World {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"b\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} Group A, Tab View 1 ​ json XML stuff text 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello World Group A, Tab View 2 ​ json XML stuff 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Group B ​ json XML stuff 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Nested Tab Views an' Color In case ye want t' nest tab views, th' parent tab that contains nested tab views needs t' be declared wit' {{\u003c tab \u003e}} instead o' {{% tab %}}. Avast, that 'n this case it be not poss'ble t' put markdown 'n th' parent tab.\nYe can also set style an' color parameter fer all tabs an' overwrite them on tab level. See th' tab shortcode fer poss'ble values.\n{{\u003c tabs groupid=\"main\" style=\"primary\" title=\"Rationale\" ay'con=\"thumbtack\" \u003e}} {{\u003c tab title=\"Text\" \u003e}} Simple text be poss'ble here... {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab title=\"python\" %}} Python be **super** easy. - most o' th' time. - if ye don't want t' output unicode {{% /tab %}} {{% tab title=\"bash\" %}} Bash be fer **hackers**. {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c tab title=\"Code\" style=\"default\" color=\"darkorchid\" \u003e}} ...but no markdown {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab title=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab title=\"bash\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c /tabs \u003e}} Rationale Text Code Simple text be poss'ble here... ​ python bash Python be super easy.\nmost o' th' time. if ye don’t want t' output unicode Bash be fer hackers.\n...but no markdown ​ python bash print(\"Hello World!\") echo \"Hello World!\"",
"description": "Show rrrambl'n 'n tabbed views",
"tags": [],
"title": "Tabs",
"uri": "/hugo-theme-relearn/pir/shortcodes/tabs/index.html"
},
{
"breadcrumb": "",
"content": "Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. As well ye can define optional title an' singulartitle that will override th' values from yer hugo.toml or o' yer translat'n files.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.",
"description": "Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. As well ye can define optional title an' singulartitle that will override th' values from yer hugo.toml or o' yer translat'n files.",
"tags": [],
"title": "Tag-a-taggs",
"uri": "/hugo-theme-relearn/pir/tags/index.html"
},
{
"breadcrumb": "Tag-a-taggs",
"content": "",
"description": "",
"tags": [],
"title": "Tagga :: Taxonomy",
"uri": "/hugo-theme-relearn/pir/tags/taxonomy/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: ThemeVariant",
"uri": "/hugo-theme-relearn/pir/options/themevariant/index.html"
},
{
"breadcrumb": "Options",
"content": "",
"description": "",
"tags": [],
"title": "Option :: TitleSeparator",
"uri": "/hugo-theme-relearn/pir/options/titleseparator/index.html"
},
{
"breadcrumb": "Categorrries",
"content": "",
"description": "",
"tags": [],
"title": "Categorrry :: Tutorial",
"uri": "/hugo-theme-relearn/pir/categories/tutorial/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 1",
"content": "1.0.1 (2021-07-01) Maintenance [task] Prepare fer hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1",
"description": "1.0.1 (2021-07-01) Maintenance [task] Prepare fer hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1",
"tags": [],
"title": "Version 1.0",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/1/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 1",
"content": "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.",
"description": "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.",
"tags": [],
"title": "Version 1.0",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/1/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 2",
"content": "2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styl'n #65 [feature] theme: improve readability #64 [feature] menu: show hidden planks if accessed directly #60 [feature][change] theme: treat planks without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates fer pre/post menu entries #56 [feature] theme: make chapter archetype more read'ble #55 [feature] children: add parameter fer container style #53 [feature] theme: make rrrambl'n a template #50 [feature] menu: control menu expansion wit' alwaysopen parameter #49 [feature] include: new shortcode t' include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highlighter: switch t' standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sort'n ignores ordersectionsby #63 [bug][change] children: default sort'n ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden planks #61 [bug] theme: remove superfluous singular taxonomy from taxonomy title #46 [bug][change] theme: miss'n –MENU-HOME-LINK-HOVER-color 'n documentat'n #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog 'n exampleSite #33",
"description": "2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styl'n #65 [feature] theme: improve readability #64 [feature] menu: show hidden planks if accessed directly #60 [feature][change] theme: treat planks without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates fer pre/post menu entries #56 [feature] theme: make chapter archetype more read'ble #55 [feature] children: add parameter fer container style #53 [feature] theme: make rrrambl'n a template #50 [feature] menu: control menu expansion wit' alwaysopen parameter #49 [feature] include: new shortcode t' include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highlighter: switch t' standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sort'n ignores ordersectionsby #63 [bug][change] children: default sort'n ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden planks #61 [bug] theme: remove superfluous singular taxonomy from taxonomy title #46 [bug][change] theme: miss'n –MENU-HOME-LINK-HOVER-color 'n documentat'n #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog 'n exampleSite #33",
"tags": [],
"title": "Version 2.0",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/2/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 2",
"content": "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\nChange 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.\nChange --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.\nChange 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.\nChange If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.\nChange A plank without a title will be treated as hidden=true.\nNew 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.\nNew New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See documentat'n fer further read'n.\nNew Shortcode children wit' new parameter containerstyle.\nNew New shortcode include t' include arbitrary file rrrambl'n into a plank.",
"description": "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",
"tags": [],
"title": "Version 2.0",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/2/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 3",
"content": "3.0.4 (2022-02-24) Enhancements [feature] theme: improve font load'n #201 [feature][change] variant: fix inconsistent color vari'ble nam'n #200 Fixes [bug] variant: fix occasional fail when resett'n generator #208 [bug] docs: don’t move header on logo hover 'n IE11 #207 [bug] variant: avoid flash o' menu header when non default variant be active #206 [bug] theme: fix wrong HTML clos'n tag order 'n chapters #205 [bug] theme: adjust breadcrumb an' title fer empty home plank titles #202 3.0.3 (2022-02-23) Enhancements [feature] tags: show tag count 'n taxonomy list #195 Fixes [bug] theme: remove Cap'n Hugo build warning if plank be not file based #197 [bug] tags: adhere t' titleSeparator #196 [bug] theme: hide footer divider an' variant selector 'n IE11 #194 3.0.2 (2022-02-23) Enhancements [feature] tags: sort by name #193 3.0.1 (2022-02-23) Enhancements [feature] children: set containerstyle automatically accord'n t' style #192 Fixes [bug] theme: revert fontawsome t' version 5 fer IE11 compat #191 3.0.0 (2022-02-22) Enhancements [feature] variant: build a variant generator #188 [feature] nav: only show toc if th' plank has head'ns #182 [feature][break'n] theme: change default colors t' Relearrrn defaults #181 [feature] variant: add a variant selector #178 [feature][break'n] menu: rework footer UX #177 [feature] theme: support fer dark mode #175 [feature] docs: use light rules highlight'n theme #174 [feature] notice: tweak dull colors #173 [feature] theme: rework header UX #151 Fixes [bug] search: remove additional X 'n filled out search box 'n IE11 #190 [bug] clipboard: localize tooltips #186 [bug] print: hide sidebar on Mac #183 [bug] menu: fix scrollbar height #180 [bug][change] search: fix color change fer ay'cons on hover #176",
"description": "3.0.4 (2022-02-24) Enhancements [feature] theme: improve font load'n #201 [feature][change] variant: fix inconsistent color vari'ble nam'n #200 Fixes [bug] variant: fix occasional fail when resett'n generator #208 [bug] docs: don’t move header on logo hover 'n IE11 #207 [bug] variant: avoid flash o' menu header when non default variant be active #206 [bug] theme: fix wrong HTML clos'n tag order 'n chapters #205 [bug] theme: adjust breadcrumb an' title fer empty home plank titles #202",
"tags": [],
"title": "Version 3.0",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/3/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 3",
"content": "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' exampleSite.\nThis 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).\nBreak'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.\nThis 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.\nAvast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange 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.\nChange 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.\nNew New Wit' this release ye be now cap'ble t' define yer own dark mode variants.\nT' 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.\nT' see what’s now poss'ble, see th' new variants relearn-dark an' neon that be com'n wit' this release.\nNew 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.\nNew 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.\nAvast, 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.",
"description": "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' exampleSite.",
"tags": [],
"title": "Version 3.0",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/3/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 4",
"content": "4.0.5 (2022-06-12) Fixes [bug] i18n: Vietnamese language wit' wrong lang code #270 [bug] i18n: fix search fer non western languages #269 4.0.4 (2022-06-07) Enhancements [feature] theme: improve keyboard navigat'n fer scroll'n #268 Fixes [bug] swagger: adjust font-size fer method buttons #267 [bug] menu: hide expander when only hidden subpages #264 [bug] theme: make compat'ble wit' Cap'n Hugo 0.100.0 #263 Maintenance [task] swagger: update rapidoc t' 9.3.2 #266 [task] mermaid: update t' 9.1.1 #265 4.0.3 (2022-06-05) Enhancements [feature] toc: add scrollbar #262 4.0.2 (2022-06-05) Fixes [bug] theme: let browser scroll plank on CTRL+f #242 4.0.1 (2022-06-05) No changelog fer this release. 4.0.0 (2022-06-05) Enhancements [feature] shorrrtcodes: add named parameter if miss'n #260 [feature][break'n] theme: remove –MAIN-ANCHOR-color from stylesheet #256 [feature] i18n: add Italian translat'n #254 [feature] attachments: support fer brand colors #252 [feature] notice: support fer brand colors #251 [feature][break'n] config: remove custom_css #248 [feature] theme: use proper file extension fer page-meta.go #246 [feature] variant: add support fer brand color variables #239 [feature] i18n: add Polish translat'n #237 Fixes [bug] shorrrtcodes: accept boolean parameters if given as str'n #261 [bug] print: adjust button an' tab size #259 [bug] print: show Merrrmaid if requested 'n frontmatter #255 [bug] theme: adjust thin scrollbar slider #244 [bug] mobile: fix broken scrollbar #243 [bug] theme: fix display o' tooltip fer head'n anchor #241",
"description": "4.0.5 (2022-06-12) Fixes [bug] i18n: Vietnamese language wit' wrong lang code #270 [bug] i18n: fix search fer non western languages #269",
"tags": [],
"title": "Version 4.0",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/4/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 4",
"content": "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.\nBreak'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.\nNew New All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.\nThis applies t' expand, include, notice an' siteparam.\nNew Th' button shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.\nNew 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.\nThese 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.\nNew Translat'n into Polish. This language be not supported fer search.\nNew Th' documentat'n fer all shorrrtcodes were revised.",
"description": "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.",
"tags": [],
"title": "Version 4.0",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/4/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 5",
"content": "5.0.3 (2022-07-07) Fixes [bug] ie11: no styles after rework o' archetypes #306 5.0.2 (2022-07-07) Fixes [bug] theme: board CSS if JS be disabled #305 5.0.1 (2022-07-07) Enhancements [feature][break'n] theme: opt'mize load'n o' js an' css #303 5.0.0 (2022-07-05) Enhancements [feature][change] archetypes: modularize render'n #300 [feature] history: don’t reload plank when history gets cleared #299 [feature] menu: replace expander by fontawesome chevrons #296 [feature] theme: align rrrambl'n wit' topbar ay'con limits #290 [feature] button: allow fer empty href #288 [feature] i18n: make Simplified Chinese th' standard language fer th' zn code #287 [feature] clipboard: move head styles t' stylesheet #286 [feature] math: add mathjax render'n #235 [feature] theme: allow fer plank head'n modificat'n #139 Fixes [bug] favicon: fix URL if ship resides 'n subdirectory #302 [bug] code: show copy-to-clipboard marker fer blocklevel code #298 [bug] menu: make active expander vis'ble on hover #297 [bug] print: dis'ble arrow navigat'n #294 [bug] print: add miss'n plank break after index or section #292 [bug] theme: use more space on wide screens #291 [bug] theme: fix size o' chapter head'n #289 Maintenance [task] chore: update RapiDoc 9.3.3 #301 [task] chore: update Merrrmaid 9.1.3 #293",
"description": "5.0.3 (2022-07-07) Fixes [bug] ie11: no styles after rework o' archetypes #306",
"tags": [],
"title": "Version 5.0",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/5/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 5",
"content": "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.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e 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.\nYer 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:\nfer yer home plank, add th' front matter parameter archetype = \"home\" an' remove th' lead'n head'n\nfer all files contain'n th' deprecated front matter parameter chapter = true, replace it wit' archetype = \"chapter\" an' remove th' lead'n head'ns\nChange Th' front matter opt'ns pre / post were renamed t' menuPre / menuPost. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n after th' upgrade.\nNew New Add'n new partials heading-pre.html / heading-post.html an' accord'n front matter opt'ns headingPre / headingPost t' modify th' way yer page`s main head'n gets styled.\nNew 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.",
"description": "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.",
"tags": [],
"title": "Version 5.0",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/5/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 6",
"content": "6.0.0 (2024-04-27) Enhancements [feature][break'n] 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][break'n] menu: remove menuTitle frontmatter #714 [feature][break'n] theme: end support fer Internet Explorer 11 #584 Fixes [bug] frontmatter: move frontmatter config fer exampleSite out o' root #843 [bug] images: color outline us'n primary color #838 [bug][break'n] variant: avoid Cap'n Hugo permission errors on build #831 [bug] theme: unwanted paragraph break wit' AsciiDoc #829 Maintenance [task][break'n] swagger: remove shortcode #847 [task][break'n] 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",
"description": "6.0.0 (2024-04-27) Enhancements [feature][break'n] 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][break'n] menu: remove menuTitle frontmatter #714 [feature][break'n] theme: end support fer Internet Explorer 11 #584 Fixes [bug] frontmatter: move frontmatter config fer exampleSite out o' root #843 [bug] images: color outline us'n primary color #838 [bug][break'n] variant: avoid Cap'n Hugo permission errors on build #831 [bug] theme: unwanted paragraph break wit' AsciiDoc #829 Maintenance [task][break'n] swagger: remove shortcode #847 [task][break'n] 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",
"tags": [],
"title": "Version 6.0",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/6/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 6",
"content": "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.\nThis was necessary t' avoid permission errors on build if runn'n 'n certain Unix configurat'ns.\nIn addit'n it be not allowed anymore t' @import yer chroma stylesheet from inside o' yer variant stylesheet.\nSay, yer chroma stylesheet be named chroma-monokai.css, ye have t' add th' follow'n inside yer variant stylesheet:\n--CODE-theme: monokai; Break'n Th' parameter descript'n 'n yer hugo.toml will now be ignored.\nWit' 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.\nFor migrat'n, move th' descript'n parameter o' yer hugo.toml into th' front matter section o' yer home plank.\nBreak'n Search support fer th' json outputformat deprecated 'n 5.4.0 was removed.\nChange it t' search fer th' homepage 'n yer hugo.toml. See th' docs fer detailed configurat'n.\nBreak'n Th' front matter opt'n menuTitle deprecated 'n 5.24.0 was removed 'n favor fer Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead o' title t' generate th' breadcrumb.\nBreak'n Th' swagger shortcode deprecated 'n 5.13.0 was removed 'n favor fer th' openapi shortcode wit' th' same set o' parameter.\nBreak'n Support fer Internet Explorer 11 was finally dropped.\nChange Change Wit' th' removal o' support fer Internet Explorer 11, Font Awesome was upgraded t' version 6.5.2.\nYe may experience slight changes fer some ay'cons. In addit'n ye have additional ~1700 ay'cons t' chose from.\nChange 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.\nPreviously, th' summary erroneously was ignored which now can lead t' different output if ye set description=true as a parameter.\nNew 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 can not be resolved.\nNew Math be now us'ble without enclos'n it 'n a shortcode or Marrrkdown codefence by us'n Hugo’s passthrough configurat'n.\nNew Translat'n into Romanian.",
"description": "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.",
"tags": [],
"title": "Version 6.0",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/6/0/index.html"
},
{
"breadcrumb": "Introduction \u003e Changelog \u003e Version 7",
"content": "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' exampleSite #924 [feature][change] math: adhere t' Hugo’s default config params #923 [feature][change] theme: replace font #922 [feature][break'n] 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 war'n fer usage o' .Sites.First #912 [task][break'n] theme: restructure code #891 [task][break'n] search: improve generat'n o' dedicated search plank #888 [task] theme: remove warning fer usage o' .Site.IsMultiLingual #877 [task][break'n] roadmap: upcom'n major changes fer 7.0.0 #715",
"description": "7.0.1 (2024-10-15) Fixes [bug] search: search plank not generated wit' renderer.unsafe #929",
"tags": [],
"title": "Version 7.0",
"uri": "/hugo-theme-relearn/pir/introduction/changelog/7/0/index.html"
},
{
"breadcrumb": "Introduction \u003e What's New \u003e Version 7",
"content": "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\nsuffered 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.\nIf ye haven’t done customizat'ns t' any partials, ye can update right away.\nIf 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.\nSpecifically, ye will have t' adapt yer ship if ye have\noverwritten th' header.html, menu.html or footer.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.\nYe need t' remove th' now obsolete search an' searchpage output format from [outputs.home] 'n yer hugo.toml, result'n 'n someth'n similar t'\nhugo. 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 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.\nIn 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.\nSee th' updated documentat'n fer reference.\nChange Change Once again, th' theme changed th' font. We switched t' th' excellent Roboto Flex font.\nCare 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.\nThis 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.\nTh' 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.\nIf 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.\nAdditionally, 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.\nChange 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.\n--MAIN-TITLES-TEXT-font was renamed t' --MAIN-TITLES-font, --MAIN-TITLES-H\u003cn\u003e-color was renamed t' --MAIN-TITLES-H\u003cn\u003e-TEXT-color.\nChange Th' opt'ns an' front matter t' force load'n a math, mermaid or openapi library has been changed.\nPreviously, 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.\nYe don’t need t' change anyth'n yet but will receive warnings if th' old sett'ns be used.\nChange Th' default logo be not contained inside o' th' theme’s logo partial anymore.\nThis be t' avoid usage o' th' theme’s brand'n throughout th' web 'n non-modified installat'ns.\nIn addit'n, th' default text fer th' logo partial be now taken from th' linkTitle sett'n o' yer hugo.toml.\nNew New Th' docs received a much-needed overhaul fer all chapters.\nBasically, 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.\nTh' 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.\nT' 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.\nAlso, a lot o' previously undocumented features be now included, namely\nth' hidden planks feature opt'ns o' th' menus configur'n breadcrumb, titles an' head'ns o' yer rrrambl'n opt'ns fer us'n links add'n custom output formats",
"description": "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",
"tags": [],
"title": "Version 7.0",
"uri": "/hugo-theme-relearn/pir/introduction/releasenotes/7/0/index.html"
}
]
Reference in a new issue View git blame Copy permalink