This commit is contained in:
McShelby 2024-04-07 13:13:19 +00:00
parent 2611a9597c
commit 3e1df44bb7
264 changed files with 8174 additions and 7718 deletions
basics/configuration

View file

@ -11,33 +11,37 @@
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta name="twitter:title" content="Configuration :: Hugo Relearn Theme">
<meta name="twitter:description" content="Documentation for Hugo Relearn Theme">
<meta property="og:title" content="Configuration :: Hugo Relearn Theme">
<meta property="og:description" content="Documentation for Hugo Relearn Theme">
<meta property="og:type" content="website">
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html">
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta property="og:site_name" content="Hugo Relearn Theme">
<meta property="og:title" content="Configuration :: Hugo Relearn Theme">
<meta property="og:description" content="On top of Hugo&amp;rsquo;s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo.toml.
Note that some of these options are explained in detail in other sections of this documentation.
All config options The values reflect the options active in this documentation. The defaults can be taken from the annotated example below.
hugo. toml yaml json [params] additionalContentLanguage = [&amp;#39;en&amp;#39;] alwaysopen = &amp;#39;&amp;#39; breadcrumbSeparator = &amp;#39;&amp;gt;&amp;#39; collapsibleMenu = true customMathJaxURL = &amp;#39;&amp;#39; customMermaidURL = &amp;#39;&amp;#39; customOpenapiURL = &amp;#39;&amp;#39; description = &amp;#39;Documentation for Hugo Relearn Theme&amp;#39; disableAssetsBusting = 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 = &amp;#39;https://github.">
<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">
<title>Configuration :: Hugo Relearn Theme</title>
<link href="https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel="alternate" hreflang="x-default">
<link href="https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel="alternate" hreflang="en">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html" rel="alternate" hreflang="art-pir">
<link href="/hugo-theme-relearn/basics/configuration/index.xml" rel="alternate" type="application/rss+xml" title="Configuration :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/basics/configuration/index.print.html" rel="alternate" type="text/html" title="Configuration :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/images/logo.svg?1712490332" rel="icon" type="image/svg+xml">
<link href="/hugo-theme-relearn/images/logo.svg?1712495591" 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?1712490332" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712490332" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/nucleus.css?1712490332" rel="stylesheet">
<link href="/hugo-theme-relearn/css/auto-complete.css?1712490332" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1712490332" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1712490332" rel="stylesheet">
<link href="/hugo-theme-relearn/css/fonts.css?1712490332" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1712490332" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/theme.css?1712490332" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1712490332" rel="stylesheet" id="R-variant-style">
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1712490332" rel="stylesheet" id="R-variant-chroma-style">
<link href="/hugo-theme-relearn/css/variant.css?1712490332" rel="stylesheet">
<link href="/hugo-theme-relearn/css/print.css?1712490332" rel="stylesheet" media="print">
<link href="/hugo-theme-relearn/css/ie.css?1712490332" rel="stylesheet">
<script src="/hugo-theme-relearn/js/url.js?1712490332"></script>
<script src="/hugo-theme-relearn/js/variant.js?1712490332"></script>
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712495591" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712495591" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/nucleus.css?1712495591" rel="stylesheet">
<link href="/hugo-theme-relearn/css/auto-complete.css?1712495591" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1712495591" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1712495591" rel="stylesheet">
<link href="/hugo-theme-relearn/css/fonts.css?1712495591" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1712495591" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/theme.css?1712495591" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1712495591" rel="stylesheet" id="R-variant-style">
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1712495591" rel="stylesheet" id="R-variant-chroma-style">
<link href="/hugo-theme-relearn/css/variant.css?1712495591" rel="stylesheet">
<link href="/hugo-theme-relearn/css/print.css?1712495591" rel="stylesheet" media="print">
<link href="/hugo-theme-relearn/css/ie.css?1712495591" rel="stylesheet">
<script src="/hugo-theme-relearn/js/url.js?1712495591"></script>
<script src="/hugo-theme-relearn/js/variant.js?1712495591"></script>
<script>
window.relearn = window.relearn || {};
window.relearn.relBasePath='..\/..';
@ -463,13 +467,13 @@
</div>
<h2 id="annotated-config-options">Annotated config options</h2>
<div class="tab-panel" data-tab-group="611cac4bd295b41a9ea92e655aaa5a6d">
<div class="tab-panel" data-tab-group="25fa9a1035018bc15a80b5b5296a25b8">
<div class="tab-nav">
<div class="tab-nav-title">&#8203;</div>
<button
data-tab-item="hugotoml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('611cac4bd295b41a9ea92e655aaa5a6d','hugotoml')"
onclick="switchTab('25fa9a1035018bc15a80b5b5296a25b8','hugotoml')"
>
<span class="tab-nav-text">hugo.toml</span>
</button>
@ -1029,12 +1033,12 @@
<script>
var contentLangs=['en'];
</script>
<script src="/hugo-theme-relearn/js/auto-complete.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.min.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.stemmer.support.min.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.multi.min.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.en.min.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/search.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/auto-complete.js?1712495591" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.min.js?1712495591" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.stemmer.support.min.js?1712495591" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.multi.min.js?1712495591" defer></script>
<script src="/hugo-theme-relearn/js/lunr/lunr.en.min.js?1712495591" defer></script>
<script src="/hugo-theme-relearn/js/search.js?1712495591" defer></script>
</div>
<div id="R-homelinks" class="default-animation">
<hr class="padding">
@ -1197,13 +1201,13 @@
setTimeout( githubButtonsInit, 400 );
});
</script>
<script async src="/hugo-theme-relearn/js/github-buttons.js?1712490333"></script>
<script async src="/hugo-theme-relearn/js/github-buttons.js?1712495591"></script>
</div>
</div>
</div>
</aside>
<script src="/hugo-theme-relearn/js/clipboard.min.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/theme.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/clipboard.min.js?1712495591" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1712495591" defer></script>
<script src="/hugo-theme-relearn/js/theme.js?1712495591" defer></script>
</body>
</html>

View file

@ -11,34 +11,38 @@
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta name="twitter:title" content="Configuration :: Hugo Relearn Theme">
<meta name="twitter:description" content="Documentation for Hugo Relearn Theme">
<meta property="og:title" content="Configuration :: Hugo Relearn Theme">
<meta property="og:description" content="Documentation for Hugo Relearn Theme">
<meta property="og:type" content="website">
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html">
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta property="og:site_name" content="Hugo Relearn Theme">
<meta property="og:title" content="Configuration :: Hugo Relearn Theme">
<meta property="og:description" content="On top of Hugo&amp;rsquo;s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo.toml.
Note that some of these options are explained in detail in other sections of this documentation.
All config options The values reflect the options active in this documentation. The defaults can be taken from the annotated example below.
hugo. toml yaml json [params] additionalContentLanguage = [&amp;#39;en&amp;#39;] alwaysopen = &amp;#39;&amp;#39; breadcrumbSeparator = &amp;#39;&amp;gt;&amp;#39; collapsibleMenu = true customMathJaxURL = &amp;#39;&amp;#39; customMermaidURL = &amp;#39;&amp;#39; customOpenapiURL = &amp;#39;&amp;#39; description = &amp;#39;Documentation for Hugo Relearn Theme&amp;#39; disableAssetsBusting = 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 = &amp;#39;https://github.">
<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">
<title>Configuration :: Hugo Relearn Theme</title>
<link href="https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel="alternate" hreflang="x-default">
<link href="https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel="alternate" hreflang="en">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html" rel="alternate" hreflang="art-pir">
<link href="https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel="canonical" type="text/html" title="Configuration :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/basics/configuration/index.xml" rel="alternate" type="application/rss+xml" title="Configuration :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/images/logo.svg?1712490332" rel="icon" type="image/svg+xml">
<link href="/hugo-theme-relearn/images/logo.svg?1712495591" 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?1712490333" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712490333" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/nucleus.css?1712490333" rel="stylesheet">
<link href="/hugo-theme-relearn/css/auto-complete.css?1712490333" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1712490333" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1712490333" rel="stylesheet">
<link href="/hugo-theme-relearn/css/fonts.css?1712490333" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1712490333" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/theme.css?1712490333" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1712490333" rel="stylesheet" id="R-variant-style">
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1712490333" rel="stylesheet" id="R-variant-chroma-style">
<link href="/hugo-theme-relearn/css/variant.css?1712490333" rel="stylesheet">
<link href="/hugo-theme-relearn/css/print.css?1712490333" rel="stylesheet" media="print">
<link href="/hugo-theme-relearn/css/format-print.css?1712490333" rel="stylesheet">
<link href="/hugo-theme-relearn/css/ie.css?1712490333" rel="stylesheet">
<script src="/hugo-theme-relearn/js/url.js?1712490333"></script>
<script src="/hugo-theme-relearn/js/variant.js?1712490333"></script>
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712495592" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712495592" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/nucleus.css?1712495592" rel="stylesheet">
<link href="/hugo-theme-relearn/css/auto-complete.css?1712495592" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1712495592" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1712495592" rel="stylesheet">
<link href="/hugo-theme-relearn/css/fonts.css?1712495592" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1712495592" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/theme.css?1712495592" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1712495592" rel="stylesheet" id="R-variant-style">
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1712495592" rel="stylesheet" id="R-variant-chroma-style">
<link href="/hugo-theme-relearn/css/variant.css?1712495592" rel="stylesheet">
<link href="/hugo-theme-relearn/css/print.css?1712495592" rel="stylesheet" media="print">
<link href="/hugo-theme-relearn/css/format-print.css?1712495592" rel="stylesheet">
<link href="/hugo-theme-relearn/css/ie.css?1712495592" rel="stylesheet">
<script src="/hugo-theme-relearn/js/url.js?1712495592"></script>
<script src="/hugo-theme-relearn/js/variant.js?1712495592"></script>
<script>
window.relearn = window.relearn || {};
window.relearn.relBasePath='..\/..';
@ -436,13 +440,13 @@
</div>
<h2 id="annotated-config-options">Annotated config options</h2>
<div class="tab-panel" data-tab-group="611cac4bd295b41a9ea92e655aaa5a6d">
<div class="tab-panel" data-tab-group="25fa9a1035018bc15a80b5b5296a25b8">
<div class="tab-nav">
<div class="tab-nav-title">&#8203;</div>
<button
data-tab-item="hugotoml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('611cac4bd295b41a9ea92e655aaa5a6d','hugotoml')"
onclick="switchTab('25fa9a1035018bc15a80b5b5296a25b8','hugotoml')"
>
<span class="tab-nav-text">hugo.toml</span>
</button>
@ -918,8 +922,8 @@
</div>
</main>
</div>
<script src="/hugo-theme-relearn/js/clipboard.min.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/theme.js?1712490333" defer></script>
<script src="/hugo-theme-relearn/js/clipboard.min.js?1712495592" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1712495592" defer></script>
<script src="/hugo-theme-relearn/js/theme.js?1712495592" defer></script>
</body>
</html>