mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2025-01-31 08:57:15 +00:00
1687 lines
147 KiB
HTML
1687 lines
147 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article" data-r-output-format="print">
|
|
<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.142.0">
|
|
<meta name="generator" content="Relearn 7.3.2+db9ca5d2958a7e5956d4f37f6d79e8d2076b8381">
|
|
<meta name="description" content="All things front matter">
|
|
<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 :: Hugo Relearn Theme">
|
|
<meta name="twitter:description" content="All things front matter">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/authoring/frontmatter/index.html">
|
|
<meta property="og:site_name" content="Hugo Relearn Theme">
|
|
<meta property="og:title" content="Front Matter :: Hugo Relearn Theme">
|
|
<meta property="og:description" content="All things front matter">
|
|
<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 :: Hugo Relearn Theme">
|
|
<meta itemprop="description" content="All things front matter">
|
|
<meta itemprop="wordCount" content="33">
|
|
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="keywords" content="Reference">
|
|
<title>Front Matter :: Hugo Relearn Theme</title>
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/authoring/frontmatter/index.html" rel="alternate" hreflang="x-default">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/authoring/frontmatter/index.html" rel="alternate" hreflang="en">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/frontmatter/index.html" rel="alternate" hreflang="art-x-pir">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/authoring/frontmatter/index.html" rel="canonical" type="text/html" title="Front Matter :: Hugo Relearn Theme">
|
|
<link href="/hugo-theme-relearn/authoring/frontmatter/index.xml" rel="alternate" type="application/rss+xml" title="Front Matter :: Hugo Relearn Theme">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1738193499" rel="icon" type="image/svg+xml">
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1738193499" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1738193499" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1738193499" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1738193499" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1738193499" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme.min.css?1738193499" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/format-print.min.css?1738193499" rel="stylesheet" id="R-format-style">
|
|
<script>
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.relBasePath='..\/..';
|
|
window.relearn.relBaseUri='..\/..\/..';
|
|
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
|
window.relearn.min = `.min`;
|
|
window.relearn.disableAnchorCopy=false;
|
|
window.relearn.disableAnchorScrolling=false;
|
|
// variant stuff
|
|
window.relearn.themevariants = [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ];
|
|
window.relearn.customvariantname = "my-custom-variant";
|
|
window.relearn.changeVariant = function(variant) {
|
|
var oldVariant = document.documentElement.dataset.rThemeVariant;
|
|
window.localStorage.setItem(window.relearn.absBaseUri + "/variant", variant);
|
|
document.documentElement.dataset.rThemeVariant = variant;
|
|
if (oldVariant != variant) {
|
|
document.dispatchEvent( new CustomEvent('themeVariantLoaded', { detail: { variant, oldVariant } }) );
|
|
}
|
|
}
|
|
window.relearn.markVariant = function() {
|
|
var variant = window.localStorage.getItem(window.relearn.absBaseUri + "/variant");
|
|
var select = document.querySelector("#R-select-variant");
|
|
if (select) {
|
|
select.value = variant;
|
|
}
|
|
}
|
|
window.relearn.initVariant = function() {
|
|
var variant = window.localStorage.getItem(window.relearn.absBaseUri + "/variant") ?? "";
|
|
if( variant == window.relearn.customvariantname ){
|
|
}else if( !variant || !window.relearn.themevariants.includes(variant) ){
|
|
variant = window.relearn.themevariants[0];
|
|
window.localStorage.setItem(window.relearn.absBaseUri + "/variant", variant);
|
|
}
|
|
document.documentElement.dataset.rThemeVariant = variant;
|
|
}
|
|
window.relearn.initVariant();
|
|
window.relearn.markVariant();
|
|
// 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>
|
|
<script src="/hugo-theme-relearn/js/variant.js?1738193499"></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/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">
|
|
</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"><span itemprop="name">Front Matter</span><meta itemprop="position" content="2"></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/docs/content/authoring/frontmatter/_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/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/structure/index.html" title="Directory Structure (🡐)"><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/frontmatter/designs/index.html" title="Page Designs (🡒)"><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">Front Matter</h1>
|
|
|
|
<div class="children children-h2 children-sort-">
|
|
<h2><a href="/hugo-theme-relearn/authoring/frontmatter/designs/index.html">Page Designs</a></h2><p>How to vary layouts by using page designs</p>
|
|
<h2><a href="/hugo-theme-relearn/authoring/frontmatter/menus/index.html">Menus</a></h2><p>Setting the behavior of the menus</p>
|
|
<h2><a href="/hugo-theme-relearn/authoring/frontmatter/linking/index.html">Linking</a></h2><p>What options are available for links and images</p>
|
|
<h2><a href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html">Topbar</a></h2><p>Configure the topbar</p>
|
|
<h2><a href="/hugo-theme-relearn/authoring/frontmatter/reference/index.html">Reference</a></h2><p>All front matter for the Relearn theme</p>
|
|
</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>
|
|
<section>
|
|
<h1 class="a11y-only">Subsections of Front Matter</h1>
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="page-designs">Page Designs</h1>
|
|
|
|
<p>Page designs are used to provide different layouts for your pages.</p>
|
|
<p>A page is displayed by exactly one page design and is represented by <a href="https://gohugo.io/content-management/front-matter/#type" rel="external" target="_self">Hugo’s reserved <code>type</code> front matter</a>.</p>
|
|
<p>The Relearn theme ships with the page designs <code>home</code>, <code>chapter</code>, and <code>default</code> for the HTML output format but you can <a href="/hugo-theme-relearn/configuration/customization/designs/index.html">define further custom page designs</a>.</p>
|
|
<h2 id="using-a-page-design">Using a Page Design</h2>
|
|
<p>Regardless of shipped or custom page design, you are using them in the same way.</p>
|
|
<ul>
|
|
<li>
|
|
<p>If you have an <a href="https://gohugo.io/content-management/archetypes/" rel="external" target="_self">archetype file</a>, you can just do</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new --kind chapter chapter1/_index.md</span></span></code></pre></div>
|
|
</li>
|
|
<li>
|
|
<p>If you are creating your Markdown files manually, you can achieve the same by just setting <code>type='chapter'</code> in the front matter to make your page displayed with the <code>chapter</code> page design.</p>
|
|
<div class="tab-panel" data-tab-group="b9c438eaa2bc48a4413cd2971954fb08">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="_indexmd"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('b9c438eaa2bc48a4413cd2971954fb08','_indexmd')"
|
|
>
|
|
<span class="tab-nav-text">_index.md</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="_indexmd"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="err">+++</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Chapter 1"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">type</span> <span class="p">=</span> <span class="s2">"chapter"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div></li>
|
|
</ul>
|
|
<p>If no <code>type</code> is set in your front matter or the page design doesn’t exist for a given output format, the page is treated as if <code>type='default'</code> was set.</p>
|
|
<h2 id="predefined-designs-for-the-html-output-format">Predefined Designs for the HTML Output Format</h2>
|
|
<h3 id="archetypes-home">Home</h3>
|
|
<p>A <strong>Home</strong> page is the starting page of your project. It’s best to have only one page of this kind in your project.</p>
|
|
<p>To create a home page, run the following command</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new --kind home _index.md</span></span></code></pre></div>
|
|
<p><a href="#R-image-5200f40b846d26e99d7931ca09065d67" class="lightbox-link"><img alt="Home page" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/authoring/frontmatter/designs/pages-home.png?width=60pc" style=" height: auto; width: 60pc;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-5200f40b846d26e99d7931ca09065d67"><img alt="Home page" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/authoring/frontmatter/designs/pages-home.png?width=60pc"></a></p>
|
|
<h3 id="archetypes-chapter">Chapter</h3>
|
|
<p>A <strong>Chapter</strong> displays a page meant to be used as introduction for a set of child pages.</p>
|
|
<p>Commonly, it contains a title front matter and a short description in the content.</p>
|
|
<p>To create a chapter page, run the following command</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new --kind chapter chapter1/_index.md</span></span></code></pre></div>
|
|
<p>If a numerical <code>weight</code> front matter is set, it will be used to generate the subtitle of the chapter page. Set the number to a consecutive value starting at 1 for each new chapter on the same directory level.</p>
|
|
<p><a href="#R-image-6e0cff39def5cc3d8863cf478142b321" class="lightbox-link"><img alt="Chapter page" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/authoring/frontmatter/designs/pages-chapter.png?width=60pc" style=" height: auto; width: 60pc;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-6e0cff39def5cc3d8863cf478142b321"><img alt="Chapter page" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/authoring/frontmatter/designs/pages-chapter.png?width=60pc"></a></p>
|
|
<h3 id="archetypes-default">Default</h3>
|
|
<p>A <strong>Default</strong> page is any other content page.</p>
|
|
<p>To create a default page, run either one of the following commands</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new chapter1/page1/_index.md</span></span></code></pre></div>
|
|
<p>or</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new chapter1/page1.md</span></span></code></pre></div>
|
|
<p><a href="#R-image-2537385c904a5c11bbe34f40f5dce2e4" class="lightbox-link"><img alt="Default page" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/authoring/frontmatter/designs/pages-default.png?width=60pc" style=" height: auto; width: 60pc;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-2537385c904a5c11bbe34f40f5dce2e4"><img alt="Default page" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/authoring/frontmatter/designs/pages-default.png?width=60pc"></a></p>
|
|
|
|
<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/howto/index.html">Howto</a></li>
|
|
</ul>
|
|
</div>
|
|
</footer>
|
|
</article>
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="menus">Menus</h1>
|
|
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="linking">Linking</h1>
|
|
|
|
<h2 id="opening-links">Opening Links</h2>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> By default, external links open in a new tab. To change this, use the <code>externalLinkTarget</code> setting with a proper <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target" rel="external" target="_self">link target</a>.</p>
|
|
<p>For example, this will open links in the same tab</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">externalLinkTarget</span> <span class="p">=</span> <span class="s1">'_self'</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">externalLinkTarget</span><span class="p">:</span><span class="w"> </span><span class="l">_self</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"externalLinkTarget"</span><span class="p">:</span> <span class="s2">"_self"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="enabling-link-and-image-link-warnings">Enabling Link and Image Link Warnings</h2>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> You can use <code>link.errorlevel</code> and <code>image.errorlevel</code> to control what should happen if a local link can not be resolved to a page and/or a resource.</p>
|
|
<p>If not set or empty, any unresolved link is written as given into the resulting output. If set to <code>warning</code> the same happens and an additional warning is printed in the built console. If set to <code>error</code> an error message is printed and the build is aborted.</p>
|
|
<p>Please note that this can not resolve files inside of your <code>static</code> directory. The file must be a resource of the page or the site.</p>
|
|
<p>Link warnings are also available for the <a href="/hugo-theme-relearn/shortcodes/include/index.html#enabling-link-warnings">include</a> and <a href="/hugo-theme-relearn/shortcodes/openapi/index.html#enabling-link-warnings">openapi</a> shortcodes.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">image</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">errorlevel</span> <span class="p">=</span> <span class="s1">'warning'</span>
|
|
</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">'warning'</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">image</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">errorlevel</span><span class="p">:</span><span class="w"> </span><span class="l">warning</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">link</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">errorlevel</span><span class="p">:</span><span class="w"> </span><span class="l">warning</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"image"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"errorlevel"</span><span class="p">:</span> <span class="s2">"warning"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"link"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"errorlevel"</span><span class="p">:</span> <span class="s2">"warning"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="ignoring-false-negatives">Ignoring False Negatives</h3>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> In case you want to use link warnings but are bothered by false negatives, you can configure an ignore list of regular expressions. The referenced address will be checked against all regexes of this list. If the address matches at least one regex, no output will be written to the console. The check uses <a href="https://gohugo.io/functions/strings/findre/" rel="external" target="_self">Hugo’s <code>findRE</code> function</a>.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">errorignore</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'^/authoring/'</span><span class="p">,</span> <span class="s1">'^/configuration/'</span><span class="p">]</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">errorignore</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"></span>- <span class="l">^/authoring/</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"></span>- <span class="l">^/configuration/</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">"errorignore"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s2">"^/authoring/"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s2">"^/configuration/"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="footline">
|
|
<div class="R-taxonomy taxonomy-categories cstyle" title="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/howto/index.html">Howto</a></li>
|
|
</ul>
|
|
</div>
|
|
</footer>
|
|
</article>
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="topbar">Topbar</h1>
|
|
|
|
<p>This page is about how to configure the topbar using configuration options. If you want to add further buttons or functionality, <a href="/hugo-theme-relearn/configuration/customization/topbar/index.html">see this section</a>.</p>
|
|
<p>Your topbar contains the following elements. Some of them are configuarable:</p>
|
|
<ul>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-bars"></i></span></span> <strong>sidebar</strong>: opens the sidebar flyout if in mobile layout</li>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-list-alt"></i></span></span> <strong>toc</strong>: <a href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#table-of-contents">opens the table of contents in an overlay</a></li>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-empty"></i></span></span> <strong>breadcrumb</strong>: shows the clickable <a href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#breadcrumbs">breadcrumbs</a></li>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-pen"></i></span></span> <strong>edit</strong>: browses to the editable page if the <code>editURL</code> <a href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#edit-button">parameter is set</a></li>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-file-code"></i></span></span> <strong>source</strong>: browses to the <a href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#source-button">chapters source code</a> if <a href="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#source-support">source support</a> was activated</li>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fab fa-markdown"></i></span></span> <strong>markdown</strong>: browses to the <a href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#markdown-button">chapters Markdown source</a> if <a href="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#markdown-support">markdown support</a> was activated</li>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-print"></i></span></span> <strong>print</strong>: browses to the <a href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#print-button">chapters printable page</a> if <a href="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#print-support">print support</a> was activated</li>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-chevron-left"></i></span></span> <strong>prev</strong>: browses to the <a href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#arrow-navigation">previous page</a> if there is one</li>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-chevron-right"></i></span></span> <strong>next</strong>: browses to the <a href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#arrow-navigation">next page</a> if there is one</li>
|
|
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-ellipsis-v"></i></span></span> <strong>more</strong>: opens the overlay if screen space is limited</li>
|
|
</ul>
|
|
<h2 id="table-of-contents">Table of Contents</h2>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> Set <code>disableToc=true</code> to hide the TOC button on all pages. If the button is hidden, also the keyboard shortcut is disabled. This can be overridden in a page’s front matter.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">disableToc</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">disableToc</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"disableToc"</span><span class="p">:</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="breadcrumbs">Breadcrumbs</h2>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> Set <code>disableBreadcrumb=true</code> to hide the breadcrumb in the topbar.</p>
|
|
<p>Further breadcrumbs settings can be found in the <a href="/hugo-theme-relearn/configuration/content/titles/index.html">content configuration section</a>.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">disableBreadcrumb</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">disableBreadcrumb</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"disableBreadcrumb"</span><span class="p">:</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="edit-button">Edit Button</h2>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> If <code>editURL</code> is set to a URL, an edit button will be shown in the topbar. If the button is hidden, also the keyboard shortcut is disabled.</p>
|
|
<p>The value can contain the macro <code>${FilePath}</code> which will be replaced by the file path of your displayed page. If no <code>${FilePath}</code> is given in the value, the value is treated as if the <code>${FilePath}</code> was appended at the end of the value. This can be overridden in the pages front matter.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">editURL</span> <span class="p">=</span> <span class="s1">'https://github.com/McShelby/hugo-theme-relearn/edit/main/docs/content/${FilePath}'</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">editURL</span><span class="p">:</span><span class="w"> </span><span class="l">https://github.com/McShelby/hugo-theme-relearn/edit/main/docs/content/${FilePath}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"editURL"</span><span class="p">:</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn/edit/main/docs/content/${FilePath}"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="markdown-button">Markdown Button</h2>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> You can hide the Markdown button if the <a href="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#markdown-support">Markdown output format</a> is active by setting <code>disableMarkdownButton=true</code>.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">disableMarkdownButton</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">disableMarkdownButton</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"disableMarkdownButton"</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="source-button">Source Button</h2>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> You can hide the Source button if the <a href="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#source-support">Source output format</a> is active by setting <code>disableSourceButton=true</code>.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">disableSourceButton</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">disableSourceButton</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"disableSourceButton"</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="print-button">Print Button</h2>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> You can hide the print button if the <a href="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#print-support">print output format</a> is active by setting <code>disablePrintButton=true</code>.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">disablePrintButton</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">disablePrintButton</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"disablePrintButton"</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="arrow-navigation">Arrow Navigation</h2>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> You can hide the previous/next buttons by setting <code>disableNextPrev=true</code>. If the buttons are hidden, also the keyboard shortcuts are disabled.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">disableNextPrev</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">disableNextPrev</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"disableNextPrev"</span><span class="p">:</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="footline">
|
|
<div class="R-taxonomy taxonomy-categories cstyle" title="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/howto/index.html">Howto</a></li>
|
|
</ul>
|
|
</div>
|
|
</footer>
|
|
</article>
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="front-matter-reference">Front Matter Reference</h1>
|
|
|
|
<p>Every 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/disablemarkdownbutton/index.html">DisableMarkdownButton</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/disablenextprev/index.html">DisableNextPrev</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/disableprintbutton/index.html">DisablePrintButton</a> (1)</li>
|
|
<li><a href="/hugo-theme-relearn/frontmatter/disablesourcebutton/index.html">DisableSourceButton</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/errorignore/index.html">Errorignore</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/menupageref/index.html">MenuPageRef</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/menuurl/index.html">MenuUrl</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">disableMarkdownButton</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">disablePrintButton</span> <span class="p">=</span> <span class="kc">false</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">disableSourceButton</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">errorignore</span> <span class="p">=</span> <span class="p">[]</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">menuPageRef</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">menuUrl</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 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">disableMarkdownButton</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">disablePrintButton</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">disableSourceButton</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">errorignore</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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">menuPageRef</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">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">menuUrl</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">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">"disableMarkdownButton"</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">"disablePrintButton"</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">"disableSourceButton"</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">"errorignore"</span><span class="p">:</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">"menuPageRef"</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">"menuUrl"</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 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="0c4e3ff23f18eb846a0028770982dac1">
|
|
<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('0c4e3ff23f18eb846a0028770982dac1','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"># General</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These options are defining general, non visual behavior.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Conditionally ignore errorlevel settings</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"># The theme supports checking referenced address (e.g. with</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># link.errorlevel, image.errorlevel, etc. see below). Sometimes checks lead</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># to console output due to false negatives. You can turn off the checks</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># for individual referenced addresses by defining regular expressions here.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># The referenced address will be checked against all regexes of this array.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If it matches at least one, no output will be written to the console.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This array can be expanded globally in your site's hugo.toml.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">errorignore</span> <span class="p">=</span> <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"># 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 the Markdown 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"># This hides the Markdown button if you activated the Markdown output format.</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">disableMarkdownButton</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 Source 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"># This hides the Source button if you activated the Source output format.</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">disableSourceButton</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 Print 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"># This hides the print button if you activated the print output format.</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">disablePrintButton</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"># Link the menu entry to a different internal page instead.</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 will effectivly hide the page and its content from the viewer by</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># linking to the given URL instead.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">menuPageRef</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"># Link the menu entry to an external URL instead of 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"># This will effectivly hide the page and its content from the viewer by</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># linking to the given URL instead.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">menuUrl</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">openapi</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>
|
|
</section>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1738193499" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1738193499" defer></script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1738193499" defer></script>
|
|
</body>
|
|
</html>
|