nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-06-16 22:00:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: ace996b0ba

Browse source
This commit is contained in:
McShelby 2022-12-23 11:24:54 +00:00
parent cf9b67e4d3
commit aee00c5024
336 changed files with 11562 additions and 11538 deletions
basics/configuration
index.htmlindex.print.html

62
basics/configuration/index.html
View file

@ -10,21 +10,21 @@
<title>Configuration :: Hugo Relearn Theme</title>
<link href="../../basics/configuration/index.xml" rel="alternate" type="application/rss+xml" title="Configuration :: Hugo Relearn Theme">
<link href="../../basics/configuration/index.print.html" rel="alternate" type="text/html" title="Configuration :: Hugo Relearn Theme">
<link href="../../images/logo.svg?1671762360" rel="icon" type="image/svg+xml">
<link href="../../images/logo.svg?1671794687" rel="icon" type="image/svg+xml">
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="../../css/fontawesome-all.min.css?1671762360" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1671762360" rel="stylesheet"></noscript>
<link href="../../css/featherlight.min.css?1671762360" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1671762360" rel="stylesheet"></noscript>
<link href="../../css/auto-complete.css?1671762360" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1671762360" rel="stylesheet"></noscript>
<link href="../../css/perfect-scrollbar.min.css?1671762360" rel="stylesheet">
<link href="../../css/nucleus.css?1671762360" rel="stylesheet">
<link href="../../css/fonts.css?1671762360" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1671762360" rel="stylesheet"></noscript>
<link href="../../css/theme.css?1671762360" rel="stylesheet">
<link href="../../css/theme-relearn-light.css?1671762360" rel="stylesheet" id="variant-style">
<link href="../../css/ie.css?1671762360" rel="stylesheet">
<link href="../../css/variant.css?1671762360" rel="stylesheet">
<link href="../../css/print.css?1671762360" rel="stylesheet" media="print">
<script src="../../js/url.js?1671762360"></script>
<script src="../../js/variant.js?1671762360"></script>
<link href="../../css/fontawesome-all.min.css?1671794687" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1671794687" rel="stylesheet"></noscript>
<link href="../../css/featherlight.min.css?1671794687" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1671794687" rel="stylesheet"></noscript>
<link href="../../css/auto-complete.css?1671794687" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1671794687" rel="stylesheet"></noscript>
<link href="../../css/perfect-scrollbar.min.css?1671794687" rel="stylesheet">
<link href="../../css/nucleus.css?1671794687" rel="stylesheet">
<link href="../../css/fonts.css?1671794687" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1671794687" rel="stylesheet"></noscript>
<link href="../../css/theme.css?1671794687" rel="stylesheet">
<link href="../../css/theme-relearn-light.css?1671794687" rel="stylesheet" id="variant-style">
<link href="../../css/ie.css?1671794687" rel="stylesheet">
<link href="../../css/variant.css?1671794687" rel="stylesheet">
<link href="../../css/print.css?1671794687" rel="stylesheet" media="print">
<script src="../../js/url.js?1671794687"></script>
<script src="../../js/variant.js?1671794687"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
@ -42,7 +42,7 @@
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
</script>
<script src="../../js/jquery.min.js?1671762360" defer></script>
<script src="../../js/jquery.min.js?1671794687" defer></script>
<style>
#body img.bg-white {
background-color: white;
@ -67,7 +67,7 @@
</a>
</div>
<div id="top-github-link">
<a class="github-link" title='Edit (CTRL+ALT+w)' href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/basics/configuration/_index.en.md" target="blank">
<a class="github-link" title='Edit (CTRL+ALT+w)' href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/basics/configuration/_index.en.md" target="_blank">
<i class="fas fa-pen fa-fw"></i>
</a>
</div>
@ -120,7 +120,7 @@
<h1 id="configuration">Configuration</h1>
<h2 id="global-site-parameters">Global site parameters</h2>
<p>On top of <a href="https://gohugo.io/overview/configuration/" target="_blank" rel="noopener">Hugo global configuration</a>, the Relearn theme lets you define the following parameters in your <code>config.toml</code> (here, values are default).</p>
<p>On top of <a href="https://gohugo.io/overview/configuration/" target="_blank">Hugo global configuration</a>, the Relearn theme lets you define the following parameters in your <code>config.toml</code> (here, values are default).</p>
<p>Note that some of these parameters are explained in details in other sections of this documentation.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">params</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="c"># This controls whether submenus will be expanded (true), or collapsed (false) in the</span>
@ -198,12 +198,14 @@
</span></span><span class="line"><span class="cl"> <span class="c"># If set to true, no index.html will be appended to prettyURLs; this will cause pages not</span>
</span></span><span class="line"><span class="cl"> <span class="c"># to be servable from the file system</span>
</span></span><span class="line"><span class="cl"> <span class="nx">disableExplicitIndexURLs</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl"> <span class="c"># For external links you can define how they are opened in your browser; this setting will only be applied to the content area but not the shortcut menu</span>
</span></span><span class="line"><span class="cl"> <span class="nx">externalLinkTarget</span> <span class="p">=</span> <span class="s2">&#34;_blank&#34;</span>
</span></span></code></pre></div><h2 id="serving-your-page-from-a-subfolder">Serving your page from a subfolder</h2>
<p>If your site is served from a subfolder, eg. <code>https://example.com/mysite/</code>, you have to set the following lines to your <code>config.toml</code></p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">baseURL</span> <span class="p">=</span> <span class="s2">&#34;https://example.com/mysite/&#34;</span>
</span></span><span class="line"><span class="cl"><span class="nx">canonifyURLs</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">true</span>
</span></span></code></pre></div><p>Without <code>canonifyURLs=true</code> URLs in sublemental pages (like <code>sitemap.xml</code>, <code>rss.xml</code>) will be generated falsly while your HTML files will still work. See <a href="https://github.com/gohugoio/hugo/issues/5226" target="_blank" rel="noopener">https://github.com/gohugoio/hugo/issues/5226</a>.</p>
</span></span></code></pre></div><p>Without <code>canonifyURLs=true</code> URLs in sublemental pages (like <code>sitemap.xml</code>, <code>rss.xml</code>) will be generated falsly while your HTML files will still work. See <a href="https://github.com/gohugoio/hugo/issues/5226" target="_blank">https://github.com/gohugoio/hugo/issues/5226</a>.</p>
<h2 id="serving-your-page-from-the-filesystem">Serving your page from the filesystem</h2>
<p>If you want your page served from the filesystem by using URLs starting with <code>file://</code> you&rsquo;ll need the following configuration in your <code>config.toml</code>:</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">true</span>
@ -243,7 +245,7 @@
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>The resulting URL will not be <a href="https://gohugo.io/templates/output-formats/#configure-output-formats" target="_blank" rel="noopener">configured ugly</a> in terms of <a href="https://gohugo.io/content-management/urls/#ugly-urls" target="_blank" rel="noopener">Hugo&rsquo;s URL handling</a> even if you&rsquo;ve set <code>uglyURLs=true</code> in your <code>config.toml</code>. This is due to the fact that for one mime type only one suffix can be configured.</p>
<p>The resulting URL will not be <a href="https://gohugo.io/templates/output-formats/#configure-output-formats" target="_blank">configured ugly</a> in terms of <a href="https://gohugo.io/content-management/urls/#ugly-urls" target="_blank">Hugo&rsquo;s URL handling</a> even if you&rsquo;ve set <code>uglyURLs=true</code> in your <code>config.toml</code>. This is due to the fact that for one mime type only one suffix can be configured.</p>
<p>Nevertheless, if you&rsquo;re unhappy with the resulting URLs you can manually redefine <code>outputFormats.PRINT</code> in your own <code>config.toml</code> to your liking.</p>
</div>
</div>
@ -360,12 +362,12 @@ default values:</p>
<script>
var contentLangs=['en'];
</script>
<script src="../../js/auto-complete.js?1671762361" defer></script>
<script src="../../js/lunr.min.js?1671762361" defer></script>
<script src="../../js/lunr.stemmer.support.min.js?1671762361" defer></script>
<script src="../../js/lunr.multi.min.js?1671762361" defer></script>
<script src="../../js/lunr.en.min.js?1671762361" defer></script>
<script src="../../js/search.js?1671762361" defer></script>
<script src="../../js/auto-complete.js?1671794688" defer></script>
<script src="../../js/lunr.min.js?1671794688" defer></script>
<script src="../../js/lunr.stemmer.support.min.js?1671794688" defer></script>
<script src="../../js/lunr.multi.min.js?1671794688" defer></script>
<script src="../../js/lunr.en.min.js?1671794688" defer></script>
<script src="../../js/search.js?1671794688" defer></script>
</div>
<div id="content-wrapper" class="highlightable">
<ul class="topics collapsible-menu">
@ -481,13 +483,13 @@ default values:</p>
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn" data-icon="octicon-star" data-show-count="true" aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
<script async src="../../js/buttons.js?1671762361"></script>
<script async src="../../js/buttons.js?1671794688"></script>
</div>
</div>
</aside>
<script src="../../js/clipboard.min.js?1671762361" defer></script>
<script src="../../js/perfect-scrollbar.min.js?1671762361" defer></script>
<script src="../../js/featherlight.min.js?1671762361" defer></script>
<script src="../../js/theme.js?1671762361" defer></script>
<script src="../../js/clipboard.min.js?1671794688" defer></script>
<script src="../../js/perfect-scrollbar.min.js?1671794688" defer></script>
<script src="../../js/featherlight.min.js?1671794688" defer></script>
<script src="../../js/theme.js?1671794688" defer></script>
</body>
</html>

48
basics/configuration/index.print.html
View file

@ -10,22 +10,22 @@
<title>Configuration :: Hugo Relearn Theme</title>
<link href="https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel="canonical" type="text/html" title="Configuration :: Hugo Relearn Theme">
<link href="../../basics/configuration/index.xml" rel="alternate" type="application/rss+xml" title="Configuration :: Hugo Relearn Theme">
<link href="../../images/logo.svg?1671762360" rel="icon" type="image/svg+xml">
<link href="../../images/logo.svg?1671794687" rel="icon" type="image/svg+xml">
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="../../css/fontawesome-all.min.css?1671762362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1671762362" rel="stylesheet"></noscript>
<link href="../../css/featherlight.min.css?1671762362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1671762362" rel="stylesheet"></noscript>
<link href="../../css/auto-complete.css?1671762362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1671762362" rel="stylesheet"></noscript>
<link href="../../css/perfect-scrollbar.min.css?1671762362" rel="stylesheet">
<link href="../../css/nucleus.css?1671762362" rel="stylesheet">
<link href="../../css/fonts.css?1671762362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1671762362" rel="stylesheet"></noscript>
<link href="../../css/theme.css?1671762362" rel="stylesheet">
<link href="../../css/theme-relearn-light.css?1671762362" rel="stylesheet" id="variant-style">
<link href="../../css/ie.css?1671762362" rel="stylesheet">
<link href="../../css/variant.css?1671762362" rel="stylesheet">
<link href="../../css/print.css?1671762362" rel="stylesheet" media="print">
<link href="../../css/format-print.css?1671762362" rel="stylesheet">
<script src="../../js/url.js?1671762362"></script>
<script src="../../js/variant.js?1671762362"></script>
<link href="../../css/fontawesome-all.min.css?1671794688" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1671794688" rel="stylesheet"></noscript>
<link href="../../css/featherlight.min.css?1671794688" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1671794688" rel="stylesheet"></noscript>
<link href="../../css/auto-complete.css?1671794688" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1671794688" rel="stylesheet"></noscript>
<link href="../../css/perfect-scrollbar.min.css?1671794688" rel="stylesheet">
<link href="../../css/nucleus.css?1671794688" rel="stylesheet">
<link href="../../css/fonts.css?1671794688" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1671794688" rel="stylesheet"></noscript>
<link href="../../css/theme.css?1671794688" rel="stylesheet">
<link href="../../css/theme-relearn-light.css?1671794688" rel="stylesheet" id="variant-style">
<link href="../../css/ie.css?1671794688" rel="stylesheet">
<link href="../../css/variant.css?1671794688" rel="stylesheet">
<link href="../../css/print.css?1671794688" rel="stylesheet" media="print">
<link href="../../css/format-print.css?1671794688" rel="stylesheet">
<script src="../../js/url.js?1671794688"></script>
<script src="../../js/variant.js?1671794688"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
@ -43,7 +43,7 @@
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
</script>
<script src="../../js/jquery.min.js?1671762362" defer></script>
<script src="../../js/jquery.min.js?1671794688" defer></script>
<style>
#body img.bg-white {
background-color: white;
@ -76,7 +76,7 @@
<h1 id="configuration">Configuration</h1>
<h2 id="global-site-parameters">Global site parameters</h2>
<p>On top of <a href="https://gohugo.io/overview/configuration/" target="_blank" rel="noopener">Hugo global configuration</a>, the Relearn theme lets you define the following parameters in your <code>config.toml</code> (here, values are default).</p>
<p>On top of <a href="https://gohugo.io/overview/configuration/" target="_blank">Hugo global configuration</a>, the Relearn theme lets you define the following parameters in your <code>config.toml</code> (here, values are default).</p>
<p>Note that some of these parameters are explained in details in other sections of this documentation.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">params</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="c"># This controls whether submenus will be expanded (true), or collapsed (false) in the</span>
@ -154,12 +154,14 @@
</span></span><span class="line"><span class="cl"> <span class="c"># If set to true, no index.html will be appended to prettyURLs; this will cause pages not</span>
</span></span><span class="line"><span class="cl"> <span class="c"># to be servable from the file system</span>
</span></span><span class="line"><span class="cl"> <span class="nx">disableExplicitIndexURLs</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl"> <span class="c"># For external links you can define how they are opened in your browser; this setting will only be applied to the content area but not the shortcut menu</span>
</span></span><span class="line"><span class="cl"> <span class="nx">externalLinkTarget</span> <span class="p">=</span> <span class="s2">&#34;_blank&#34;</span>
</span></span></code></pre></div><h2 id="serving-your-page-from-a-subfolder">Serving your page from a subfolder</h2>
<p>If your site is served from a subfolder, eg. <code>https://example.com/mysite/</code>, you have to set the following lines to your <code>config.toml</code></p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">baseURL</span> <span class="p">=</span> <span class="s2">&#34;https://example.com/mysite/&#34;</span>
</span></span><span class="line"><span class="cl"><span class="nx">canonifyURLs</span> <span class="p">=</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">true</span>
</span></span></code></pre></div><p>Without <code>canonifyURLs=true</code> URLs in sublemental pages (like <code>sitemap.xml</code>, <code>rss.xml</code>) will be generated falsly while your HTML files will still work. See <a href="https://github.com/gohugoio/hugo/issues/5226" target="_blank" rel="noopener">https://github.com/gohugoio/hugo/issues/5226</a>.</p>
</span></span></code></pre></div><p>Without <code>canonifyURLs=true</code> URLs in sublemental pages (like <code>sitemap.xml</code>, <code>rss.xml</code>) will be generated falsly while your HTML files will still work. See <a href="https://github.com/gohugoio/hugo/issues/5226" target="_blank">https://github.com/gohugoio/hugo/issues/5226</a>.</p>
<h2 id="serving-your-page-from-the-filesystem">Serving your page from the filesystem</h2>
<p>If you want your page served from the filesystem by using URLs starting with <code>file://</code> you&rsquo;ll need the following configuration in your <code>config.toml</code>:</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">true</span>
@ -199,7 +201,7 @@
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>The resulting URL will not be <a href="https://gohugo.io/templates/output-formats/#configure-output-formats" target="_blank" rel="noopener">configured ugly</a> in terms of <a href="https://gohugo.io/content-management/urls/#ugly-urls" target="_blank" rel="noopener">Hugo&rsquo;s URL handling</a> even if you&rsquo;ve set <code>uglyURLs=true</code> in your <code>config.toml</code>. This is due to the fact that for one mime type only one suffix can be configured.</p>
<p>The resulting URL will not be <a href="https://gohugo.io/templates/output-formats/#configure-output-formats" target="_blank">configured ugly</a> in terms of <a href="https://gohugo.io/content-management/urls/#ugly-urls" target="_blank">Hugo&rsquo;s URL handling</a> even if you&rsquo;ve set <code>uglyURLs=true</code> in your <code>config.toml</code>. This is due to the fact that for one mime type only one suffix can be configured.</p>
<p>Nevertheless, if you&rsquo;re unhappy with the resulting URLs you can manually redefine <code>outputFormats.PRINT</code> in your own <code>config.toml</code> to your liking.</p>
</div>
</div>
@ -244,9 +246,9 @@ default values:</p>
</div>
</main>
</div>
<script src="../../js/clipboard.min.js?1671762362" defer></script>
<script src="../../js/perfect-scrollbar.min.js?1671762362" defer></script>
<script src="../../js/featherlight.min.js?1671762362" defer></script>
<script src="../../js/theme.js?1671762362" defer></script>
<script src="../../js/clipboard.min.js?1671794689" defer></script>
<script src="../../js/perfect-scrollbar.min.js?1671794689" defer></script>
<script src="../../js/featherlight.min.js?1671794689" defer></script>
<script src="../../js/theme.js?1671794689" defer></script>
</body>
</html>