<!DOCTYPE html>
<html lang="art-x-pir" dir="rtl" itemscope itemtype="http://schema.org/Article">
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.136.4">
<meta name="generator" content="Relearn 7.0.1+0938e8bd2e8bce8d47586b5c26e306892fcb70a9">
<meta name="description" content="All front matter for the Relearn theme">
<meta name="author" content="Sören Weber">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta name="twitter:title" content="Front Matter Reference :: Cap'n Hugo Relearrrn Theme">
<meta name="twitter:description" content="All front matter for the Relearn theme">
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.html">
<meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme">
<meta property="og:title" content="Front Matter Reference :: Cap'n Hugo Relearrrn Theme">
<meta property="og:description" content="All front matter for the Relearn theme">
<meta property="og:locale" content="art_x_pir">
<meta property="og:type" content="website">
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta itemprop="name" content="Front Matter Reference :: Cap'n Hugo Relearrrn Theme">
<meta itemprop="description" content="All front matter for the Relearn theme">
<meta itemprop="wordCount" content="3161">
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta itemprop="keywords" content="Reference">
<title>Front Matter Reference :: Cap'n Hugo Relearrrn Theme</title>
<link href="https://mcshelby.github.io/hugo-theme-relearn/authoring/frontmatter/reference/index.html" rel="alternate" hreflang="x-default">
<link href="https://mcshelby.github.io/hugo-theme-relearn/authoring/frontmatter/reference/index.html" rel="alternate" hreflang="en">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.html" rel="alternate" hreflang="art-x-pir">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.html" rel="canonical" type="text/html" title="Front Matter Reference :: Cap'n Hugo Relearrrn Theme">
<link href="/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.xml" rel="alternate" type="application/rss+xml" title="Front Matter Reference :: Cap'n Hugo Relearrrn Theme">
<link href="/hugo-theme-relearn/images/logo.svg?1729784207" rel="icon" type="image/svg+xml">
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1729784207" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1729784207" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/nucleus.css?1729784207" rel="stylesheet">
<link href="/hugo-theme-relearn/css/auto-complete.css?1729784207" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1729784207" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1729784207" rel="stylesheet">
<link href="/hugo-theme-relearn/css/fonts.css?1729784207" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1729784207" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/theme.css?1729784207" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1729784207" rel="stylesheet" id="R-variant-style">
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1729784207" rel="stylesheet" id="R-variant-chroma-style">
<link href="/hugo-theme-relearn/css/print.css?1729784207" rel="stylesheet" media="print">
<link href="/hugo-theme-relearn/css/format-print.css?1729784207" rel="stylesheet">
<script src="/hugo-theme-relearn/js/variant.js?1729784207"></script>
<script>
window.relearn = window.relearn || {};
window.relearn.relBasePath='..\/..\/..\/..';
window.relearn.relBaseUri='..\/..\/..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
// variant stuff
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' ] );
// 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>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.html">
<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">
<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>
</div>
<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>
<div class="topbar-content">
<div class="topbar-content-wrapper">
<nav class="TableOfContents">
<ul>
<li><a href="#index">Index</a></li>
<li><a href="#all-front-matter">All Front Matter</a></li>
<li><a href="#annotated-front-matter">Annotated Front Matter</a></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
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"><a itemprop="item" href="/hugo-theme-relearn/pir/authoring/frontmatter/index.html"><span itemprop="name">Front Matter</span></a><meta itemprop="position" content="2"> > </li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Reference</span><meta itemprop="position" content="3"></li>
</ol>
<div class="topbar-area topbar-area-end" data-area="end">
<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/reference/_index.pir.md" target="_self" title="Edit (CTRL+ALT+w)"><i class="fa-fw fas fa-pen"></i></a>
</div>
<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/reference/index.print.html" title="Prrrint whole chapterrr (CTRL+ALT+p)"><i class="fa-fw fas fa-print"></i></a>
</div>
<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/frontmatter/topbar/index.html" title="Topbarrr (🡒)"><i class="fa-fw fas fa-chevron-left"></i></a>
</div>
<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/meta/index.html" title="Meta Information (🡐)"><i class="fa-fw fas fa-chevron-right"></i></a>
</div>
<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>
<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>
<main id="R-body-inner" class="highlightable authoring" tabindex="-1">
<div class="flex-block-wrapper">
<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>
<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">math</span> <span class="p">=</span> <span class="kc">true</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">math</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">"math"</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="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>
<h3 id="s">S</h3>
<ul class="columnize">
<li><a href="/hugo-theme-relearn/pir/frontmatter/sidebarmenus/index.html">Sidebarmenus</a> (1)</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>
<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">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>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">[[</span><span class="nx">sidebarmenus</span><span class="p">]]</span>
</span></span><span class="line"><span class="cl"> <span class="nx">disableTitle</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'home'</span>
</span></span><span class="line"><span class="cl"> <span class="nx">main</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"> <span class="nx">pageRef</span> <span class="p">=</span> <span class="s1">''</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span> <span class="p">=</span> <span class="s1">'page'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">[[</span><span class="nx">sidebarmenus</span><span class="p">]]</span>
</span></span><span class="line"><span class="cl"> <span class="nx">disableTitle</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'shortcuts'</span>
</span></span><span class="line"><span class="cl"> <span class="nx">main</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span> <span class="p">=</span> <span class="s1">'menu'</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">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">sidebarmenus</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span>- <span class="nt">disableTitle</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">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">home</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">main</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">pageRef</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">type</span><span class="p">:</span><span class="w"> </span><span class="l">plank</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span>- <span class="nt">disableTitle</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">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">shortcuts</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">main</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">type</span><span class="p">:</span><span class="w"> </span><span class="l">menu</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">
</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">"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">"sidebarmenus"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"disableTitle"</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">"identifier"</span><span class="p">:</span> <span class="s2">"home"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"main"</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">"pageRef"</span><span class="p">:</span> <span class="s2">""</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">"page"</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><span class="line"><span class="cl"> <span class="nt">"disableTitle"</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">"identifier"</span><span class="p">:</span> <span class="s2">"shortcuts"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"main"</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">"type"</span><span class="p">:</span> <span class="s2">"menu"</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><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>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
</div>
</div>
</div>
</div>
<h2 id="annotated-front-matter">Annotated Front Matter</h2>
<div class="tab-panel" data-tab-group="83e35e1d82a83b8e1bdcc5da7e229fbd">
<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('83e35e1d82a83b8e1bdcc5da7e229fbd','toml')"
>
<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">
<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="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>
</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></span><span class="line"><span class="cl"><span class="c"># Define yer own sidebar menus.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: th' value used below</span>
</span></span><span class="line"><span class="cl"><span class="c"># Th' sidebar menus be built from this parameter. If not set, th' set value</span>
</span></span><span class="line"><span class="cl"><span class="c"># o' yer site's hugo.toml be used an' contains th' below default.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Menus be written from th' sidebar's top t' buttom 'n th' order given 'n</span>
</span></span><span class="line"><span class="cl"><span class="c"># this array.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Each entry can contain th' follow'n keys:</span>
</span></span><span class="line"><span class="cl"><span class="c"># - `type` be mandatory. Either `page` 'n case it should generate a tre from</span>
</span></span><span class="line"><span class="cl"><span class="c"># th' plank structure or `menu` 'n case it should generate a tree from a</span>
</span></span><span class="line"><span class="cl"><span class="c"># defined menu.</span>
</span></span><span class="line"><span class="cl"><span class="c"># - `identifier` be mandatory. In case o' `type=page`, anyth'n can be used,</span>
</span></span><span class="line"><span class="cl"><span class="c"># 'n case o' `type=menu` th' `identifier` key must be identical t' th'</span>
</span></span><span class="line"><span class="cl"><span class="c"># key o' th' menu definit'n.</span>
</span></span><span class="line"><span class="cl"><span class="c"># - `main`, boolean. If `true`, th' first tree level be spaced more generous</span>
</span></span><span class="line"><span class="cl"><span class="c"># an' th' text be emphasized. Default: `true` fer `type=page` an' `false`</span>
</span></span><span class="line"><span class="cl"><span class="c"># fer `type=menu`</span>
</span></span><span class="line"><span class="cl"><span class="c"># - `disableTitle`, boolean. If `true`, there be no title above th' tree.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: `true` fer `type=page` an' `false` fer `type=menu`. If a title</span>
</span></span><span class="line"><span class="cl"><span class="c"># should be used, 'n case o' `type=page` it will be taken from th' page's</span>
</span></span><span class="line"><span class="cl"><span class="c"># `menuTitle` front matter an' if not set, from th' translat'n files, us'n</span>
</span></span><span class="line"><span class="cl"><span class="c"># th' menu `identifier` as key. In case o' `type=menu` it will be taken</span>
</span></span><span class="line"><span class="cl"><span class="c"># from th' menu `title` accord'n t' Hugo's documentat'n an' if not set</span>
</span></span><span class="line"><span class="cl"><span class="c"># from th' menu `name` an' if this be not set form th' page's `linkTitle`.</span>
</span></span><span class="line"><span class="cl"><span class="c"># - `pageRef`, optional. In case o' `type=page` this be th' start'n page's</span>
</span></span><span class="line"><span class="cl"><span class="c"># path. If not set, th' home plank will be used.</span>
</span></span><span class="line"><span class="cl"><span class="nx">sidebarmenus</span> <span class="p">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">type</span> <span class="p">=</span> <span class="s1">'page'</span><span class="p">,</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'home'</span><span class="p">,</span> <span class="nx">main</span> <span class="p">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nx">disableTitle</span> <span class="p">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nx">pageRef</span> <span class="p">=</span> <span class="s1">''</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">type</span> <span class="p">=</span> <span class="s1">'menu'</span><span class="p">,</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'shortcuts'</span><span class="p">,</span> <span class="nx">main</span> <span class="p">=</span> <span class="kc">false</span><span class="p">,</span> <span class="nx">disableTitle</span> <span class="p">=</span> <span class="kc">false</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"><span class="p">]</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"># 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>
</span></span><span class="line"><span class="cl"><span class="err">+++</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/reference/index.html">Reference</a></li>
</ul>
</div>
</footer>
</article>
</div>
</main>
</div>
<script src="/hugo-theme-relearn/js/clipboard.min.js?1729784207" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1729784207" defer></script>
<script src="/hugo-theme-relearn/js/theme.js?1729784207" defer></script>
</body>
</html>