mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 17:53:07 +00:00
938 lines
114 KiB
HTML
938 lines
114 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="art-pir" dir="rtl">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
<meta name="generator" content="Hugo 0.125.1">
|
|
<meta name="generator" content="Relearn 5.27.0+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="Configurrrat'n :: Cap'n Hugo Relearrrn Theme">
|
|
<meta name="twitter:description" content="Documentation for Hugo Relearn Theme">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html">
|
|
<meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:title" content="Configurrrat'n :: Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:description" content="On top o' Hugo&rsquo;s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo.toml.
|
|
Avast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n.
|
|
All config opt'ns Th' values reflect th' opt'ns active 'n this documentat'n. Th' defaults can be taken from th' annotated example below.
|
|
hugo. toml yaml json [params] additionalContentLanguage = [&#39;en&#39;] alwaysopen = &#39;&#39; breadcrumbSeparator = &#39;&gt;&#39; collapsibleMenu = true customMathJaxURL = &#39;&#39; customMermaidURL = &#39;&#39; customOpenapiURL = &#39;&#39; descript'n = &#39;Documentat'n fer Cap'n Hugo Relearrrn Theme&#39; disableAssetsBust'n = false disableBreadcrumb = false disableExplicitIndexURLs = false disableGeneratorVersion = false disableHoverBlockCopyToClipBoard = false disableInlineCopyToClipBoard = true disableLandingPageButton = true disableLanguageSwitchingButton = false disableMathJax = true disableMermaid = true disableNextPrev = false disableOpenapi = true disableRandomIds = false disableRootBreadcrumb = true disableSearch = false disableSearchHiddenPages = false disableSeoHiddenPages = true disableShortcutsTitle = false disableTagHiddenPages = false disableTermBreadcrumbs = false disableToc = false editURL = &#39;https://github.">
|
|
<meta property="og:locale" content="art-pir">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<title>Configurrrat'n :: Cap'n Hugo Relearrrn 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/pir/basics/configuration/index.html" rel="canonical" type="text/html" title="Configurrrat'n :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/pir/basics/configuration/index.xml" rel="alternate" type="application/rss+xml" title="Configurrrat'n :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1713508690" rel="icon" type="image/svg+xml">
|
|
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1713508693" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1713508693" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1713508693" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1713508693" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1713508693" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1713508693" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1713508693" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1713508693" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1713508693" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1713508693" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1713508693" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/variant.css?1713508693" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/print.css?1713508693" rel="stylesheet" media="print">
|
|
<link href="/hugo-theme-relearn/css/format-print.css?1713508693" rel="stylesheet">
|
|
<script src="/hugo-theme-relearn/js/variant.js?1713508693"></script>
|
|
<script>
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.relBasePath='..\/..\/..';
|
|
window.relearn.relBaseUri='..\/..\/..\/..';
|
|
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
|
window.index_js_url="/hugo-theme-relearn/pir/index.search.js";
|
|
// variant stuff
|
|
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] );
|
|
// translations
|
|
window.T_Copy_to_clipboard = `Copy t' clipboard`;
|
|
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
|
|
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
|
|
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
|
|
window.T_Reset_view = `Rrreset view`;
|
|
window.T_View_reset = `View rrreset!`;
|
|
window.T_No_results_found = `No rrresults found fer "{0}"`;
|
|
window.T_N_results_found = `{1} rrresults found fer "{0}"`;
|
|
</script>
|
|
<style>
|
|
#R-body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/pir/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+ALT+n)"><i class="fa-fw fas fa-bars"></i></button>
|
|
</div>
|
|
</div>
|
|
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/pir/basics/index.html"><span itemprop="name">Basics</span></a><meta itemprop="position" content="1"> > </li><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Configurrrat'n</span><meta itemprop="position" content="2"></li>
|
|
</ol>
|
|
<div class="topbar-area topbar-area-end" data-area="end">
|
|
<div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/basics/installation/index.html" title="Installat'n (🡒)"><i class="fa-fw fas fa-chevron-left"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/basics/branding/index.html" title="Brrrand'n (🡐)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
|
</div>
|
|
</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="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
|
<ul>
|
|
<li><a class="term-link" href="/hugo-theme-relearn/pir/tags/config/index.html">Config</a></li>
|
|
</ul>
|
|
</div>
|
|
</header>
|
|
|
|
<h1 id="configurrratn">Configurrrat'n</h1>
|
|
|
|
|
|
<p>On top o' <a href="https://gohugo.io/overview/configuration/" rel="external" target="_blank">Hugo’s global configurat'n opt'ns</a>, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer <code>hugo.toml</code>.</p>
|
|
<p>Avast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n.</p>
|
|
<h2 id="all-config-options">All config opt'ns</h2>
|
|
<p>Th' values reflect th' opt'ns active 'n this documentat'n. Th' defaults can be taken from th' <a href="/hugo-theme-relearn/pir/basics/configuration/index.html#annotated-config-options">annotated example</a> below.</p>
|
|
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">hugo.</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">params</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">additionalContentLanguage</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'en'</span><span class="p">]</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">breadcrumbSeparator</span> <span class="p">=</span> <span class="s1">'>'</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">customMathJaxURL</span> <span class="p">=</span> <span class="s1">''</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s1">''</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s1">''</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">descript'n</span> <span class="p">=</span> <span class="s1">'Documentat'n fer Cap'n Hugo Relearrrn Theme'</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">disableAssetsBust'n</span> <span class="p">=</span> <span class="kc">false</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">disableExplicitIndexURLs</span> <span class="p">=</span> <span class="kc">false</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 class="nx">disableHoverBlockCopyToClipBoard</span> <span class="p">=</span> <span class="kc">false</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 class="nx">disableLandingPageButton</span> <span class="p">=</span> <span class="kc">true</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 class="nx">disableMathJax</span> <span class="p">=</span> <span class="kc">true</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 class="nx">disableNextPrev</span> <span class="p">=</span> <span class="kc">false</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 class="nx">disableRandomIds</span> <span class="p">=</span> <span class="kc">false</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 class="nx">disableSearch</span> <span class="p">=</span> <span class="kc">false</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 class="nx">disableSeoHiddenPages</span> <span class="p">=</span> <span class="kc">true</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 class="nx">disableTagHiddenPages</span> <span class="p">=</span> <span class="kc">false</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 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">'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}'</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">externalLinkTarget</span> <span class="p">=</span> <span class="s1">'_blank'</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">mathJaxInitialize</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">showVisitedLinks</span> <span class="p">=</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">titleSeparator</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">params</span><span class="p">.</span><span class="nx">author</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Sören Weber'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><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">params</span><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">params</span><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><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">social</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">facebook_admin</span> <span class="p">=</span> <span class="s1">''</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">twitter</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">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-auto'</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Relearn Light/Dark'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-light'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-dark'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-bright'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'zen-light'</span><span class="p">,</span> <span class="s1">'zen-dark'</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'zen-auto'</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Zen Light/Dark'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'zen-light'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'zen-dark'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'learn'</span><span class="p">,</span> <span class="s1">'neon'</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'retro-auto'</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Retro Learn/Neon'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'neon'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'learn'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'blue'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'green'</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'red'</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">params</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">additionalContentLanguage</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">en</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">author</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Sören Weber</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">breadcrumbSeparator</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">collapsibleMenu</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">customMathJaxURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">customMermaidURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">customOpenapiURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">descript'n</span><span class="p">:</span><span class="w"> </span><span class="l">Documentat'n fer Cap'n Hugo Relearrrn Theme</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableAssetsBust'n</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">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">disableExplicitIndexURLs</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">disableGeneratorVersion</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">disableHoverBlockCopyToClipBoard</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">disableInlineCopyToClipBoard</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">disableLandingPageButton</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">disableLanguageSwitchingButton</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">disableMathJax</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">disableMermaid</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">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">disableOpenapi</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">disableRandomIds</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">disableRootBreadcrumb</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">disableSearch</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">disableSearchHiddenPages</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">disableSeoHiddenPages</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">disableShortcutsTitle</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">disableTagHiddenPages</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">disableTermBreadcrumbs</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="l">https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}</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">_blank</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="l">warning</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">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 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">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">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">showVisitedLinks</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">social</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">facebook_admin</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">twitter</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">themeVariant</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">auto</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">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-auto</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Relearrrn Light/Dark</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">relearn-light</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">relearn-dark</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">relearn-bright</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">auto</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">zen-light</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">zen-dark</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">zen-auto</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Zen Light/Dark</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">zen-light</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">zen-dark</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">auto</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">learn</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">neon</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">retro-auto</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Retro Learn/Neon</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">neon</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">learn</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">blue</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">green</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">red</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">titleSeparator</span><span class="p">:</span><span class="w"> </span><span class="s1">'::'</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"additionalContentLanguage"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s2">"en"</span>
|
|
</span></span><span class="line"><span class="cl"> <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">"author"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Sören Weber"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"breadcrumbSeparator"</span><span class="p">:</span> <span class="s2">"\u003e"</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">"Documentat'n fer Cap'n Hugo Relearrrn Theme"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"disableAssetsBusting"</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">"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">"disableExplicitIndexURLs"</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">"disableGeneratorVersion"</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">"disableHoverBlockCopyToClipBoard"</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">"disableInlineCopyToClipBoard"</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">"disableLandingPageButton"</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">"disableLanguageSwitchingButton"</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">"disableMathJax"</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">"disableMermaid"</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">"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">"disableOpenapi"</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">"disableRandomIds"</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">"disableRootBreadcrumb"</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">"disableSearch"</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">"disableSearchHiddenPages"</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">"disableSeoHiddenPages"</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">"disableShortcutsTitle"</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">"disableTagHiddenPages"</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">"disableTermBreadcrumbs"</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">"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}"</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">"_blank"</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">"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">"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">"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="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">"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">"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">"showVisitedLinks"</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">"social"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"facebook_admin"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"twitter"</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">"themeVariant"</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">"auto"</span><span class="p">:</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">"relearn-auto"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Relearn Light/Dark"</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">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-light"</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">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-dark"</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">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-bright"</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">"auto"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s2">"zen-light"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s2">"zen-dark"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"identifier"</span><span class="p">:</span> <span class="s2">"zen-auto"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Zen Light/Dark"</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">"identifier"</span><span class="p">:</span> <span class="s2">"zen-light"</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">"identifier"</span><span class="p">:</span> <span class="s2">"zen-dark"</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">"auto"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s2">"learn"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s2">"neon"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"identifier"</span><span class="p">:</span> <span class="s2">"retro-auto"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Retro Learn/Neon"</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">"identifier"</span><span class="p">:</span> <span class="s2">"neon"</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">"identifier"</span><span class="p">:</span> <span class="s2">"learn"</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">"identifier"</span><span class="p">:</span> <span class="s2">"blue"</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">"identifier"</span><span class="p">:</span> <span class="s2">"green"</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">"identifier"</span><span class="p">:</span> <span class="s2">"red"</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">"titleSeparator"</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="p">}</span></span></span></code></pre></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="annotated-config-options">Annotated config opt'ns</h2>
|
|
|
|
<div class="tab-panel" data-tab-group="c01c2b7ce6e427e2894d499eb630d2c1">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="hugotoml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('c01c2b7ce6e427e2894d499eb630d2c1','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="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">params</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If an opt'n value be said t' be not set, ye can achieve th' same behavior</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># by giv'n it an empty str'n value.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c">###############################################################################</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Cap'n Hugo</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns usually apply t' other themes as well.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Th' author o' yer ship.</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 'n HTML meta tags, th' opengraph protocol an' 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"># Ye can also set `author.email` if ye want t' publish this informat'n.</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">"Sören Weber"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Th' social media image o' yer ship.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This be used fer generat'n social media meta informat'n fer th' opengraph</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># protocol an' twitter cards.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page'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">"images/hero.png"</span> <span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Th' descript'n o' yer ship.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This be used fer generat'n HTML meta tags, social media meta informat'n</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># fer th' opengraph protocol an' twitter cards.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">descript'n</span> <span class="p">=</span> <span class="s2">"Documentat'n fer Cap'n Hugo Relearrrn Theme"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Admin opt'ns fer 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"># Configurat'n fer th' Open Graph protocol an' Twitter Cards adhere t' Hugo's</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># implementat'n. See th' Cap'n Hugo docs fer poss'ble 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">""</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">""</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c">###############################################################################</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Relearrrn Theme</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns be specific t' th' Relearrrn theme.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Brand'n</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns set yer overall visual appearance.</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: "auto"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This sets one or more color variants, avail'ble t' yer readers t' choose</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># from. Ye can</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># - set a single value eg. "zen-light"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># - an array like [ "neon", "learn" ]</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># - an array wit' opt'ns like [ { identifier = "neon" },{ identifier = "learn" } ]</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Th' last form allows t' set further opt'ns fer each variant.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Th' `identifier` be mandatory. Ye can also set `name` which overrides th'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># value displayed 'n th' variant selector.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If th' array has more than one entry, a variant selector</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># default variant, used fer first time visitors.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Th' theme ships wit' th' follow'n variants: "relearn-bright",</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># "relearn-light", "relearn-dark", "zen-light", "zen-dark", "neon", "learn",</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># "blue", "green", "red". In addit'n ye can use auto mode variants. See th'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># docs fer a detailed explanat'n.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Ye can also define yer own variants. See th' docs how this works. Also,</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># th' docs provide an interactive theme generator t' help ye wit' 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">"relearn-auto"</span><span class="p">,</span> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"Relearn Light/Dark"</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">"relearn-light"</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">"relearn-dark"</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">"relearn-bright"</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">"zen-auto"</span><span class="p">,</span> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"Zen Light/Dark"</span><span class="p">,</span> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"zen-light"</span><span class="p">,</span> <span class="s2">"zen-dark"</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">"zen-light"</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">"zen-dark"</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">"retro-auto"</span><span class="p">,</span> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"Retro Learn/Neon"</span><span class="p">,</span> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"learn"</span><span class="p">,</span> <span class="s2">"neon"</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">"neon"</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">"learn"</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">"blue"</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">"green"</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">"red"</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"># General</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns be defin'n 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 an' CSS-files get a unique ID on each rebuild.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This makes sure, th' user always has th' latest version an' not some stale</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># copy o' his browser cache. Anyways, it can be desire'ble t' turn this</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># off 'n certain circumstances. For example if ye have Hugo's dev server</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># runn'n. Also some proxies dislike this optimizat'n.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">disableAssetsBust'n</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 t' true if ye want t' dis'ble generat'n fer generator meta tags</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># o' Cap'n Hugo an' th' theme 'n yer HTML head. In this case also don't forget t'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># set Hugo's disableHugoGeneratorInject=true. Otherwise Cap'n Hugo will generate a</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># meta tag into yer home plank 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 situat'ns th' theme generates non st'ble unique ids t' be used</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># 'n HTML fragment links. This can be undesir'ble fer example when test'n</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># th' output fer changes. If ye dis'ble th' random id generat'n, th' theme</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># may not funct'n 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 rrrambl'n.</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 yer planks contain further languages besides th' 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 wit'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># support fer all used languages o' yer ship.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This be handy fer example if ye be writ'n 'n Spanish but have lots o'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># source code on yer plank 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">"en"</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 o' th' theme</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Th' theme provides a mechanism t' board further JavaScript an' CSS</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># dependencies on demand only if they be needed. This comes 'n handy if ye</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># want t' add own shorrrtcodes that depend on additional code t' be boarded.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># See th' 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 opt'ns modify th' topbar appearance.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Hide th' t'ble o' contents button.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If th' TOC button be hidden, also th' keyboard shortcut be disabled.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page'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 th' breadcrumbs.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># shown 'n th' topbar.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">disableBreadcrumb</span> <span class="p">=</span> <span class="kc">false</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Hide Next an' Previous navigat'n buttons.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If th' navigat'n buttons be hidden, also th' keyboard shortcuts be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># disabled.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">disableNextPrev</span> <span class="p">=</span> <span class="kc">false</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Th' URL prefix t' edit a plank.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If set, an edit button will be shown 'n th' topbar. If th' button be hidden,</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># also th' keyboard shortcuts be disabled. Th' value can contain th' macro</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># `${FilePath}` which will be replaced by th' file path o' yer displayed plank.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If no `${FilePath}` be given 'n th' value, th' value be treated as if th'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># `${FilePath}` was appended at th' end o' th' value. This can be overridden</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># 'n th' planks frontmatter. This be useful if ye want t' give th' opportunity</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># fer people t' create merge request fer yer rrrambl'n.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">editURL</span> <span class="p">=</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Menu</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns modify th' menu appearance.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Hide th' 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 th' search box be disabled, th' search functionality be disabled too.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This will also cause th' keyboard shortcut t' be disabled an' th' dedicated</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># search plank be 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 th' 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 th' search bar an' th' main menu.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># It links t' yer th' home plank o' th' 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"># Th' order o' main menu submenus.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: "weight"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># "expirydate", "publishdate", "date", "length" or "default" (adher'n t'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Hugo's default sort order). This can be overridden 'n th' planks frontmatter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">ordersectionsby</span> <span class="p">=</span> <span class="s2">"weight"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Th' initial expand state o' submenus.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This controls whether submenus will be expanded (true), or collapsed (false)</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># 'n th' menu. If not set, th' first menu level be set t' false, all others</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># levels be set t' true. This can be overridden 'n th' page's frontmatter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If th' displayed plank has submenus, they will always been displayed expanded</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># regardless o' this opt'n.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">alwaysopen</span> <span class="p">=</span> <span class="s2">""</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Shows expander fer submenus.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># tree view an' a click'ble expander be set 'n front o' th' entry.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page'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 fer visited planks o' th' 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 th' display o' th' `Clear History` entry 'n th' lower part</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># o' th' menu t' remove all checkmarks. Th' checkmarks will also been removed</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># if ye regenerate yer ship as th' ids be not st'ble.</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 head'n above th' 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"># Th' title fer th' head'n can be overwritten 'n yer i18n files. See Hugo's</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># documentat'n how t' 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 th' 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 ye have more than one language configured, a language switcher be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># displayed 'n th' lower part o' th' menu. This opt'n lets ye 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 planks</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how hidden planks be treated.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># A plank flagged as hidden, be only removed from th' main menu if ye be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># currently not on this plank or th' hidden plank be not part o' current page's</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># ancestors. For all other functionality 'n Hugo a hidden plank behaves like any</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># other plank if not otherwise configured.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Hide hidden planks 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 planks from th' suggest'ns o' th' search box an' th' dedicated</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># search plank.</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 planks fer 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 planks from show'n up 'n th' sitemap an' 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 planks fer 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 planks from show'n up on th' taxonomy an' terms planks. If this</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># reduces term counters t' zero, an empty but not linked term plank 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"># Rrrambl'n</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns modify how yer rrrambl'n be displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Title separator.</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"># Changes th' title separator used when concatenat'n th' plank title wit' th'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># ship title. This be consistently used throughout th' theme.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">titleSeparator</span> <span class="p">=</span> <span class="s2">"::"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Breadcrumb separator.</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"># Changes th' breadcrumb separator used 'n th' topbars breadcrumb area an' fer</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># search results an' term planks.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">breadcrumbSeparator</span> <span class="p">=</span> <span class="s2">">"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Hide th' 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"># Th' root breadcrumb be usually th' home plank o' yer ship. Because this be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># always access'ble by click'n on th' logo, ye may want t' reduce clutter</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># by remov'n this from yer 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 planks.</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 ye have lots o' taxonomy terms, th' term planks may seem cluttered wit'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># breadcrumbs t' ye, so this be th' opt'n t' turn off breadcrumbs on term</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># planks. Only th' plank title will then be shown on th' term planks.</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 opt'ns configure how code be displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Hide copy-to-clipboard fer 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 th' copy-to-clipboard button from yer 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 fer 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"># Th' theme only shows th' copy-to-clipboard button if ye hover over th' code</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># block. Set this t' true t' dis'ble th' hover effect an' always show th'</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 fer code blocks.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># By default lines o' code blocks wrap around if th' line be too long t' be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># displayed on screen. If ye dislike this behavior, ye can reconfigure it</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># here.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Avast that lines always wrap 'n print mode regardless o' this opt'n.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter or given as a parameter t'</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 opt'ns configure how images be displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># What t' do when local image link be not resolved.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: ""</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Ye can control what should happen if a local image can not be resolved t' as</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># a resource. If not set, th' unresolved link be written as given into th' result'n</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># output. If set t' `warning` th' same happens an' an additional warning be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># printed. If set t' `error` an error message be printed an' th' build be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># aborted.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Please note that this can not resolve files inside o' yer `static` directory.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">image</span><span class="p">.</span><span class="nx">errorlevel</span> <span class="p">=</span> <span class="s2">"warning"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Image effects.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># See th' documentat'n fer how ye can even add yer own arbitrary effects t'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># th' list.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># All effects can be overridden 'n th' page's frontmatter or through URL parameter</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># given t' th' image. See th' documentat'n fer details.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">lazy</span> <span class="p">=</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Links</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how links be displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># What t' do when local plank link be not resolved.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: ""</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Ye can control what should happen if a local link can not be resolved t' a</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># plank. If not set, th' unresolved link be written as given into th' result'n</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># output. If set t' `warning` th' same happens an' an additional warning be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># printed. If set t' `error` an error message be printed an' th' build be</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># aborted.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Please note that wit' Cap'n Hugo < 0.123.0 + `uglyURLs=true` this can lead t' false</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># negatives.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">link</span><span class="p">.</span><span class="nx">errorlevel</span> <span class="p">=</span> <span class="s2">"warning"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># How t' open external links.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: "_blank"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># For external links ye can define how they be opened 'n yer browser. All</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># values fer th' HTML `target` attribute o' th' `a` element be allowed. Th'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># default value opens external links 'n a separate browser tab. If ye want</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># t' open those links 'n th' same tab, use "_self".</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">externalLinkTarget</span> <span class="p">=</span> <span class="s2">"_blank"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Generate link URLs th' Cap'n 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 t' true, th' theme behaves like a standard Cap'n Hugo installat'n an'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># appends no index.html t' prettyURLs. As a trade off, yer build project will</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># not be serv'ble from th' 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 opt'ns configure how math formulae be displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Initializat'n opt'ns fer MathJax.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">"{}"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Only board MathJax if needed.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If a Math shortcode be found, th' opt'n will be ignored an'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># be us'n script'n t' set up yer graph. In this case no shortcode or</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># codefence be involved an' th' library be not boarded by default. In this case</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># be boarded.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page'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 fer external MathJax library.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Specifies th' remote locat'n o' th' MathJax library. By default th' shipped</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">customMathJaxURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Merrrmaid</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how Merrrmaid graphs be displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Make graphs pan'ble an' zoom'ble</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># wit' a reset button fer th' zoom.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter or given as a parameter t'</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"># Initializat'n opt'ns fer Merrrmaid.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s2">"{ \"securityLevel\": \"loose\" }"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Only board Merrrmaid if needed.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># be us'n script'n t' set up yer graph. In this case no shortcode or</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># codefence be involved an' th' library be not boarded by default. In this case</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># be boarded.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page'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 fer external Merrrmaid library.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/mermaid/dist/mermaid.min.js"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># OpenApi</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how OpenAPI specificat'ns be displayed.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Only board OpenAPI if needed.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># If a OpenAPI shortcode be found, th' opt'n will be ignored an'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># be us'n script'n t' set up yer graph. In this case no shortcode or</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># codefence be involved an' th' library be not boarded by default. In this case</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t'</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># be boarded.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page'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 fer external OpenAPI library.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"</span></span></span></code></pre></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1713508693" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1713508693" defer></script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1713508693" defer></script>
|
|
</body>
|
|
</html>
|