nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 15:57:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
hugo-theme-relearn/basics/configuration/index.print.html
McShelby 1ce9960e63 deploy: 5fb02b2dd7
2024-02-12 21:32:18 +00:00

567 lines
60 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en" dir="ltr">
<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.122.0">
<meta name="generator" content="Relearn 5.23.2+tip">
<meta name="description" content="Documentation for Hugo Relearn Theme">
<meta name="author" content="Sören Weber">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png">
<meta name="twitter:title" content="Configuration :: Hugo Relearn Theme">
<meta name="twitter:description" content="Documentation for Hugo Relearn Theme">
<meta property="og:title" content="Configuration :: Hugo Relearn Theme">
<meta property="og:description" content="Documentation for Hugo Relearn Theme">
<meta property="og:type" content="website">
<meta property="og:url" content="https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html">
<meta property="og:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png">
<meta property="og:site_name" content="Hugo Relearn Theme">
<title>Configuration :: Hugo Relearn Theme</title>
<link href="https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel="alternate" hreflang="x-default">
<link href="https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel="alternate" hreflang="en">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html" rel="alternate" hreflang="art-pir">
<link href="https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel="canonical" type="text/html" title="Configuration :: Hugo Relearn Theme">
<link href="../../basics/configuration/index.xml" rel="alternate" type="application/rss+xml" title="Configuration :: Hugo Relearn Theme">
<link href="../../images/logo.svg?1707773531" rel="icon" type="image/svg+xml">
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="../../css/fontawesome-all.min.css?1707773532" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1707773532" rel="stylesheet"></noscript>
<link href="../../css/nucleus.css?1707773532" rel="stylesheet">
<link href="../../css/auto-complete.css?1707773532" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1707773532" rel="stylesheet"></noscript>
<link href="../../css/perfect-scrollbar.min.css?1707773532" rel="stylesheet">
<link href="../../css/fonts.css?1707773532" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1707773532" rel="stylesheet"></noscript>
<link href="../../css/theme.css?1707773532" rel="stylesheet">
<link href="../../css/theme-relearn-auto.css?1707773532" rel="stylesheet" id="R-variant-style">
<link href="../../css/chroma-relearn-auto.css?1707773532" rel="stylesheet" id="R-variant-chroma-style">
<link href="../../css/variant.css?1707773532" rel="stylesheet">
<link href="../../css/print.css?1707773532" rel="stylesheet" media="print">
<link href="../../css/format-print.css?1707773532" rel="stylesheet">
<link href="../../css/ie.css?1707773532" rel="stylesheet">
<script src="../../js/url.js?1707773532"></script>
<script src="../../js/variant.js?1707773532"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
window.index_js_url="../../index.search.js";
var root_url="../../";
var baseUri=root_url.replace(/\/$/, '');
window.relearn = window.relearn || {};
window.relearn.baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
// variant stuff
window.relearn.themeVariantModifier='';
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
// translations
window.T_Copy_to_clipboard = `Copy to clipboard`;
window.T_Copied_to_clipboard = `Copied to clipboard!`;
window.T_Copy_link_to_clipboard = `Copy link to clipboard`;
window.T_Link_copied_to_clipboard = `Copied link to clipboard!`;
window.T_Reset_view = `Reset view`;
window.T_View_reset = `View reset!`;
window.T_No_results_found = `No results found for "{0}"`;
window.T_N_results_found = `{1} results found for "{0}"`;
</script>
<style>
#R-body img.bg-white {
background-color: white;
}
</style>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../basics/configuration/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&#43;ALT&#43;n)"><i class="fa-fw fas fa-bars"></i></button>
</div>
</div>
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../basics/index.html"><span itemprop="name">Basics</span></a><meta itemprop="position" content="1">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Configuration</span><meta itemprop="position" content="2"></li>
</ol>
<div class="topbar-area topbar-area-end" data-area="end">
</div>
</div>
</nav>
<div id="R-main-overlay"></div>
<main id="R-body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<article class="default">
<header class="headline">
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
<ul>
<li><a class="term-link" href="../../tags/config/index.html">config</a></li>
</ul>
</div>
</header>
<h1 id="configuration">Configuration</h1>
<p>On top of <a href="https://gohugo.io/overview/configuration/" target="_blank">Hugo&rsquo;s global configuration options</a>, the Relearn theme lets you define further options unique to the theme in your <code>hugo.toml</code>. The defaults are written in the comments of each option.</p>
<p>Note that some of these options are explained in detail in other sections of this documentation.</p>
<div class="tab-panel" data-tab-group="0560e99f031f8e4080b0439717f411d4">
<div class="tab-nav">
<div class="tab-nav-title">&#8203;</div>
<button
data-tab-item="hugotoml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('0560e99f031f8e4080b0439717f411d4','hugotoml')"
>
<span class="tab-nav-text">hugo.toml</span>
</button>
</div>
<div class="tab-content-container">
<div
data-tab-item="hugotoml"
class="tab-content tab-panel-style cstyle initial active">
<div class="tab-content-text">
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">params</span><span class="p">]</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 given 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 aswell.</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># The author of your site.</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 be used in HTML meta tags, the opengraph protocol and twitter</span>
</span></span><span class="line"><span class="cl"><span class="c"># cards.</span>
</span></span><span class="line"><span class="cl"><span class="c"># You can also set `author.email` if you want to publish this information.</span>
</span></span><span class="line"><span class="cl"><span class="nx">author</span><span class="p">.</span><span class="nx">name</span> <span class="p">=</span> <span class="s2">&#34;Sören Weber&#34;</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 site.</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"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">images</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">&#34;images/hero.png&#34;</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 description of your site.</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"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">description</span> <span class="p">=</span> <span class="s2">&#34;Documentation for Hugo Relearn Theme&#34;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Admin options for social media.</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"># Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo&#39;s</span>
</span></span><span class="line"><span class="cl"><span class="c"># implementation. See the Hugo docs for possible values.</span>
</span></span><span class="line"><span class="cl"><span class="nx">social</span><span class="p">.</span><span class="nx">facebook_admin</span> <span class="p">=</span> <span class="s2">&#34;&#34;</span>
</span></span><span class="line"><span class="cl"><span class="nx">social</span><span class="p">.</span><span class="nx">twitter</span> <span class="p">=</span> <span class="s2">&#34;&#34;</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"># Branding</span>
</span></span><span class="line"><span class="cl"><span class="c"># These options set your overall visual apperance.</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Used color variants.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: &#34;auto&#34;</span>
</span></span><span class="line"><span class="cl"><span class="c"># This sets one or more color variants, available to your readers to choose</span>
</span></span><span class="line"><span class="cl"><span class="c"># from. You can</span>
</span></span><span class="line"><span class="cl"><span class="c"># - set a single value eg. &#34;zen-light&#34;</span>
</span></span><span class="line"><span class="cl"><span class="c"># - an array like [ &#34;neon&#34;, &#34;learn&#34; ]</span>
</span></span><span class="line"><span class="cl"><span class="c"># - an array with options like [ { identifier = &#34;neon&#34; },{ identifier = &#34;learn&#34; } ]</span>
</span></span><span class="line"><span class="cl"><span class="c"># The last form allows to set further options for each variant.</span>
</span></span><span class="line"><span class="cl"><span class="c"># The `identifier` is mandatory. You can also set `name` which overrides the</span>
</span></span><span class="line"><span class="cl"><span class="c"># value displayed in the variant selector.</span>
</span></span><span class="line"><span class="cl"><span class="c"># If the array has more than one entry, a variant selector</span>
</span></span><span class="line"><span class="cl"><span class="c"># is shown in the lower part of the menu. The first entry in the array is the</span>
</span></span><span class="line"><span class="cl"><span class="c"># default variant, used for first time visitors.</span>
</span></span><span class="line"><span class="cl"><span class="c"># The theme ships with the following variants: &#34;relearn-bright&#34;,</span>
</span></span><span class="line"><span class="cl"><span class="c"># &#34;relearn-light&#34;, &#34;relearn-dark&#34;, &#34;zen-light&#34;, &#34;zen-dark&#34;, &#34;neon&#34;, &#34;learn&#34;,</span>
</span></span><span class="line"><span class="cl"><span class="c"># &#34;blue&#34;, &#34;green&#34;, &#34;red&#34;. In addition you can use auto mode variants. See the</span>
</span></span><span class="line"><span class="cl"><span class="c"># docs for a detailed explaination.</span>
</span></span><span class="line"><span class="cl"><span class="c"># You can also define your own variants. See the docs how this works. Also,</span>
</span></span><span class="line"><span class="cl"><span class="c"># the docs provide an interactive theme generator to help you with this task.</span>
</span></span><span class="line"><span class="cl"><span class="nx">themeVariant</span> <span class="p">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;relearn-auto&#34;</span><span class="p">,</span> <span class="nx">name</span> <span class="p">=</span> <span class="s2">&#34;Relearn Light/Dark&#34;</span><span class="p">,</span> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[]</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;relearn-light&#34;</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;relearn-dark&#34;</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;relearn-bright&#34;</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;zen-auto&#34;</span><span class="p">,</span> <span class="nx">name</span> <span class="p">=</span> <span class="s2">&#34;Zen Light/Dark&#34;</span><span class="p">,</span> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">&#34;zen-light&#34;</span><span class="p">,</span> <span class="s2">&#34;zen-dark&#34;</span> <span class="p">]</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;zen-light&#34;</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;zen-dark&#34;</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;neon&#34;</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;learn&#34;</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;blue&#34;</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;green&#34;</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">&#34;red&#34;</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"># Filename suffix for variant files.</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 theme modifies the variant stylesheets during build and tries to store</span>
</span></span><span class="line"><span class="cl"><span class="c"># them with the same file name. In certain installations it was observed, that</span>
</span></span><span class="line"><span class="cl"><span class="c"># Hugo could not overwrite these files due to permission issues. If you</span>
</span></span><span class="line"><span class="cl"><span class="c"># experience this, you can first try to set the `--noChmod` option for Hugo.</span>
</span></span><span class="line"><span class="cl"><span class="c"># If this still doesn&#39;t help you can set this option to eg. &#34;.gen&#34;. This will</span>
</span></span><span class="line"><span class="cl"><span class="c"># be used as a suffix for these generated files, causing them to be newly</span>
</span></span><span class="line"><span class="cl"><span class="c"># created instead of overwriting the existing ones.</span>
</span></span><span class="line"><span class="cl"><span class="nx">themeVariantModifier</span> <span class="p">=</span> <span class="s2">&#34;&#34;</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"># Avoid new asset URLs on build.</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"># By default JavaScript-files and CSS-files get a unique ID on each rebuild.</span>
</span></span><span class="line"><span class="cl"><span class="c"># This makes sure, the user always has the latest version and not some stale</span>
</span></span><span class="line"><span class="cl"><span class="c"># copy of his browser cache. Anyways, it can be desireable to turn this</span>
</span></span><span class="line"><span class="cl"><span class="c"># off in certain circumstances. For example if you have Hugo&#39;s dev server</span>
</span></span><span class="line"><span class="cl"><span class="c"># running. Also some proxies dislike this optimization.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableAssetsBusting</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"># Avoid generator meta tags.</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"># Set this to true if you want to disable generation for generator meta tags</span>
</span></span><span class="line"><span class="cl"><span class="c"># of Hugo and the theme in your HTML head. In tihs case also don&#39;t forget to</span>
</span></span><span class="line"><span class="cl"><span class="c"># set Hugo&#39;s disableHugoGeneratorInject=true. Otherwise Hugo will generate a</span>
</span></span><span class="line"><span class="cl"><span class="c"># meta tag into your home page anyways.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableGeneratorVersion</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"># Avoid unique IDs.</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"># In various situations the theme generates non stable unique ids to be used</span>
</span></span><span class="line"><span class="cl"><span class="c"># in HTML fragment links. This can be undesirable for example when testing</span>
</span></span><span class="line"><span class="cl"><span class="c"># the output for changes. If you disable the random id generation, the theme</span>
</span></span><span class="line"><span class="cl"><span class="c"># may not function correctly anymore.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableRandomIds</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"># Multilanguage content.</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 your pages contain further languages besides the main one used, add all</span>
</span></span><span class="line"><span class="cl"><span class="c"># those auxiliary languages here. This will create a search index with</span>
</span></span><span class="line"><span class="cl"><span class="c"># support for all used languages of your site.</span>
</span></span><span class="line"><span class="cl"><span class="c"># This is handy for example if you are writing in Spanish but have lots of</span>
</span></span><span class="line"><span class="cl"><span class="c"># source code on your page which typically uses English terminology.</span>
</span></span><span class="line"><span class="cl"><span class="nx">additionalContentLanguage</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">&#34;en&#34;</span> <span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Additional code dependencies.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: See hugo.toml of the theme</span>
</span></span><span class="line"><span class="cl"><span class="c"># The theme provides a mechanism to load further JavaScript and CSS</span>
</span></span><span class="line"><span class="cl"><span class="c"># dependencies on demand only if they are needed. This comes in handy if you</span>
</span></span><span class="line"><span class="cl"><span class="c"># want to add own shortcodes that depend on additional code to be loaded.</span>
</span></span><span class="line"><span class="cl"><span class="c"># See the docs how this works.</span>
</span></span><span class="line"><span class="cl"><span class="c"># [relearn.dependencies]</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"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableToc</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Hide the breadcrumbs.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
</span></span><span class="line"><span class="cl"><span class="c"># If the breadcrumbs are hidden, the title of the displayed page will still be</span>
</span></span><span class="line"><span class="cl"><span class="c"># shown in the topbar.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableBreadcrumb</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Hide Next and Previous navigation buttons.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
</span></span><span class="line"><span class="cl"><span class="c"># If the navigation buttons are hidden, also the keyboard shortcuts are</span>
</span></span><span class="line"><span class="cl"><span class="c"># disabled.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableNextPrev</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># The URL prefix to edit a page.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
</span></span><span class="line"><span class="cl"><span class="c"># If set, an edit button will be shown in the topbar. If the button is hidden,</span>
</span></span><span class="line"><span class="cl"><span class="c"># also the keyboard shortcuts are disabled. The value can contain the macro</span>
</span></span><span class="line"><span class="cl"><span class="c"># `${FilePath}` which will be replaced by the file path of your displayed page.</span>
</span></span><span class="line"><span class="cl"><span class="c"># If no `${FilePath}` is given in the value, the value is treated as if the</span>
</span></span><span class="line"><span class="cl"><span class="c"># `${FilePath}` was appended at the end of the value. This can be overridden</span>
</span></span><span class="line"><span class="cl"><span class="c"># in the pages frontmatter. This is useful if you want to give the opportunity</span>
</span></span><span class="line"><span class="cl"><span class="c"># for people to create merge request for your content.</span>
</span></span><span class="line"><span class="cl"><span class="nx">editURL</span> <span class="p">=</span> <span class="s2">&#34;https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}&#34;</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 apperance.</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Hide the search box.</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 searc box is sisabled, the search functionality is disabled too.</span>
</span></span><span class="line"><span class="cl"><span class="c"># This will also cause the keyboard shortcut to be disabled and the dedicated</span>
</span></span><span class="line"><span class="cl"><span class="c"># search page is not linked although it mighty be configured.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableSearch</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 Home 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 shown, a Home button will appear below the search bar and the main menu.</span>
</span></span><span class="line"><span class="cl"><span class="c"># It links to your the home page of the current language.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableLandingPageButton</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"># The order of main menu submenus.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: &#34;weight&#34;</span>
</span></span><span class="line"><span class="cl"><span class="c"># Submenus can be ordered by &#34;weight&#34;, &#34;title&#34;, &#34;linktitle&#34;, &#34;modifieddate&#34;,</span>
</span></span><span class="line"><span class="cl"><span class="c"># &#34;expirydate&#34;, &#34;publishdate&#34;, &#34;date&#34;, &#34;length&#34; or &#34;default&#34; (adhering to</span>
</span></span><span class="line"><span class="cl"><span class="c"># Hugo&#39;s default sort order). This can be overridden in the pages frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">ordersectionsby</span> <span class="p">=</span> <span class="s2">&#34;weight&#34;</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. This can be overridden in the page&#39;s frontmatter.</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="s2">&#34;&#34;</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"># This can be overridden in the page&#39;s frontmatter.</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"># Shows checkmarks for visited pages of the main menu.</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 also causes the display of the `Clear History` entry in the lower part</span>
</span></span><span class="line"><span class="cl"><span class="c"># of the menu to remove all checkmarks. The checkmarks will also been removed</span>
</span></span><span class="line"><span class="cl"><span class="c"># if you regenerate your site as the ids are not stable.</span>
</span></span><span class="line"><span class="cl"><span class="nx">showVisitedLinks</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"># Hide heading above the shortcut menu.</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"># The title for the heading can be overwritten in your i18n files. See Hugo&#39;s</span>
</span></span><span class="line"><span class="cl"><span class="c"># documentation how to do this.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableShortcutsTitle</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 language switcher.</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 you have more than one language configured, a language switcher is</span>
</span></span><span class="line"><span class="cl"><span class="c"># displayed in the lower part of the menu. This opition lets you explicitly</span>
</span></span><span class="line"><span class="cl"><span class="c"># turn this behavior off.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableLanguageSwitchingButton</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"># 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 main 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&#39;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 hidden pages from search.</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"># Hides hidden pages from the suggestions of the search box and the dedicated</span>
</span></span><span class="line"><span class="cl"><span class="c"># search page.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableSearchHiddenPages</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 hidden pages for web crawlers.</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"># Avoids hidden pages from showing up in the sitemap and on Google (et all),</span>
</span></span><span class="line"><span class="cl"><span class="c"># otherwise they may be indexed by search engines</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableSeoHiddenPages</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"># Hide hidden pages for taxonomies.</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"># Hides hidden pages from showing up on the taxonomy and terms pages. If this</span>
</span></span><span class="line"><span class="cl"><span class="c"># reduces term counters to zero, an empty but not linked term page will be</span>
</span></span><span class="line"><span class="cl"><span class="c"># created anyhow.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableTagHiddenPages</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"># Title separator.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: &#34;::&#34;</span>
</span></span><span class="line"><span class="cl"><span class="c"># Changes the title separator used when concatenating the page title with the</span>
</span></span><span class="line"><span class="cl"><span class="c"># site title. This is consistently used throughout the theme.</span>
</span></span><span class="line"><span class="cl"><span class="nx">titleSeparator</span> <span class="p">=</span> <span class="s2">&#34;::&#34;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Breadcrumb separator.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: &#34;&gt;&#34;</span>
</span></span><span class="line"><span class="cl"><span class="c"># Changes the breadcrumb separator used in the topbars breadcrumb area and for</span>
</span></span><span class="line"><span class="cl"><span class="c"># search results and term pages.</span>
</span></span><span class="line"><span class="cl"><span class="nx">breadcrumbSeparator</span> <span class="p">=</span> <span class="s2">&#34;&gt;&#34;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Hide the root breadcrumb.</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"># The root breadcrumb is usually the home page of your site. Because this is</span>
</span></span><span class="line"><span class="cl"><span class="c"># always accessible by clicking on the logo, you may want to reduce clutter</span>
</span></span><span class="line"><span class="cl"><span class="c"># by removing this from your breadcrumb.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableRootBreadcrumb</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"># Hide breadcrumbs term pages.</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 you have lots of taxonomy terms, the term pages may seem cluttered with</span>
</span></span><span class="line"><span class="cl"><span class="c"># breadcrumbs to you, so this is the option to turn off breadcrumbs on term</span>
</span></span><span class="line"><span class="cl"><span class="c"># pages. Only the page title will then be shown on the term pages.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableTermBreadcrumbs</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"># 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"># Hide copy-to-clipboard for inline code.</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 removes the copy-to-clipboard button from your inline code.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableInlineCopyToClipBoard</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"># Always show copy-to-clipboard for block code.</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"># The theme only shows the copy-to-clipboard button if you hover over the code</span>
</span></span><span class="line"><span class="cl"><span class="c"># block. Set this to true to disable the hover effect and always show the</span>
</span></span><span class="line"><span class="cl"><span class="c"># button.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableHoverBlockCopyToClipBoard</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"># 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"># This can be overridden in the page&#39;s frontmatter or given as a parameter to</span>
</span></span><span class="line"><span class="cl"><span class="c"># individual code blocks.</span>
</span></span><span class="line"><span class="cl"><span class="nx">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
</span></span><span class="line"><span class="cl"><span class="c"># Images</span>
</span></span><span class="line"><span class="cl"><span class="c"># These 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"># 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 effects can be overridden in the page&#39;s frontmatter or thru URL parameter</span>
</span></span><span class="line"><span class="cl"><span class="c"># given to the image. See the documentation for details.</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
</span></span><span class="line"><span class="cl"><span class="c"># 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"># How to open external links.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: &#34;_blank&#34;</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 &#34;_self&#34;.</span>
</span></span><span class="line"><span class="cl"><span class="nx">externalLinkTarget</span> <span class="p">=</span> <span class="s2">&#34;_blank&#34;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Generate link URLs the Hugo way.</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, the theme behaves like a standard Hugo installation and</span>
</span></span><span class="line"><span class="cl"><span class="c"># appends no index.html to prettyURLs. As a trade off, your build project will</span>
</span></span><span class="line"><span class="cl"><span class="c"># not be servable from the file system.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableExplicitIndexURLs</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
</span></span><span class="line"><span class="cl"><span class="c"># MathJax</span>
</span></span><span class="line"><span class="cl"><span class="c"># These 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"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">&#34;{}&#34;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Only load MathJax if needed.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
</span></span><span class="line"><span class="cl"><span class="c"># If a Math shortcode is found, the option will be ignored and</span>
</span></span><span class="line"><span class="cl"><span class="c"># MathJax will be loaded regardlessly. The option is still useful in case you</span>
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to set up 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. In this case</span>
</span></span><span class="line"><span class="cl"><span class="c"># you can set `disableMathJax=false` in your frontmatter to force the library to</span>
</span></span><span class="line"><span class="cl"><span class="c"># be loaded.</span>
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableMathJax</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># URL 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"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">customMathJaxURL</span> <span class="p">=</span> <span class="s2">&#34;&#34;</span> <span class="c"># &#34;https://unpkg.com/mathjax/es5/tex-mml-chtml.js&#34;</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"># This can be overridden in the page&#39;s frontmatter or given as a parameter to</span>
</span></span><span class="line"><span class="cl"><span class="c"># 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"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s2">&#34;{ \&#34;securityLevel\&#34;: \&#34;loose\&#34; }&#34;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># Only load Mermaid if needed.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
</span></span><span class="line"><span class="cl"><span class="c"># If a 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. The option is still useful in case you</span>
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to set up 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. In this case</span>
</span></span><span class="line"><span class="cl"><span class="c"># you can set `disableMermaid=false` in your frontmatter to force the library to</span>
</span></span><span class="line"><span class="cl"><span class="c"># be loaded.</span>
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableMermaid</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># URL 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"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s2">&#34;&#34;</span> <span class="c"># &#34;https://unpkg.com/mermaid/dist/mermaid.min.js&#34;</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"># Only load OpenAPI if needed.</span>
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
</span></span><span class="line"><span class="cl"><span class="c"># If a OpenAPI shortcode 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. The option is still useful in case you</span>
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to set up 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. In this case</span>
</span></span><span class="line"><span class="cl"><span class="c"># you can set `disableOpenapi=false` in your frontmatter to force the library to</span>
</span></span><span class="line"><span class="cl"><span class="c"># be loaded.</span>
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">disableOpenapi</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c"># URL 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"># This can be overridden in the page&#39;s frontmatter.</span>
</span></span><span class="line"><span class="cl"><span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s2">&#34;&#34;</span> <span class="c"># &#34;https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js&#34;</span></span></span></code></pre></div></div>
</div>
</div>
</div>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<script src="../../js/clipboard.min.js?1707773532" defer></script>
<script src="../../js/perfect-scrollbar.min.js?1707773532" defer></script>
<script src="../../js/theme.js?1707773532" defer></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink