204 lines
13 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article" data-r-output-format="html">
<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.146.1">
<meta name="generator" content="Relearn 7.6.1+523120f28eb07bf5707e343d07e79fe704ae1f38">
<meta name="description" content="All configuration options for the Relearn theme">
<meta name="author" content="Sören Weber">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta name="twitter:title" content="Options Reference :: Hugo Relearn Theme">
<meta name="twitter:description" content="All configuration options for the Relearn theme">
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/configuration/reference/index.html">
<meta property="og:site_name" content="Hugo Relearn Theme">
<meta property="og:title" content="Options Reference :: Hugo Relearn Theme">
<meta property="og:description" content="All configuration options for the Relearn theme">
<meta property="og:locale" content="en">
<meta property="og:type" content="website">
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta itemprop="name" content="Options Reference :: Hugo Relearn Theme">
<meta itemprop="description" content="All configuration options for the Relearn theme">
<meta itemprop="wordCount" content="6076">
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta itemprop="keywords" content="Reference">
<title>Options Reference :: Hugo Relearn Theme</title>
<link href="https://mcshelby.github.io/hugo-theme-relearn/configuration/reference/index.html" rel="alternate" hreflang="x-default">
<link href="https://mcshelby.github.io/hugo-theme-relearn/configuration/reference/index.html" rel="alternate" hreflang="en">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/configuration/reference/index.html" rel="alternate" hreflang="art-x-pir">
<link href="https://mcshelby.github.io/hugo-theme-relearn/configuration/reference/index.html" rel="canonical" type="text/html" title="Options Reference :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/configuration/reference/index.xml" rel="alternate" type="application/rss+xml" title="Options Reference :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/images/logo.svg?1744312650" rel="icon" type="image/svg+xml">
<link href="/hugo-theme-relearn/fonts/fontawesome/css/fontawesome-all.min.css?1744312650" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/fonts/fontawesome/css/fontawesome-all.min.css?1744312650" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar/perfect-scrollbar.min.css?1744312650" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme.min.css?1744312650" rel="stylesheet">
<link href="/hugo-theme-relearn/css/format-html.min.css?1744312650" rel="stylesheet" id="R-format-style">
<link href="/hugo-theme-relearn/css/auto-complete/auto-complete.min.css?1744312650" rel="stylesheet">
<script src="/hugo-theme-relearn/js/auto-complete/auto-complete.min.js?1744312650" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.min.js?1744312650" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.stemmer.support.min.js?1744312650" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.multi.min.js?1744312650" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.en.min.js?1744312650" defer></script>
<script src="/hugo-theme-relearn/js/search.min.js?1744312650" defer></script>
<script>
window.relearn = window.relearn || {};
// configuration
window.relearn.min = `.min`;
window.relearn.path='\/configuration\/reference\/index.html';
window.relearn.relBasePath='..\/..';
window.relearn.relBaseUri='..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
window.relearn.contentLangs=['en'];
window.relearn.index_js_url="/hugo-theme-relearn/searchindex.en.js?1744312650";
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
window.relearn.disableInlineCopyToClipboard=true;
window.relearn.enableBlockCodeWrap=true;
// legal
window.relearn.getItem = (s,n) => {return s.getItem(n)};
window.relearn.setItem = (s,n,v) => {return s.setItem(n,v)};
window.relearn.removeItem = (s,n) => {return s.removeItem(n)};
// variant stuff
window.relearn.themevariants = [ 'relearn-auto', 'relearn-dark', 'relearn-light', 'relearn-bright', 'zen-auto', 'zen-dark', 'zen-light', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ];
window.relearn.customvariantname = "my-custom-variant";
window.relearn.changeVariant = function(variant) {
var oldVariant = document.documentElement.dataset.rThemeVariant;
window.relearn.setItem(window.localStorage, window.relearn.absBaseUri + "/variant", variant);
document.documentElement.dataset.rThemeVariant = variant;
if (oldVariant != variant) {
document.dispatchEvent( new CustomEvent('themeVariantLoaded', { detail: { variant, oldVariant } }) );
window.relearn.markVariant();
}
}
window.relearn.markVariant = function() {
var variant = window.relearn.getItem(window.localStorage, window.relearn.absBaseUri + "/variant");
document.querySelectorAll(".R-variantswitcher select").forEach((select) => {select.value = variant;});
}
window.relearn.initVariant = function() {
var variant = window.relearn.getItem(window.localStorage, window.relearn.absBaseUri + "/variant") ?? "";
if( variant == window.relearn.customvariantname ){
}else if( !variant || !window.relearn.themevariants.includes(variant) ){
variant = window.relearn.themevariants[0];
window.relearn.setItem(window.localStorage, window.relearn.absBaseUri + "/variant", variant);
}
document.documentElement.dataset.rThemeVariant = variant;
}
window.relearn.initVariant();
window.relearn.markVariant();
// translations
window.T_Copy_to_clipboard = `Copy to clipboard`;
window.T_Copied_to_clipboard = `Copied to clipboard!`;
window.T_Copy_link_to_clipboard = `Copy link to clipboard`;
window.T_Link_copied_to_clipboard = `Copied link to clipboard!`;
window.T_Reset_view = `Reset view`;
window.T_View_reset = `View reset!`;
window.T_No_results_found = `No results found for "{0}"`;
window.T_N_results_found = `{1} results found for "{0}"`;
</script>
<script src="/hugo-theme-relearn/js/variant.min.js?1744312650"></script>
<style>
#R-body img.bg-white {
background-color: white;
}
#R-logo {
font-size: 1.875rem;
margin-bottom: -.666rem;
margin-top: -.666rem;
max-width: 100%;
width: 14.125rem;
}
@media only all and (max-width: 59.999rem) {
#R-logo {
font-size: 1.5625rem;
margin-bottom: -.1875rem;
margin-top: -.1875rem;
}
}
#R-logo svg {
display: inline-block;
opacity: .945;
vertical-align: middle;
width: 29% !important;
}
@media only all and (max-width: 59.999rem) {
#R-logo svg {
width: 24.5% !important;
}
}
#R-logo svg * {
opacity: .945;
}
#R-logo .logo-title{
display: inline-block;
text-align: left;
text-wrap: wrap;
overflow-wrap: break-word;
vertical-align: middle;
width: 4.5em;
}
</style>
</head>
<body class="mobile-support html" data-url="/hugo-theme-relearn/configuration/reference/index.html">
<div id="R-body" class="default-animation">
<div id="R-body-overlay"></div>
<nav id="R-topbar">
<div class="topbar-wrapper">
<div class="topbar-sidebar-divider"></div>
<div class="topbar-area topbar-area-start" data-area="start">
<div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide"><button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL&#43;ALT&#43;n)"><i class="fa-fw fas fa-bars"></i></button>
</div>
<div class="topbar-button topbar-button-toc" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Table of Contents (CTRL&#43;ALT&#43;t)"><i class="fa-fw fas fa-list-alt"></i></button>
<div class="topbar-content">
<div class="topbar-content-wrapper">
<nav class="TableOfContents">
<ul>
<li><a href="#index">Index</a></li>
<li><a href="#all-configuration-options">All Configuration Options</a></li>
<li><a href="#annotated-configuration-options">Annotated Configuration Options</a></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList">
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement" class="a11y-only"><a itemprop="item" href="/hugo-theme-relearn/index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1">&nbsp;>&nbsp;</li>
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement" class=""><a itemprop="item" href="/hugo-theme-relearn/configuration/index.html"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="2">&nbsp;>&nbsp;</li>
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement" class=""><span itemprop="name">Options Reference</span><meta itemprop="position" content="3"></li>
</ol>
<div class="topbar-area topbar-area-end" data-area="end">
<div class="topbar-button topbar-button-edit" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="https://github.com/McShelby/hugo-theme-relearn/edit/main/docs/content/configuration/reference/_index.en.md" rel="external" target="_self" title="Edit (CTRL+ALT+w)"><i class="fa-fw fas fa-pen"></i></a>
</div>
<div class="topbar-button topbar-button-print" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/configuration/reference/index.print.html" title="Print whole chapter (CTRL+ALT+p)"><i class="fa-fw fas fa-print"></i></a>
</div>
<div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/configuration/customization/taxonomy/index.html" title="Taxonomies (🡐)"><i class="fa-fw fas fa-chevron-left"></i></a>
</div>
<div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/authoring/index.html" title="Authoring (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a>
</div>
<div class="topbar-button topbar-button-more" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="More"><i class="fa-fw fas fa-ellipsis-v"></i></button>
<div class="topbar-content">
<div class="topbar-content-wrapper">
<div class="topbar-area topbar-area-more" data-area="more">
</div>
</div>
</div>
</div>
</div>
</div>
</nav>
<div id="R-main-overlay"></div>
<main id="R-body-inner" class="highlightable configuration" tabindex="-1">
<div class="flex-block-wrapper">
</div>
</main>
</div>
<script src="/hugo-theme-relearn/js/clipboard/clipboard.min.js?1744312650" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar/perfect-scrollbar.min.js?1744312650" defer></script>
<script src="/hugo-theme-relearn/js/theme.min.js?1744312650" defer></script>
</body>
</html>