2023-11-28 22:52:52 +00:00
<!DOCTYPE html>
2024-04-30 20:08:46 +00:00
< html lang = "art-x-pir" dir = "rtl" itemscope itemtype = "http://schema.org/Article" >
2023-11-28 22:52:52 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2024-10-11 14:17:37 +00:00
< meta name = "generator" content = "Hugo 0.135.0" >
2024-10-13 15:22:56 +00:00
< meta name = "generator" content = "Relearn 7.0.0+72a36ea6e73e5941fb92069356655d9913bfb4b4" >
2024-10-13 14:26:50 +00:00
< meta name = "description" content = "All things front matter" >
2023-11-28 22:52:52 +00:00
< meta name = "author" content = "Sören Weber" >
< meta name = "twitter:card" content = "summary_large_image" >
2024-02-24 13:03:50 +00:00
< meta name = "twitter:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-10-13 14:26:50 +00:00
< meta name = "twitter:title" content = "Front Matter :: Cap'n Hugo Relearrrn Theme" >
< meta name = "twitter:description" content = "All things front matter" >
< meta property = "og:url" content = "https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/frontmatter/index.html" >
2024-04-07 13:13:19 +00:00
< meta property = "og:site_name" content = "Cap'n Hugo Relearrrn Theme" >
2024-10-13 14:26:50 +00:00
< meta property = "og:title" content = "Front Matter :: Cap'n Hugo Relearrrn Theme" >
< meta property = "og:description" content = "All things front matter" >
2024-06-05 21:20:58 +00:00
< meta property = "og:locale" content = "art_x_pir" >
2023-11-28 22:52:52 +00:00
< meta property = "og:type" content = "website" >
2024-02-24 13:03:50 +00:00
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-10-13 14:26:50 +00:00
< meta itemprop = "name" content = "Front Matter :: Cap'n Hugo Relearrrn Theme" >
< meta itemprop = "description" content = "All things front matter" >
< meta itemprop = "wordCount" content = "35" >
2024-04-24 19:38:41 +00:00
< meta itemprop = "image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-10-13 14:26:50 +00:00
< meta itemprop = "keywords" content = "Reference" >
< title > Front Matter :: Cap' n Hugo Relearrrn Theme< / title >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/authoring/frontmatter/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/authoring/frontmatter/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/frontmatter/index.html" rel = "alternate" hreflang = "art-x-pir" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/frontmatter/index.html" rel = "canonical" type = "text/html" title = "Front Matter :: Cap'n Hugo Relearrrn Theme" >
< link href = "/hugo-theme-relearn/pir/authoring/frontmatter/index.xml" rel = "alternate" type = "application/rss+xml" title = "Front Matter :: Cap'n Hugo Relearrrn Theme" >
2024-10-13 15:22:56 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1728832967" rel = "icon" type = "image/svg+xml" >
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1728832967" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1728832967" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1728832967" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1728832967" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1728832967" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1728832967" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1728832967" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1728832967" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1728832967" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1728832967" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1728832967" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/print.css?1728832967" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1728832967" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/variant.js?1728832967" > < / script >
2024-03-16 13:44:28 +00:00
< script >
2023-11-28 22:52:52 +00:00
window.relearn = window.relearn || {};
2024-03-18 20:59:19 +00:00
window.relearn.relBasePath='..\/..\/..';
window.relearn.relBaseUri='..\/..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
2024-08-22 16:34:04 +00:00
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
2023-11-28 22:52:52 +00:00
// variant stuff
2024-04-19 06:38:17 +00:00
window.variants & & variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] );
2023-11-28 22:52:52 +00:00
// translations
window.T_Copy_to_clipboard = `Copy t' clipboard`;
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
window.T_Reset_view = `Rrreset view`;
window.T_View_reset = `View rrreset!`;
window.T_No_results_found = `No rrresults found fer "{0}"`;
window.T_N_results_found = `{1} rrresults found fer "{0}"`;
< / script >
< style >
#R-body img.bg-white {
background-color: white;
}
< / style >
< / head >
2024-10-13 14:26:50 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "/hugo-theme-relearn/pir/authoring/frontmatter/index.html" >
2023-11-28 22:52:52 +00:00
< div id = "R-body" class = "default-animation" >
< div id = "R-body-overlay" > < / div >
< nav id = "R-topbar" >
< div class = "topbar-wrapper" >
< div class = "topbar-sidebar-divider" > < / div >
< div class = "topbar-area topbar-area-start" data-area = "start" >
2023-12-05 07:41:41 +00:00
< div class = "topbar-button topbar-button-sidebar" data-content-empty = "disable" data-width-s = "show" data-width-m = "hide" data-width-l = "hide" > < button class = "topbar-control" onclick = "toggleNav()" type = "button" title = "Menu (CTRL+ALT+n)" > < i class = "fa-fw fas fa-bars" > < / i > < / button >
2023-11-28 22:52:52 +00:00
< / div >
2023-12-05 07:45:14 +00:00
< div class = "topbar-button topbar-button-toc" data-content-empty = "hide" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < button class = "topbar-control" onclick = "toggleTopbarFlyout(this)" type = "button" title = "Table o' Contents (CTRL+ALT+t)" > < i class = "fa-fw fas fa-list-alt" > < / i > < / button >
2023-11-28 22:52:52 +00:00
< div class = "topbar-content" >
2024-10-13 14:26:50 +00:00
< div class = "topbar-content-wrapper" >
2023-11-28 22:52:52 +00:00
< / div >
< / div >
< / div >
< / div >
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
2024-10-13 14:26:50 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< a itemprop = "item" href = "/hugo-theme-relearn/pir/authoring/index.html" > < span itemprop = "name" > Rambl' n< / span > < / a > < meta itemprop = "position" content = "1" > > < / li > < li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > Front Matter< / span > < meta itemprop = "position" content = "2" > < / li >
2023-11-28 22:52:52 +00:00
< / ol >
< div class = "topbar-area topbar-area-end" data-area = "end" >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-edit" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/authoring/frontmatter/_index.pir.md" target = "_self" title = "Edit (CTRL+ALT+w)" > < i class = "fa-fw fas fa-pen" > < / i > < / a >
2023-11-28 22:52:52 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-print" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/pir/authoring/frontmatter/index.print.html" title = "Prrrint whole chapterrr (CTRL+ALT+p)" > < i class = "fa-fw fas fa-print" > < / i > < / a >
2023-11-28 22:52:52 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-prev" data-content-empty = "disable" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/pir/authoring/structure/index.html" title = "Directory Structure (🡒)" > < i class = "fa-fw fas fa-chevron-left" > < / i > < / a >
2023-11-28 22:52:52 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-next" data-content-empty = "disable" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/pir/authoring/frontmatter/designs/index.html" title = "Page Designs (🡐)" > < i class = "fa-fw fas fa-chevron-right" > < / i > < / a >
2023-11-28 22:52:52 +00:00
< / div >
2023-12-05 07:41:41 +00:00
< div class = "topbar-button topbar-button-more" data-content-empty = "hide" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < button class = "topbar-control" onclick = "toggleTopbarFlyout(this)" type = "button" title = "Morrre" > < i class = "fa-fw fas fa-ellipsis-v" > < / i > < / button >
2023-11-28 22:52:52 +00:00
< div class = "topbar-content" >
< div class = "topbar-content-wrapper" >
< div class = "topbar-area topbar-area-more" data-area = "more" >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / nav >
< div id = "R-main-overlay" > < / div >
2024-10-13 14:26:50 +00:00
< main id = "R-body-inner" class = "highlightable authoring" tabindex = "-1" >
2023-11-28 22:52:52 +00:00
< div class = "flex-block-wrapper" >
2024-10-13 14:26:50 +00:00
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "front-matter" > Front Matter< / h1 >
< div class = "children children-h2 children-sort-" >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/designs/index.html" > Plank Designs< / a > < / h2 > < p > How t' vary layouts by us'n plank designs< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/navigationmenu/index.html" > Navigat'n Menu< / a > < / h2 > < p > Behavior o' th' navigat'n menu< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/linking/index.html" > Link'n< / a > < / h2 > < p > What opt'ns be avail'ble fer links an' images< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html" > Topbar< / a > < / h2 > < p > Configure th' topbar< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.html" > Front Matter Reference< / a > < / h2 > < p > All front matter fer th' Relearrrn theme< / p >
< / div >
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/reference/index.html" > Reference< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< section >
< h1 class = "a11y-only" > Subsct' ns o' Front Matter< / h1 >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "page-designs" > Page Designs< / h1 >
< p > A plank be displayed by exactly one plank design an' represented by < a href = "https://gohugo.io/content-management/front-matter/#type" rel = "external" target = "_self" > Hugo’ s reserved < code > type< / code > front matter< / a > .< / p >
< p > Th' Relearrrn theme offers th' plank designs < code > home< / code > , < code > chapter< / code > , an' < code > default< / code > but ye can < a href = "/hugo-theme-relearn/pir/configuration/customization/designs/index.html" > define further custom plank designs< / a > .< / p >
< p > Regardless o' shipped or custom plank design, ye be us'n them 'n th' same way.< / p >
< ul >
< li >
< p > If ye have an < a href = "https://gohugo.io/content-management/archetypes/" rel = "external" target = "_self" > archetype file< / a > , ye can just do< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind chapter chapter1/_index.md< / span > < / span > < / code > < / pre > < / div >
< / li >
< li >
< p > If ye be creat'n yer Marrrkdown files manually, ye can achieve th' same by just sett'n < code > type='chapter'< / code > 'n th' front matter.< / p >
< / li >
< / ul >
< p > Yer result'n Marrrkdown file needs t' have at least th' < code > type< / code > front matter set t' th' value o' th' plank design< / p >
2024-10-13 15:22:56 +00:00
< div class = "tab-panel" data-tab-group = "7239ef0a23785a5fefc1dd7f29725e00" >
2024-10-13 14:26:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="_indexmd"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-13 15:22:56 +00:00
onclick="switchTab('7239ef0a23785a5fefc1dd7f29725e00','_indexmd')"
2024-10-13 14:26:50 +00:00
>
< span class = "tab-nav-text" > _index.md< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="_indexmd"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Chapter 1" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > type< / span > < span class = "p" > =< / span > < span class = "s2" > " chapter" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div > < h2 id = "predefined-designs" > Predefined Designs< / h2 >
< h3 id = "archetypes-home" > Home< / h3 >
< p > A < strong > Home< / strong > plank be th' start'n plank o' yer project. It’ s best t' have only one plank o' this kind 'n yer project.< / p >
< p > T' create a home plank, run th' follow'n command< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind home _index.md< / span > < / span > < / code > < / pre > < / div >
2024-10-13 15:22:56 +00:00
< p > < a href = "#R-image-69cab0c0fe23c13a7fc9ba7998de507a" class = "lightbox-link" > < img alt = "Home page" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-home.png?width=60pc" style = " height: auto; width: 60pc;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-69cab0c0fe23c13a7fc9ba7998de507a" > < img alt = "Home page" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-home.png?width=60pc" > < / a > < / p >
2024-10-13 14:26:50 +00:00
< h3 id = "archetypes-chapter" > Chapter< / h3 >
< p > A < strong > Chapter< / strong > displays a plank meant t' be used as introduct'n fer a set o' child planks.< / p >
< p > Commonly, it contains a title front matter an' a short descript'n 'n th' rrrambl'n.< / p >
< p > T' create a chapter plank, run th' follow'n command< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind chapter chapter1/_index.md< / span > < / span > < / code > < / pre > < / div >
< p > If a numerical < code > weight< / code > 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.< / p >
2024-10-13 15:22:56 +00:00
< p > < a href = "#R-image-9107a8b4b328a5240a4029f69084bc0d" class = "lightbox-link" > < img alt = "Chapter page" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-chapter.png?width=60pc" style = " height: auto; width: 60pc;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-9107a8b4b328a5240a4029f69084bc0d" > < img alt = "Chapter page" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-chapter.png?width=60pc" > < / a > < / p >
2024-10-13 14:26:50 +00:00
< h3 id = "archetypes-default" > Default< / h3 >
< p > A < strong > Default< / strong > plank be any other rrrambl'n plank.< / p >
< p > T' create a default plank, run either one o' th' follow'n commands< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new chapter1/page1/_index.md< / span > < / span > < / code > < / pre > < / div >
< p > or< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new chapter1/page1.md< / span > < / span > < / code > < / pre > < / div >
2024-10-13 15:22:56 +00:00
< p > < a href = "#R-image-d99229516eae1202eb3f8fbeec8d389b" class = "lightbox-link" > < img alt = "Default page" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-default.png?width=60pc" style = " height: auto; width: 60pc;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-d99229516eae1202eb3f8fbeec8d389b" > < img alt = "Default page" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-default.png?width=60pc" > < / a > < / p >
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2024-10-13 14:26:50 +00:00
< h1 id = "navigation-menu" > Navigation Menu< / h1 >
2023-11-28 22:52:52 +00:00
2024-10-13 14:26:50 +00:00
< p > Th' navigat'n menu be automatically created from < a href = "/hugo-theme-relearn/pir/authoring/structure/index.html" > yer rrrambl'n files< / a > .< / p >
< p > All configurat'ns opt'ns apply t' all planks but can be changed 'n each page’ s front matter.< / p >
< h2 id = "expand-state-of-nested-sections" > Expand State o' Nested Sect'ns< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Ye can change how th' theme submenus appear wit' < code > alwaysopen< / code > .< / p >
< p > If < code > alwaysopen=false< / code > 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.< / p >
< p > Th' theme generates th' expand state based on th' follow'n rules:< / p >
< ul >
< li > all parent entries o' th' active plank includ'n their < a href = "/hugo-theme-relearn/pir/authoring/meta/index.html#hidden" > vis'ble< / a > sibl'ns be shown regardless o' any sett'ns< / li >
< li > immediate child entries o' th' active plank be shown regardless o' any sett'ns< / li >
< li > if not overridden, all other first level entries behave like they would have been given < code > alwaysopen=false< / code > < / li >
< li > if not overridden, all other entries o' levels besides th' first behave like they would have been given < code > alwaysopen=true< / code > < / li >
< li > all < a href = "/hugo-theme-relearn/pir/authoring/meta/index.html#hidden" > vis'ble< / a > entries show their immediate child entries if < code > alwaysopen=true< / code > ; this proceeds recursively< / li >
< li > all remain'n entries be not shown< / li >
< / ul >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > alwaysopen< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " alwaysopen" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< h2 id = "expander-for-nested-sections" > Expander fer Nested Sect'ns< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Set < code > collapsibleMenu=true< / code > t' add an expander fer submenus. This shows submenus as collaps'ble trees wit' a click'ble expander.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > collapsibleMenu< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " collapsibleMenu" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box notices cstyle warning" >
< div class = "box-label" >
< i class = "fa-fw fas fa-exclamation-triangle" > < / i > Arrr
< / div >
< div class = "box-content" >
< p > Us'n this opt'n may slow down yer build process, especially wit' many planks.< / p >
< p > We’ ve seen builds tak'n 2 minutes wit' 1000+ planks, an' over 30 minutes wit' 5000+ planks.< / p >
< p > This happens because each new plank affects all other planks, lead'n t' exponentially longer build times.< / p >
< / div >
< / div >
< h2 id = "ordering-sibling-menu-entries" > Order'n Sibl'n Menu Entries< / h2 >
< h3 id = "by-weight" > By Weight< / h3 >
< p > Cap'n Hugo provides a < a href = "https://gohugo.io/getting-started/glossary/#weight" rel = "external" target = "_self" > simple way< / a > t' handle order fer yer planks by sett'n th' < code > weight< / code > front matter t' a number.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
2024-03-02 10:05:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-13 14:26:50 +00:00
onclick="switchTab('config-code','toml')"
2024-03-02 10:05:50 +00:00
>
< span class = "tab-nav-text" > toml< / span >
< / button >
2024-10-13 14:26:50 +00:00
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' My page' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 5< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > title< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > My plank< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > weight< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "m" > 5< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " My page" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " weight" < / span > < span class = "p" > :< / span > < span class = "mi" > 5< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< h3 id = "by-other" > By Other< / h3 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Us'n th' < code > weight< / code > 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.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > ordersectionsby< / span > < span class = "p" > =< / span > < span class = "s1" > ' linktitle' < / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > ordersectionsby< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > linktitle< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " ordersectionsby" < / span > < span class = "p" > :< / span > < span class = "s2" > " linktitle" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< h2 id = "custom-title-for-menu-entries" > Custom Title fer Menu Entries< / h2 >
< p > By default, th' Relearrrn theme will use a page’ s < code > title< / code > front matter fer th' menu entry.< / p >
< p > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > But a page’ s title has t' be descriptive on its own while th' menu be a hierarchy. Use < code > linkTitle< / code > t' shorten th' text o' th' menu entry.< / p >
< p > For example fer a plank named < code > install/linux.md< / code > < / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > linkTitle< / span > < span class = "p" > =< / span > < span class = "s1" > ' Linux' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' Install on Linux' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > linkTitle< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > Linux< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > title< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > Install on Linux< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " linkTitle" < / span > < span class = "p" > :< / span > < span class = "s2" > " Linux" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " Install on Linux" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< h2 id = "add-icon-to-a-menu-entry" > Add Ay'con t' a Menu Entry< / h2 >
< p > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > In th' plank front matter, add a < code > menuPre< / code > t' insert any HTML code before th' menu label. Ye can also set < code > menuPost< / code > t' insert HTML code after th' menu label.< / p >
< p > Th' example below uses th' GitHub ay'con.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' < i class=" fab fa-github" > < /i> ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' GitHub Repo' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > menuPre< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s1" > ' < i class=" fab fa-github" > < /i> ' < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > title< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > GitHub Repo< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " menuPre" < / span > < span class = "p" > :< / span > < span class = "s2" > " \u003ci class=\" fab fa-github\" \u003e\u003c/i\u003e " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " GitHub Repo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
2024-10-13 15:22:56 +00:00
< p > < a href = "#R-image-e419df5af81cea4bf1b0269686ba110d" class = "lightbox-link" > < img alt = "Title wit' icon" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/navigationmenu/item-with-icon.png?width=18.75rem" style = " height: auto; width: 18.75rem;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-e419df5af81cea4bf1b0269686ba110d" > < img alt = "Title wit' icon" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/navigationmenu/item-with-icon.png?width=18.75rem" > < / a > < / p >
2024-10-13 14:26:50 +00:00
< h2 id = "disable-section-pages" > Dis'ble Sect'n Planks< / h2 >
< p > Ye may want t' structure yer planks 'n a hierarchical way but don’ t want t' generate planks fer those sections? Th' theme got ye covered.< / p >
< p > T' stay wit' th' < a href = "/hugo-theme-relearn/pir/authoring/structure/index.html" > initial example< / a > : Suppose ye want < code > first-chapter/first-page< / code > 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 show an expander.< / p >
< p > For this, open < code > content/first-chapter/first-page/_index.md< / code > an' add th' follow'n front matter< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-03-02 10:05:50 +00:00
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2023-11-28 22:52:52 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > _build< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > render< / span > < span class = "p" > =< / span > < span class = "s1" > ' never' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > _build< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > render< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > never< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > collapsibleMenu< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " _build" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " render" < / span > < span class = "p" > :< / span > < span class = "s2" > " never" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " collapsibleMenu" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "linking" > Linking< / h1 >
< h2 id = "opening-links" > Open'n Links< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > By default, external links open 'n a new tab. T' change this, use th' < code > externalLinkTarget< / code > sett'n wit' a proper < a href = "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target" rel = "external" target = "_self" > link target< / a > .< / p >
< p > For example, this will open links 'n th' same tab< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > externalLinkTarget< / span > < span class = "p" > =< / span > < span class = "s1" > ' _self' < / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > externalLinkTarget< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > _self< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " externalLinkTarget" < / span > < span class = "p" > :< / span > < span class = "s2" > " _self" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< h2 id = "enabling-link-and-image-link-warnings" > Enabl'n Link an' Image Link Warn'ns< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Ye can use < code > link.errorlevel< / code > an' < code > image.errorlevel< / code > t' control what should happen if a local link can not be resolved t' a resource.< / p >
< p > If not set or empty, any unresolved link be written as given into th' result'n output. If set t' < code > warning< / code > th' same happens an' an additional warning be printed 'n th' built console. If set t' < code > error< / code > an error message be printed an' th' build be aborted.< / p >
< p > Please note that this can not resolve files inside o' yer < code > static< / code > directory. Th' file must be a resource o' th' plank or th' ship.< / p >
< p > Link warnings be also avail'ble fer th' < a href = "/hugo-theme-relearn/pir/shortcodes/include/index.html#enabling-link-warnings" > include< / a > an' < a href = "/hugo-theme-relearn/pir/shortcodes/openapi/index.html#enabling-link-warnings" > openapi< / a > shorrrtcodes.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > image< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' warning' < / span >
2024-08-02 08:33:00 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > link< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' warning' < / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > image< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > warning< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > link< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > warning< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " image" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " warning" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " link" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " warning" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "topbarrr" > Topbarrr< / h1 >
< p > This plank be about how t' configure th' topbar us'n configurat'n opt'ns. If ye want t' add further buttons or functionality, < a href = "/hugo-theme-relearn/pir/configuration/customization/topbar/index.html" > see this section< / a > .< / p >
< p > Yer topbar contains th' follow'n elements. Some o' them be configuar'ble:< / p >
< ul >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-bars" > < / i > < / span > < / span > < strong > sidebar< / strong > : opens th' sidebar flyout if 'n mobile layout< / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-list-alt" > < / i > < / span > < / span > < strong > toc< / strong > : < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#table-of-contents" > opens th' t'ble o' contents 'n an overlay< / a > < / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-empty" > < / i > < / span > < / span > < strong > breadcrumb< / strong > : shows th' click'ble < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#breadcrumbs" > breadcrumbs< / a > < / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-pen" > < / i > < / span > < / span > < strong > edit< / strong > : browses t' th' edit'ble plank if th' < code > editURL< / code > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#edit-button" > parameter be set< / a > < / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-print" > < / i > < / span > < / span > < strong > print< / strong > : browses t' th' chapters print'ble plank if < a href = "/hugo-theme-relearn/pir/configuration/sitemanagement/outputformats/index.html#print-support" > print support< / a > was activated< / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-chevron-left" > < / i > < / span > < / span > < strong > prev< / strong > : browses t' th' < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#arrow-navigation" > previous plank< / a > if there be one< / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-chevron-right" > < / i > < / span > < / span > < strong > next< / strong > : browses t' th' < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#arrow-navigation" > next plank< / a > if there be one< / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-ellipsis-v" > < / i > < / span > < / span > < strong > more< / strong > : opens th' overlay if screen space be limited< / li >
< / ul >
< h2 id = "table-of-contents" > T'ble o' Contents< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Set < code > disableToc=true< / code > 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.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > disableToc< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > disableToc< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " disableToc" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< h2 id = "breadcrumbs" > Breadcrumbs< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Set < code > disableBreadcrumb=true< / code > t' hide th' breadcrumb 'n th' topbar.< / p >
< p > Further breadcrumbs sett'ns can be found 'n th' < a href = "/hugo-theme-relearn/pir/configuration/content/titles/index.html" > rrrambl'n configurat'n section< / a > .< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > disableBreadcrumb< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > disableBreadcrumb< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " disableBreadcrumb" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< h2 id = "edit-button" > Edit Button< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > If < code > editURL< / code > 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.< / p >
< p > Th' value can contain th' macro < code > ${FilePath}< / code > which will be replaced by th' file path o' yer displayed plank. If no < code > ${FilePath}< / code > be given 'n th' value, th' value be treated as if th' < code > ${FilePath}< / code > was appended at th' end o' th' value. This can be overridden 'n th' planks front matter.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > editURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' < / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > editURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " editURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< h2 id = "arrow-navigation" > Arrow Navigat'n< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Ye can hide th' previous/next buttons by sett'n < code > disableNextPrev=true< / code > . If th' buttons be hidden, also th' keyboard shortcuts be disabled.< / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > disableNextPrev< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > disableNextPrev< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " disableNextPrev" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "front-matter-reference" > Front Matter Reference< / h1 >
< p > Every Cap'n Hugo plank must have front matter.< / p >
< p > In addit'n t' < a href = "https://gohugo.io/content-management/front-matter/#fields" rel = "external" target = "_self" > Hugo’ s standard front matter< / a > , th' Relearrrn theme offers extras sett'ns listed here.< / p >
< p > Throughout th' documentat'n, theme-specific front matter be marked wit' a < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > badge.< / p >
< p > Add theme front matter directly t' th' root o' yer page’ s front matter. For example:< / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > math< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > math< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
2024-09-05 18:03:19 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " math" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "index" > Index< / h2 >
< h3 id = "a" > A< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/alwaysopen/index.html" > Alwaysopen< / a > (1)< / li >
< / ul >
< h3 id = "c" > C< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/collapsiblemenu/index.html" > CollapsibleMenu< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/custommathjaxurl/index.html" > CustomMathJaxURL< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/custommermaidurl/index.html" > CustomMermaidURL< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/customopenapiurl/index.html" > CustomOpenapiURL< / a > (1)< / li >
< / ul >
< h3 id = "d" > D< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/description/index.html" > Descript'n< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/disablebreadcrumb/index.html" > DisableBreadcrumb< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/disablenextprev/index.html" > DisableNextPrev< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/disabletoc/index.html" > DisableToc< / a > (1)< / li >
< / ul >
< h3 id = "e" > E< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/editurl/index.html" > EditURL< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/externallinktarget/index.html" > ExternalLinkTarget< / a > (1)< / li >
< / ul >
< h3 id = "h" > H< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/headingpost/index.html" > HeadingPost< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/headingpre/index.html" > HeadingPre< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/hidden/index.html" > Hidden< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/highlightwrap/index.html" > HighlightWrap< / a > (1)< / li >
< / ul >
< h3 id = "i" > I< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/image.errorlevel/index.html" > Image.errorlevel< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/imageeffects/index.html" > ImageEffects< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/include.errorlevel/index.html" > Include.errorlevel< / a > (1)< / li >
< / ul >
< h3 id = "l" > L< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/lastmodifierdisplayname/index.html" > LastModifierDisplayName< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/lastmodifieremail/index.html" > LastModifierEmail< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/link.errorlevel/index.html" > Link.errorlevel< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/linktitle/index.html" > LinkTitle< / a > (1)< / li >
< / ul >
< h3 id = "m" > M< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/math/index.html" > Math< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/math.force/index.html" > Math.force< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/mathjaxinitialize/index.html" > MathJaxInitialize< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/menupost/index.html" > MenuPost< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/menupre/index.html" > MenuPre< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/mermaid.force/index.html" > Merrrmaid.force< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/mermaidinitialize/index.html" > MermaidInitialize< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/mermaidzoom/index.html" > MermaidZoom< / a > (1)< / li >
< / ul >
< h3 id = "o" > O< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/openapi.errorlevel/index.html" > Openapi.errorlevel< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/openapi.force/index.html" > Openapi.force< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/ordersectionsby/index.html" > Ordersectionsby< / a > (2)< / li >
< / ul >
< h2 id = "all-front-matter" > All Front Matter< / h2 >
< p > Here’ s a list o' all avail'ble front matter wit' example values. Default values be described 'n th' < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.html#annotated-front-matter" > annotated example< / a > below or 'n each front matter’ s documentat'n.< / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierDisplayName< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierEmail< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMathJaxURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMermaidURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customOpenapiURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > descript'n< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableBreadcrumb< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableNextPrev< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableToc< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > editURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > externalLinkTarget< / span > < span class = "p" > =< / span > < span class = "s1" > ' _self' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPost< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > hidden< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > highlightWrap< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > images< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s1" > ' images/hero.png' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > linkTitle< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > math< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mathJaxInitialize< / span > < span class = "p" > =< / span > < span class = "s1" > ' {}' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPost< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidInitialize< / span > < span class = "p" > =< / span > < span class = "s1" > ' { " securityLevel" : " loose" }' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidZoom< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > ordersectionsby< / span > < span class = "p" > =< / span > < span class = "s1" > ' weight' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' Example Page' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > type< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > image< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > imageEffects< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lazy< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lightbox< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > shadow< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > include< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > link< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > mermaid< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > force< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > openapi< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > oppenapi< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > force< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > LastModifierDisplayName< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > LastModifierEmail< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > alwaysopen< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > collapsibleMenu< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > customMathJaxURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > customMermaidURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > customOpenapiURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > descript'n< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > disableBreadcrumb< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > disableNextPrev< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > disableToc< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > editURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > externalLinkTarget< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > _self< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > headingPost< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > headingPre< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > hidden< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > highlightWrap< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > image< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > imageEffects< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > border< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > lazy< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > lightbox< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > shadow< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > images< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > - < span class = "l" > images/hero.png< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > include< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > link< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > linkTitle< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > math< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > mathJaxInitialize< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s1" > ' {}' < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > menuPost< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > menuPre< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > mermaid< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > force< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > mermaidInitialize< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s1" > ' { " securityLevel" : " loose" }' < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > mermaidZoom< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > openapi< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > oppenapi< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > force< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > ordersectionsby< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > weight< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > title< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > Example Plank< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > type< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
2024-09-05 18:03:19 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " LastModifierDisplayName" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " LastModifierEmail" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " alwaysopen" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " collapsibleMenu" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " customMathJaxURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " customMermaidURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " customOpenapiURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " description" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " disableBreadcrumb" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " disableNextPrev" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " disableToc" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " editURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " externalLinkTarget" < / span > < span class = "p" > :< / span > < span class = "s2" > " _self" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " headingPost" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " headingPre" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " hidden" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " highlightWrap" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " image" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " imageEffects" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " border" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " lazy" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " lightbox" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " shadow" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " images" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s2" > " images/hero.png" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ],< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " include" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " link" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " linkTitle" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " math" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " mathJaxInitialize" < / span > < span class = "p" > :< / span > < span class = "s2" > " {}" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " menuPost" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " menuPre" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " mermaid" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " force" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " mermaidInitialize" < / span > < span class = "p" > :< / span > < span class = "s2" > " { \" securityLevel\" : \" loose\" }" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " mermaidZoom" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " openapi" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " oppenapi" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " force" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " ordersectionsby" < / span > < span class = "p" > :< / span > < span class = "s2" > " weight" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " Example Page" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " type" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "annotated-front-matter" > Annotated Front Matter< / h2 >
2024-10-13 15:22:56 +00:00
< div class = "tab-panel" data-tab-group = "882355fce30db8bf8c43b943a57e4a37" >
2024-03-02 10:05:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-13 15:22:56 +00:00
onclick="switchTab('882355fce30db8bf8c43b943a57e4a37','toml')"
2024-03-02 10:05:50 +00:00
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If an opt'n value be said t' be not set, ye can achieve th' same behavior< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # by giv'n it an empty str'n value.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > ###############################################################################< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Cap'n Hugo< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns usually apply t' other themes as well.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' social media image o' yer plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This be used fer generat'n social media meta informat'n fer th' opengraph< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # protocol an' twitter cards.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > images< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s1" > ' images/hero.png' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' yer plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # A plank without a title be treated as a hidden plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' Example Page' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' descript'n o' yer plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This be used fer generat'n HTML meta tags, social media meta informat'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # fer th' opengraph protocol an' twitter cards.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used fer th' html< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # meta tag, social media meta informat'n fer th' opengraph protocol an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # twitter cards.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > descript'n< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' plank design t' be used< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This decides th' layout o' yer plank. Th' theme ships ' home' , ' chapter' an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # ' default' . If not set, ' default' be taken.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > type< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > ###############################################################################< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Relearrrn Theme< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns be specific t' th' Relearrrn theme.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Topbar< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns modify th' topbar appearance.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide th' t'ble o' contents button.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If th' TOC button be hidden, also th' keyboard shortcut be disabled.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableToc< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide th' breadcrumbs.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # shown 'n th' topbar.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableBreadcrumb< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide Next an' Previous navigat'n buttons.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # disabled.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableNextPrev< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' URL prefix t' edit a plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set, an edit button will be shown 'n th' topbar. If th' button be hidden,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # also th' keyboard shortcuts be disabled. Th' value can contain th' macro< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # `${FilePath}` which will be replaced by th' file path o' yer displayed plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used. If th' global< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # parameter be given but ye want t' hide th' button fer th' displayed plank,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # ye can set th' value t' an empty str'n. If instead o' hid'n ye want t' have< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # an disabled button, ye can set th' value t' a str'n contain'n just spaces.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This be useful if ye want t' give th' opportunity fer people t' create merge< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # request fer yer rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > editURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Menu< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns modify th' menu appearance.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Menu specific title< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title displayed 'n th' menu. If not set th' `title` front matter will< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > linkTitle< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Prefix fer th' title 'n navigat'n menu.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Suffix fer th' title 'n navigat'n menu.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPost< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' order o' navigat'n menu submenus.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' weight' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Submenus can be ordered by ' weight' , ' title' , ' linktitle' , ' modifieddate' ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # ' expirydate' , ' publishdate' , ' date' , ' length' or ' default' (adher'n t'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hugo' s default sort order).< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' value o' th' parent menu entry be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > ordersectionsby< / span > < span class = "p" > =< / span > < span class = "s1" > ' weight' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' initial expand state o' submenus.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This controls whether submenus will be expanded (true), or collapsed (false)< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # 'n th' menu. If not set, th' first menu level be set t' false, all others< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # levels be set t' true. If not set, th' value o' th' parent menu entry be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If th' displayed plank has submenus, they will always been displayed expanded< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # regardless o' this opt'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Shows expander fer submenus.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # tree view an' a click'ble expander be set 'n front o' th' entry.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
2024-03-02 10:05:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hidden planks< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how hidden planks be treated.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # A plank flagged as hidden, be only removed from th' navigat'n menu if ye be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # currently not on this plank or th' hidden plank be not part o' current page' s< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # other plank if not otherwise configured.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide a page' s menu entry.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If this value be true, th' plank be hidden from th' menu.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > hidden< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Rrrambl'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns modify how yer rrrambl'n be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Prefix fer th' title 'n th' rrrambl'n area.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Suffix fer th' title 'n th' rrrambl'n area.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank head'n will be suffixed by this HTML rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPost< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Display name o' th' page' s last editor.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set, it will be displayed 'n th' default footer.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierDisplayName< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Email address o' th' page' s last editor.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set together wit' LastModifierDisplayName, it will be displayed 'n th'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # default footer.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierEmail< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Highlight< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how code be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Wrap fer code blocks.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # By default lines o' code blocks wrap around if th' line be too long t' be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # displayed on screen. If ye dislike this behavior, ye can reconfigure it< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # here.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Avast that lines always wrap 'n print mode regardless o' this opt'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used or given as a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # parameter t' individual code blocks.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > highlightWrap< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Include< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how th' include shortcode works.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # What t' do when path be not resolved.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Ye can control what should happen if a path can not be resolved t' as< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # a resource or via th' file system. If not set, no output will be written< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # fer th' unresolved path. If set t' `warning` th' same happens an' an additional< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # warning be printed. If set t' `error` an error message be printed an' th' build< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be aborted.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > include< / span > < span class = "p" > .< / span > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Images< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how images be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # What t' do when local image link be not resolved.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Ye can control what should happen if a local image can not be resolved t' as< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # a resource. If not set, th' unresolved link be written as given into th' result'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # output. If set t' `warning` th' same happens an' an additional warning be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # printed. If set t' `error` an error message be printed an' th' build be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # aborted.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Please note that this can not resolve files inside o' yer `static` directory.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > image< / span > < span class = "p" > .< / span > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Image effects.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # See th' documentat'n fer how ye can even add yer own arbitrary effects t'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # th' list.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # All effect values default t' th' values o' yer site' s hugo.toml an' can be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # overridden through URL parameter given t' th' image. See th' documentat'n fer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # details.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > imageEffects< / span > < span class = "p" > .< / span > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > imageEffects< / span > < span class = "p" > .< / span > < span class = "nx" > lazy< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > imageEffects< / span > < span class = "p" > .< / span > < span class = "nx" > lightbox< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > imageEffects< / span > < span class = "p" > .< / span > < span class = "nx" > shadow< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Links< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how links be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # What t' do when local plank link be not resolved.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Ye can control what should happen if a local link can not be resolved t' a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # plank. If not set, th' unresolved link be written as given into th' result'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # output. If set t' `warning` th' same happens an' an additional warning be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # printed. If set t' `error` an error message be printed an' th' build be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # aborted.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Please note that wit' Cap'n Hugo < 0.123.0 + `uglyURLs=true` this can lead t' false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # negatives.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > link< / span > < span class = "p" > .< / span > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # How t' open external links.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' _blank' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # For external links ye can define how they be opened 'n yer browser. All< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # default value opens external links 'n a separate browser tab. If ye want< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # t' open those links 'n th' same tab, use ' _self' .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > externalLinkTarget< / span > < span class = "p" > =< / span > < span class = "s1" > ' _self' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # MathJax< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how math formulae be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Initializat'n opt'ns fer MathJax.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mathJaxInitialize< / span > < span class = "p" > =< / span > < span class = "s1" > ' {}' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Force board Math on every plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If a, Math shortcode or codefence be found, th' opt'n will be ignored an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Math will be boarded regardlessly. This opt'n be useful 'n case ye< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be us'n passthrough configurat'n t' render yer math. In this case no shortcode or< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # codefence be involved an' th' library be not boarded by default so ye can< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # force load'n it by sett'n `math=true`.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This opt'n has an alias `math.force`.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > math< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # URL fer external MathJax library.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # version will be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMathJaxURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span > < span class = "c" > # ' https://unpkg.com/mathjax/es5/tex-mml-chtml.js' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Merrrmaid< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how Merrrmaid graphs be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Make graphs pan'ble an' zoom'ble< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # wit' a reset button fer th' zoom.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used or given as a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # parameter t' individual graphs.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidZoom< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Initializat'n opt'ns fer Merrrmaid.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidInitialize< / span > < span class = "p" > =< / span > < span class = "s1" > ' { " securityLevel" : " loose" }' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Force board Merrrmaid on every plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Merrrmaid will be boarded regardlessly. This opt'n be useful 'n case ye< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be us'n script'n t' render yer graph. In this case no shortcode or< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # codefence be involved an' th' library be not boarded by default so ye can< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # force load'n it by sett'n `mermaid.force=true`.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaid< / span > < span class = "p" > .< / span > < span class = "nx" > force< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # URL fer external Merrrmaid library.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # version will be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMermaidURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span > < span class = "c" > # ' https://unpkg.com/mermaid/dist/mermaid.min.js' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # OpenApi< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how OpenAPI specificat'ns be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Board OpenAPI on every plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If a, OpenAPI shortcode or codefence be found, th' opt'n will be ignored an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # OpenAPI will be boarded regardlessly. This opt'n be useful 'n case ye< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be us'n script'n t' render yer spec. In this case no shortcode or< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # codefence be involved an' th' library be not boarded by default so ye can< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # force load'n it by sett'n `openapi.force=true`.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > oppenapi< / span > < span class = "p" > .< / span > < span class = "nx" > force< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # URL fer external OpenAPI library.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # version will be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customOpenapiURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span > < span class = "c" > # ' https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # What t' do when a local OpenAPI spec link be not resolved.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Ye can control what should happen if a local OpenAPI spec link can not be resolved< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # t' a resource. If not set, th' unresolved link be written as given into th' result'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # output. If set t' `warning` th' same happens an' an additional warning be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # printed. If set t' `error` an error message be printed an' th' build be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # aborted.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Please note that this can not resolve files inside o' yer `static` directory.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > openapi< / span > < span class = "p" > .< / span > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< / div >
2023-11-28 22:52:52 +00:00
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/reference/index.html" > Reference< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< / section >
2023-11-28 22:52:52 +00:00
< / div >
< / main >
< / div >
2024-10-13 15:22:56 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1728832967" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1728832967" defer > < / script >
< script src = "/hugo-theme-relearn/js/theme.js?1728832967" defer > < / script >
2023-11-28 22:52:52 +00:00
< / body >
< / html >