<!DOCTYPE html> <html lang="art-pir" dir="rtl"> <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.120.4"> <meta name="generator" content="Relearn 5.23.2+tip"> <meta name="description" content="Documentation for Hugo 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="Frrrontmatter :: Cap'n Hugo Relearrrn Theme"> <meta name="twitter:description" content="Documentation for Hugo Relearn Theme"> <meta property="og:title" content="Frrrontmatter :: Cap'n Hugo Relearrrn Theme"> <meta property="og:description" content="Documentation for Hugo Relearn Theme"> <meta property="og:type" content="website"> <meta property="og:url" content="https://McShelby.github.io/hugo-theme-relearn/pir/cont/frontmatter/index.html"> <meta property="og:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png"> <meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme"> <title>Frrrontmatter :: Cap'n Hugo Relearrrn Theme</title> <link href="https://McShelby.github.io/hugo-theme-relearn/cont/frontmatter/index.html" rel="alternate" hreflang="x-default"> <link href="https://McShelby.github.io/hugo-theme-relearn/cont/frontmatter/index.html" rel="alternate" hreflang="en"> <link href="https://McShelby.github.io/hugo-theme-relearn/pir/cont/frontmatter/index.html" rel="alternate" hreflang="art-pir"> <link href="https://McShelby.github.io/hugo-theme-relearn/pir/cont/frontmatter/index.html" rel="canonical" type="text/html" title="Frrrontmatter :: Cap'n Hugo Relearrrn Theme"> <link href="../../../pir/cont/frontmatter/index.xml" rel="alternate" type="application/rss+xml" title="Frrrontmatter :: Cap'n Hugo Relearrrn Theme"> <link href="../../../images/logo.svg?1701463045" rel="icon" type="image/svg+xml"> <!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use --> <link href="../../../css/fontawesome-all.min.css?1701463047" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fontawesome-all.min.css?1701463047" rel="stylesheet"></noscript> <link href="../../../css/nucleus.css?1701463047" rel="stylesheet"> <link href="../../../css/auto-complete.css?1701463047" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/auto-complete.css?1701463047" rel="stylesheet"></noscript> <link href="../../../css/perfect-scrollbar.min.css?1701463047" rel="stylesheet"> <link href="../../../css/fonts.css?1701463047" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fonts.css?1701463047" rel="stylesheet"></noscript> <link href="../../../css/theme.css?1701463047" rel="stylesheet"> <link href="../../../css/theme-relearn-auto.css?1701463047" rel="stylesheet" id="R-variant-style"> <link href="../../../css/chroma-relearn-auto.css?1701463047" rel="stylesheet" id="R-variant-chroma-style"> <link href="../../../css/variant.css?1701463047" rel="stylesheet"> <link href="../../../css/print.css?1701463047" rel="stylesheet" media="print"> <link href="../../../css/format-print.css?1701463047" rel="stylesheet"> <link href="../../../css/ie.css?1701463047" rel="stylesheet"> <script src="../../../js/url.js?1701463047"></script> <script src="../../../js/variant.js?1701463047"></script> <script> // hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic: // https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72 window.index_js_url="../../../pir/index.search.js"; var root_url="../../../"; var baseUri=root_url.replace(/\/$/, ''); window.relearn = window.relearn || {}; window.relearn.baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/'; // variant stuff window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', '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="../../../pir/cont/frontmatter/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> <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="../../../pir/cont/index.html"><span itemprop="name">Rambl'n</span></a><meta itemprop="position" content="1"> > </li><li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Frrrontmatter</span><meta itemprop="position" content="2"></li> </ol> <div class="topbar-area topbar-area-end" data-area="end"> </div> </div> </nav> <div id="R-main-overlay"></div> <main id="R-body-inner" class="highlightable default" tabindex="-1"> <div class="flex-block-wrapper"> <article class="default"> <header class="headline"> </header> <h1 id="frrrontmatter">Frrrontmatter</h1> <p>Each Cap'n Hugo plank has t' define a <a href="https://gohugo.io/content/front-matter/" target="_blank">frontmatter</a> 'n <em>toml</em>, <em>yaml</em> or <em>json</em>. This ship will use <em>toml</em> fer documentat'n 'n all cases.</p> <div class="wrap-code highlight"><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 given 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 aswell.</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="s2">"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="s2">"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="s2">""</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">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</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 apperance.</span> </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c"># Th' title 'n main menu.</span> </span></span><span class="line"><span class="cl"><span class="c"># Default: <title></span> </span></span><span class="line"><span class="cl"><span class="c"># If set, this will be used fer th' page's menu entry instead o' th' `title`</span> </span></span><span class="line"><span class="cl"><span class="c"># opt'n.</span> </span></span><span class="line"><span class="cl"><span class="nx">menuTitle</span> <span class="p">=</span> <span class="s2">""</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 main 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="s2">""</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 main 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="s2">""</span> </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c"># Th' order o' main 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="s2">"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="s2">""</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">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</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' main 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="s2">""</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="s2">""</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="s2">""</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="s2">""</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"># 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"># 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 thru 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">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"># 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="s2">"{}"</span> </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c"># Only board MathJax if needed.</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"># If a Math shortcode be found, th' opt'n will be ignored an'</span> </span></span><span class="line"><span class="cl"><span class="c"># MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye</span> </span></span><span class="line"><span class="cl"><span class="c"># be us'n script'n t' set up 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. In this case</span> </span></span><span class="line"><span class="cl"><span class="c"># ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t'</span> </span></span><span class="line"><span class="cl"><span class="c"># be boarded.</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">disableMathJax</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"># 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="s2">""</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="s2">"{ \"securityLevel\": \"loose\" }"</span> </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c"># Only board Merrrmaid if needed.</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"># 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. Th' opt'n be still useful 'n case ye</span> </span></span><span class="line"><span class="cl"><span class="c"># be us'n script'n t' set up 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. In this case</span> </span></span><span class="line"><span class="cl"><span class="c"># ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t'</span> </span></span><span class="line"><span class="cl"><span class="c"># be boarded.</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">disableMermaid</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"># 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="s2">""</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"># Only board OpenAPI if needed.</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"># If a OpenAPI shortcode 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. Th' opt'n be still useful 'n case ye</span> </span></span><span class="line"><span class="cl"><span class="c"># be us'n script'n t' set up 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. In this case</span> </span></span><span class="line"><span class="cl"><span class="c"># ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t'</span> </span></span><span class="line"><span class="cl"><span class="c"># be boarded.</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">disableOpenapi</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"># 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="s2">""</span> <span class="c"># "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"</span> </span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div><h2 id="some-detailed-examples">Some Detailed Examples</h2> <h3 id="add-icon-to-a-menu-entry">Add Ay'con t' a Menu Entry</h3> <p>In th' plank frontmatter, add a <code>menuPre</code> param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="err">+++</span> </span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"GitHub repo"</span> </span></span><span class="line"><span class="cl"><span class="nx">menuPre</span> <span class="p">=</span> <span class="s2">"<i class='fab fa-github'></i> "</span> </span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div><p><a href="#R-image-54a0af7612b8f5e6f3bd88163cff9955" class="lightbox-link"><img src="../../../cont/frontmatter/frontmatter-icon.png?width=18.75rem" alt="Title wit' icon" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 18.75rem;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-54a0af7612b8f5e6f3bd88163cff9955"><img src="../../../cont/frontmatter/frontmatter-icon.png?width=18.75rem" alt="Title wit' icon" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p> <h3 id="ordering-sibling-menupage-entries">Order'n Sibl'n Menu/Page Entries</h3> <p>Cap'n Hugo provides a <a href="https://gohugo.io/content/ordering/" target="_blank">flex'ble way</a> t' handle order fer yer planks.</p> <p>Th' simplest way be t' set <code>weight</code> parameter t' a number.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="err">+++</span> </span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"My page"</span> </span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">5</span> </span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div><h3 id="using-a-custom-title-for-menu-entries">Us'n a Custom Title fer Menu Entries</h3> <p>By default, th' Relearrrn theme will use a page’s <code>title</code> attribute fer th' menu item (or <code>linkTitle</code> if defined).</p> <p>But a page’s title has t' be descriptive on its own while th' menu be a hierarchy. We’ve added th' <code>menuTitle</code> parameter fer that purpose:</p> <p>For example (for a plank named <code>content/install/linux.md</code>):</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="err">+++</span> </span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Install on Linux"</span> </span></span><span class="line"><span class="cl"><span class="nx">menuTitle</span> <span class="p">=</span> <span class="s2">"Linux"</span> </span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div><h3 id="override-expand-state-rules-for-menu-entries">Override Expand State Rules fer Menu Entries</h3> <p>Ye can change how th' theme expands menu entries on th' side o' th' rrrambl'n wit' th' <code>alwaysopen</code> sett'n on a per plank basis. If <code>alwaysopen=false</code> fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.</p> <p>Th' theme generates th' menu based on th' follow'n rules:</p> <ul> <li>all parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns</li> <li>immediate children entries o' th' active plank be shown regardless o' any sett'ns</li> <li>if not overridden, all other first level entries behave like they would have been given <code>alwaysopen=false</code></li> <li>if not overridden, all other entries o' levels besides th' first behave like they would have been given <code>alwaysopen=true</code></li> <li>all vis'ble entries show their immediate children entries if <code>alwaysopen=true</code>; this proceeds recursively</li> <li>all remain'n entries be not shown</li> </ul> <p>Ye can see this feature 'n act'n on th' example plank fer <a href="../../../shortcodes/children/index.html">children shortcode</a> an' its children planks.</p> <h2 id="disable-section-pages">Dis'ble Sect'n Planks</h2> <p>Ye may want t' structure yer planks 'n a hierachical way but don’t want t' generate planks fer those sections? Th' theme got ye covered.</p> <p>T' stay wit' th' initial example: Suppose ye want <code>level-one</code> appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.</p> <p>For this, open <code>content/level-one/_index.md</code> an' add th' follow'n frontmatter</p> <div class="wrap-code highlight"><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">collapsibleMenu</span> <span class="p">=</span> <span class="kc">true</span> <span class="c"># this adds th' expander t' th' menu entry if not already set 'n yer hugo.toml</span> </span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span> </span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s2">"never"</span> <span class="c"># no plank will be generated so th' plank does not have a url</span> </span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div> <footer class="footline"> </footer> </article> </div> </main> </div> <script src="../../../js/clipboard.min.js?1701463048" defer></script> <script src="../../../js/perfect-scrollbar.min.js?1701463048" defer></script> <script src="../../../js/theme.js?1701463048" defer></script> </body> </html>