mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-30 11:13:06 +00:00
896 lines
94 KiB
HTML
896 lines
94 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr" 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+4ed15c8096764c75a97ef858bb3a4c0d784fe888">
|
|
<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 :: Hugo Relearn 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/authoring/frontmatter/reference/index.html">
|
|
<meta property="og:site_name" content="Hugo Relearn Theme">
|
|
<meta property="og:title" content="Front Matter Reference :: Hugo Relearn Theme">
|
|
<meta property="og:description" content="All front matter for the Relearn theme">
|
|
<meta property="og:locale" content="en">
|
|
<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 :: Hugo Relearn Theme">
|
|
<meta itemprop="description" content="All front matter for the Relearn theme">
|
|
<meta itemprop="wordCount" content="3158">
|
|
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="keywords" content="Reference">
|
|
<title>Front Matter Reference :: Hugo Relearn 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/authoring/frontmatter/reference/index.html" rel="canonical" type="text/html" title="Front Matter Reference :: Hugo Relearn Theme">
|
|
<link href="/hugo-theme-relearn/authoring/frontmatter/reference/index.xml" rel="alternate" type="application/rss+xml" title="Front Matter Reference :: Hugo Relearn Theme">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1729780238" rel="icon" type="image/svg+xml">
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1729780238" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1729780238" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1729780238" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1729780238" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1729780238" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1729780238" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1729780238" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1729780238" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1729780238" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1729780238" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1729780238" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/print.css?1729780238" rel="stylesheet" media="print">
|
|
<link href="/hugo-theme-relearn/css/format-print.css?1729780238" rel="stylesheet">
|
|
<script src="/hugo-theme-relearn/js/variant.js?1729780238"></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 to clipboard`;
|
|
window.T_Copied_to_clipboard = `Copied to clipboard!`;
|
|
window.T_Copy_link_to_clipboard = `Copy link to clipboard`;
|
|
window.T_Link_copied_to_clipboard = `Copied link to clipboard!`;
|
|
window.T_Reset_view = `Reset view`;
|
|
window.T_View_reset = `View reset!`;
|
|
window.T_No_results_found = `No results found for "{0}"`;
|
|
window.T_N_results_found = `{1} results found for "{0}"`;
|
|
</script>
|
|
<style>
|
|
#R-body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/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 of 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/authoring/index.html"><span itemprop="name">Authoring</span></a><meta itemprop="position" content="1"> > </li><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/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.en.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/authoring/frontmatter/reference/index.print.html" title="Print whole chapter (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/authoring/frontmatter/topbar/index.html" title="Topbar (🡐)"><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/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="More"><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 Hugo page must have front matter.</p>
|
|
<p>In addition to <a href="https://gohugo.io/content-management/front-matter/#fields" rel="external" target="_self">Hugo’s standard front matter</a>, the Relearn theme offers extras settings listed here.</p>
|
|
<p>Throughout the documentation, theme-specific front matter is marked with 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 to the root of your 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/frontmatter/alwaysopen/index.html">Alwaysopen</a> (1)</li>
|
|
</ul>
|
|
<h3 id="c">C</h3>
|
|
<ul class="columnize">
|
|
<li><a href="/hugo-theme-relearn/frontmatter/collapsiblemenu/index.html">CollapsibleMenu</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/custommathjaxurl/index.html">CustomMathJaxURL</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/custommermaidurl/index.html">CustomMermaidURL</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/customopenapiurl/index.html">CustomOpenapiURL</a> (1)</li>
|
|
</ul>
|
|
<h3 id="d">D</h3>
|
|
<ul class="columnize">
|
|
<li><a href="/hugo-theme-relearn/frontmatter/description/index.html">Description</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/disablebreadcrumb/index.html">DisableBreadcrumb</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/disablenextprev/index.html">DisableNextPrev</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/disabletoc/index.html">DisableToc</a> (1)</li>
|
|
</ul>
|
|
<h3 id="e">E</h3>
|
|
<ul class="columnize">
|
|
<li><a href="/hugo-theme-relearn/frontmatter/editurl/index.html">EditURL</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/externallinktarget/index.html">ExternalLinkTarget</a> (1)</li>
|
|
</ul>
|
|
<h3 id="h">H</h3>
|
|
<ul class="columnize">
|
|
<li><a href="/hugo-theme-relearn/frontmatter/headingpost/index.html">HeadingPost</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/headingpre/index.html">HeadingPre</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/hidden/index.html">Hidden</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/highlightwrap/index.html">HighlightWrap</a> (1)</li>
|
|
</ul>
|
|
<h3 id="i">I</h3>
|
|
<ul class="columnize">
|
|
<li><a href="/hugo-theme-relearn/frontmatter/image.errorlevel/index.html">Image.errorlevel</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/imageeffects/index.html">ImageEffects</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/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/frontmatter/lastmodifierdisplayname/index.html">LastModifierDisplayName</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/lastmodifieremail/index.html">LastModifierEmail</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/link.errorlevel/index.html">Link.errorlevel</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/linktitle/index.html">LinkTitle</a> (1)</li>
|
|
</ul>
|
|
<h3 id="m">M</h3>
|
|
<ul class="columnize">
|
|
<li><a href="/hugo-theme-relearn/frontmatter/math/index.html">Math</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/math.force/index.html">Math.force</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/mathjaxinitialize/index.html">MathJaxInitialize</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/menupost/index.html">MenuPost</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/menupre/index.html">MenuPre</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/mermaid.force/index.html">Mermaid.force</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/mermaidinitialize/index.html">MermaidInitialize</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/mermaidzoom/index.html">MermaidZoom</a> (1)</li>
|
|
</ul>
|
|
<h3 id="o">O</h3>
|
|
<ul class="columnize">
|
|
<li><a href="/hugo-theme-relearn/frontmatter/openapi.errorlevel/index.html">Openapi.errorlevel</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/openapi.force/index.html">Openapi.force</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/ordersectionsby/index.html">Ordersectionsby</a> (2)</li>
|
|
</ul>
|
|
<h3 id="s">S</h3>
|
|
<ul class="columnize">
|
|
<li><a href="/hugo-theme-relearn/frontmatter/sidebarmenus/index.html">Sidebarmenus</a> (1)</li>
|
|
</ul>
|
|
<h2 id="all-front-matter">All Front Matter</h2>
|
|
<p>Here’s a list of all available front matter with example values. Default values are described in the <a href="/hugo-theme-relearn/authoring/frontmatter/reference/index.html#annotated-front-matter">annotated example</a> below or in each front matter’s documentation.</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">description</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">description</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">page</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 Page</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="765044945fce0cfd1c3e78a46c6d77c6">
|
|
<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('765044945fce0cfd1c3e78a46c6d77c6','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 option value is said to be not set, you can achieve the same behavior</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># by giving it an empty string 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"># Hugo</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These options usually apply to other themes as well.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># The social media image of your page.</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 is used for generating social media meta information for the opengraph</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># protocol and twitter cards.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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"># The title of your page.</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 page without a title is treated as a hidden page.</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"># The description of your page.</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 is used for generating HTML meta tags, social media meta information</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># for the opengraph protocol and twitter cards.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used for the html</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># meta tag, social media meta information for the opengraph protocol and</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">description</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"># The page design to 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 the layout of your page. The theme ships 'home', 'chapter' and</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># 'default'. If not set, 'default' is 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"># Relearn Theme</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These options are specific to the Relearn 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 options modify the topbar appearance.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Hide the table of 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 the TOC button is hidden, also the keyboard shortcut is disabled.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 the 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 the breadcrumbs are hidden, the title of the displayed page will still be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># shown in the 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 and Previous navigation 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 the navigation buttons are hidden, also the keyboard shortcuts are</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"># The URL prefix to edit a page.</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 in the topbar. If the button is hidden,</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># also the keyboard shortcuts are disabled. The value can contain the macro</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># `${FilePath}` which will be replaced by the file path of your displayed page.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used. If the global</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># parameter is given but you want to hide the button for the displayed page,</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># you can set the value to an empty string. If instead of hiding you want to have</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># an disabled button, you can set the value to a string containing just spaces.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This is useful if you want to give the opportunity for people to create merge</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># request for your content.</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 options modify the 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"># The title displayed in the menu. If not set the `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 for the title in navigation 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"># The title of the page in the menu will be prefixed by this HTML content.</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 for the title in navigation 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"># The title of the page in the menu will be suffixed by this HTML content.</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"># The order of navigation 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' (adhering to</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, the value of the parent menu entry is 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"># The initial expand state of 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"># in the menu. If not set, the first menu level is set to false, all others</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># levels are set to true. If not set, the value of the parent menu entry is used.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If the displayed page has submenus, they will always been displayed expanded</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># regardless of this option.</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 for 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 to true, a submenu in the sidebar will be displayed in a collapsible</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># tree view and a clickable expander is set in front of the entry.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 your own sidebar menus.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: the value used below</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># The sidebar menus are built from this parameter. If not set, the set value</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># of your site's hugo.toml is used and contains the below default.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Menus are written from the sidebar's top to buttom in the order given in</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 the following keys:</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># - `type` is mandatory. Either `page` in case it should generate a tre from</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># the page structure or `menu` in 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` is mandatory. In case of `type=page`, anything can be used,</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># in case of `type=menu` the `identifier` key must be identical to the</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># key of the menu definition.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># - `main`, boolean. If `true`, the first tree level is spaced more generous</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># and the text is emphasized. Default: `true` for `type=page` and `false`</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># for `type=menu`</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># - `disableTitle`, boolean. If `true`, there is no title above the tree.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: `true` for `type=page` and `false` for `type=menu`. If a title</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># should be used, in case of `type=page` it will be taken from the page's</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># `menuTitle` front matter and if not set, from the translation files, using</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># the menu `identifier` as key. In case of `type=menu` it will be taken</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># from the menu `title` according to Hugo's documentation and if not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># from the menu `name` and if this is not set form the page's `linkTitle`.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># - `pageRef`, optional. In case of `type=page` this is the starting page's</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># path. If not set, the home page 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 pages</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how hidden pages are treated.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># A page flagged as hidden, is only removed from the navigation menu if you are</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># currently not on this page or the hidden page is not part of current page's</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># ancestors. For all other functionality in Hugo a hidden page behaves like any</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># other page 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 is true, the page is hidden from the 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"># Content</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These options modify how your content is displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Prefix for the title in the content 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"># The title of the page heading will be prefixed by this HTML content.</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 for the title in the content 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"># The title of the page heading will be suffixed by this HTML content.</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 of the 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 in the 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 of the 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 with LastModifierDisplayName, it will be displayed in the</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 options configure how code is displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Wrap for 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 of code blocks wrap around if the line is too long to be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># displayed on screen. If you dislike this behavior, you 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"># Note that lines always wrap in print mode regardless of this option.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used or given as a</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># parameter to 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 options configure how the include shortcode works.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># What to do when path is 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"># You can control what should happen if a path can not be resolved to as</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># a resource or via the file system. If not set, no output will be written</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># for the unresolved path. If set to `warning` the same happens and an additional</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># warning is printed. If set to `error` an error message is printed and the build</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># is aborted.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 options configure how images are displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># What to do when local image link is 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"># You can control what should happen if a local image can not be resolved to as</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># a resource. If not set, the unresolved link is written as given into the resulting</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># output. If set to `warning` the same happens and an additional warning is</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># printed. If set to `error` an error message is printed and the build is</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 of your `static` directory.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 the documentation for how you can even add your own arbitrary effects to</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># the list.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># All effect values default to the values of your site's hugo.toml and can be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># overridden through URL parameter given to the image. See the documentation for</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 options configure how links are displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># What to do when local page link is 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"># You can control what should happen if a local link can not be resolved to a</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># page. If not set, the unresolved link is written as given into the resulting</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># output. If set to `warning` the same happens and an additional warning is</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># printed. If set to `error` an error message is printed and the build is</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 with Hugo < 0.123.0 + `uglyURLs=true` this can lead to 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, the set value of your site's hugo.toml is 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 to 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 you can define how they are opened in your browser. All</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># values for the HTML `target` attribute of the `a` element are allowed. The</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># default value opens external links in a separate browser tab. If you want</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># to open those links in the same tab, use '_self'.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 options configure how math formulae are displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Initialization options for 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 the MathJaxdocumentation for possible parameter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 load Math on every page.</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 is found, the option will be ignored and</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Math will be loaded regardlessly. This option is useful in case you</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># are using passthrough configuration to render your math. In this case no shortcode or</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># codefence is involved and the library is not loaded by default so you can</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># force loading it by setting `math=true`.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This option has an alias `math.force`.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 for 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 the remote location of the MathJax library. By default the 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, the set value of your site's hugo.toml is 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"># Mermaid</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how Mermaid graphs are displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Make graphs panable and zoomable</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 to make them zoomable. Zoomable graphs come</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># with a reset button for the zoom.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used or given as a</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># parameter to 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"># Initialization options for Mermaid.</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 the Mermaid documentation for possible parameter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 load Mermaid on every page.</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 Mermaid shortcode or codefence is found, the option will be ignored and</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Mermaid will be loaded regardlessly. This option is useful in case you</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to render your graph. In this case no shortcode or</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># codefence is involved and the library is not loaded by default so you can</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># force loading it by setting `mermaid.force=true`.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 for external Mermaid 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 the remote location of the Mermaid library. By default the 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, the set value of your site's hugo.toml is 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 options configure how OpenAPI specifications are displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Load OpenAPI on every page.</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 is found, the option will be ignored and</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># OpenAPI will be loaded regardlessly. This option is useful in case you</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to render your spec. In this case no shortcode or</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># codefence is involved and the library is not loaded by default so you can</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># force loading it by setting `openapi.force=true`.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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 for 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 the remote location of the OpenAPI library. By default the 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, the set value of your site's hugo.toml is 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 to do when a local OpenAPI spec link is 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"># You 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"># to a resource. If not set, the unresolved link is written as given into the resulting</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># output. If set to `warning` the same happens and an additional warning is</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># printed. If set to `error` an error message is printed and the build is</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 of your `static` directory.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is 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="Categories" 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/categories/reference/index.html">Reference</a></li>
|
|
</ul>
|
|
</div>
|
|
</footer>
|
|
</article>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1729780238" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1729780238" defer></script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1729780238" defer></script>
|
|
</body>
|
|
</html>
|