<p>The <ahref="http://github.com/McShelby/hugo-theme-relearn">Relearn theme</a> is a theme for <ahref="https://gohugo.io/">Hugo</a>, a static website generator written in Go. Where Hugo is often used for blogs, this theme is designed with documentation in mind.</p>
<p>The theme is a fork of the great <ahref="https://github.com/matcornic/hugo-theme-learn">Learn theme</a> with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.</p>
<p>To get support, feel free to open a new <ahref="https://github.com/McShelby/hugo-theme-relearn/discussions">discussion topic</a> or <ahref="https://github.com/McShelby/hugo-theme-relearn/issues">issue</a> in the official repository on GitHub.</p>
<h2id="become-a-contributor">Become a contributor</h2>
<p>Feel free to update this documentation by just clicking the <strong>Edit</strong> link displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.</p>
<p>You are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the <ahref="https://github.com/McShelby/hugo-theme-relearn">official repository</a> via GitHub. Please visit the <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/contributing.md">contribution guidelines</a> first.</p>
<h2id="license">License</h2>
<p>This theme is licensed under the <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE">MIT License</a>.</p>
<h2id="credits">Credits</h2>
<p>This theme would not be possible without the work of many others. See the <ahref="/hugo-theme-relearn/more/credits/">credits</a> for a detailed list.</p>
<footerclass="footline">
</footer>
</article>
<section>
<articleclass="chapter">
<h3id="chapter-1">Chapter 1</h3>
<h1id="basics">Basics</h1>
<p>Discover what this Hugo theme is all about and the core-concepts behind it.</p>
<footerclass="footline">
</footer>
</article>
<section>
<article>
<h1>What's new</h1>
<p>This document shows you what’s new in the latest release. For a detailed list of changes, see the <ahref="/hugo-theme-relearn/basics/history/">history page</a>.</p>
<p><strong>Breaking</strong>: A change that requires action by you after upgrading to assure the site is still functional.</p>
<p><strong>Change</strong>: A change in default behavior. This may requires action by you / may or may not be revertable by configuration.</p>
<p><strong>New</strong>: Marks new behavior you might find interesting or comes configurable.</p>
<p><strong>Breaking</strong>: The <code>custom_css</code> config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the <code>custom-header.html</code> template in a much more generic manner.</p>
<p><strong>Breaking</strong>: Because anchor hover color was not configurable without introducing more complexitity to the variant stylesheets, we decided to remove <code>--MAIN-ANCHOR-color</code> instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from <code>--MAIN-LINK-color</code> and <code>--MAIN-ANCHOR-HOVER-color</code> respectivley.</p>
<p><strong>New</strong>: All shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don’t need to change anything in your installation.</p>
<p>This applies to <ahref="/hugo-theme-relearn/shortcodes/expand/"><code>expand</code></a> , <ahref="/hugo-theme-relearn/shortcodes/include/"><code>include</code></a> , <ahref="/hugo-theme-relearn/shortcodes/notice/"><code>notice</code></a> and <ahref="/hugo-theme-relearn/shortcodes/siteparam/"><code>siteparam</code></a> .</p>
<p><strong>New</strong>: The <ahref="/hugo-theme-relearn/shortcodes/button/"><code>button</code></a> shortcode received some love and now has a parameter for the color style similar to other shortcodes.</p>
</li>
<li>
<p><strong>New</strong>: New colors <code>--PRIMARY-color</code> and <code>--SECONDARY-color</code> were added to provide easier modification of your custom style. Shortcodes with a color style can now have <code>primary</code> or <code>secondary</code> as additional values.</p>
<p>These two colors are the default for other, more specific color variables. You don’t need to change anything in your existing custom color stylesheets as those variables get reasonable default values.</p>
<p><strong>Breaking</strong>: If you had previously overwritten the <code>custom-footer.html</code> partial to add visual elements below the content of your page, you have to move this content to the new partial <code>content-footer.html</code>. <code>custom-footer.html</code> was never meant to contain HTML other than additional styles and JavaScript.</p>
<p><strong>New</strong>: If you prefer expandable/collapsible menu items, you can now set <code>collapsibleMenu=true</code> in your <code>config.toml</code>. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.</p>
<p><strong>New</strong>: You can activate <ahref="/hugo-theme-relearn/basics/configuration/#activate-print-support">print support</a> in your <code>config.toml</code> to add the capability to print whole chapters or even the complete site.</p>
<p><strong>New</strong>: Introduction of new CSS variables to set the font. The theme distinguishs between <code>--MAIN-font</code> for all content text and <code>--CODE-font</code> for inline or block code. There are additional overrides for all headings. See the <ahref="/hugo-theme-relearn/basics/generator/">theme variant generator</a> of the exampleSite for all available variables.</p>
</li>
<li>
<p><strong>New</strong>: The new shortcode <code>swagger</code> is available to include a UI for REST OpenAPI Specifications. See the <ahref="/hugo-theme-relearn/shortcodes/swagger/">documentation</a> for available features. This feature will not work with Internet Explorer 11.</p>
</li>
</ul>
<hr>
<h2id="320">3.2.0</h2>
<ul>
<li>
<p><strong>Change</strong>: In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Mermaid codefences. This changes the behavior of <code>disableMermaid</code> config option as follows: If a Mermaid shortcode or codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.</p>
<p>The option is still useful in case you are using scripting to set up your graph. In this case no shortcode or codefence is involved and the library is not loaded by default. In this case you can set <code>disableMermaid=false</code> in your frontmatter to force the library to be loaded. See the <ahref="/hugo-theme-relearn/basics/generator/">theme variant generator</a> of the exampleSite for an example.</p>
<p><strong>This change requires at least Hugo 0.93.0 to be used</strong>. The minimum requirement will be reported during build on the console if not met.</p>
</li>
<li>
<p><strong>New</strong>: Additional color variant variable <code>--MERMAID-theme</code> to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant.</p>
</li>
</ul>
<hr>
<h2id="310">3.1.0</h2>
<ul>
<li><strong>New</strong>: <ahref="/hugo-theme-relearn/shortcodes/attachments/"><code>attachment</code></a> and <ahref="/hugo-theme-relearn/shortcodes/notice/"><code>notice</code></a> shortcodes have a new parameter to override the default icon. Allowed values are all <ahref="https://fontawesome.com/v5/search?m=free">Font Awesome 5 Free</a> icons.</li>
</ul>
<hr>
<h2id="300">3.0.0</h2>
<ul>
<li>
<p><strong>Breaking</strong>: We made changes to the menu footer. If you have your <code>menu-footer.html</code><ahref="/hugo-theme-relearn/basics/customization/">partial overridden</a>, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the <code>menu-footer.html</code> partial that is coming with the exampleSite.</p>
<p>This change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and <em>Clear history</em> functionality).</p>
</li>
<li>
<p><strong>Breaking</strong>: We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.</p>
<p>This change will only affect your installation if you’ve not set the <code>themeVariant</code> parameter in your <code>config.toml</code>. <ahref="/hugo-theme-relearn/basics/customization/#theme-variant">If you still want to use the Learn color variant</a>, you have to explicitly set <code>themeVariant="learn"</code> in your <code>config.toml</code>.</p>
<p>Note, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.</p>
<p><strong>Change</strong>: Due to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove <code>--MENU-SEARCH-BOX-ICONS-color</code> and introduced <code>--MENU-SEARCH-color</code> instead. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</p>
<p><strong>Change</strong>: For consistency reasons, we renamed <code>--MENU-SEARCH-BOX-color</code> to <code>--MENU-SEARCH-BORDER-color</code>. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</p>
</li>
<li>
<p><strong>New</strong>: With this release you are now capable to define your own <em>dark mode</em> variants.</p>
<p>To make this possible, we have introduced a lot more color variables you can use in <ahref="/hugo-theme-relearn/basics/customization/#theme-variant">your color variants</a>. Your old variants will still work and don’t need to be changed as apropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.</p>
<p>To see what’s now possible, see the new variants <code>relearn-dark</code> and <code>neon</code> that are coming with this release.</p>
</li>
<li>
<p><strong>New</strong>: To make the creation of new variants easier for you, we’ve added a new interactive <ahref="/hugo-theme-relearn/basics/generator/">theme variant generator</a>. This feature will not work with Internet Explorer 11.</p>
</li>
<li>
<p><strong>New</strong>: You can now configure multiple color variants in your <code>config.toml</code>. In this case, the first variant is the default chosen on first view and a variant switch will be shown in the menu footer. See the <ahref="/hugo-theme-relearn/basics/customization/#multiple-variants">documentation</a> for configuration.</p>
<p>Note, that the new variant switch will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant switcher will not be displayed with Internet Explorer 11.</p>
</li>
</ul>
<hr>
<h2id="290">2.9.0</h2>
<ul>
<li>
<p><strong>Breaking</strong>: This release removes the themes implementation of <code>ref</code>/<code>relref</code> in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard complient and exchanging this theme in your project to some other theme will be effortless.</p>
<p>In a standard complient form you must not link to the <code>*.md</code> file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:</p>
<p>If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but <ahref="https://gohugo.io/content-management/cross-references/#link-to-another-language-version">Hugo got you covered</a> as well.</p>
<p>Also, the old themes implementation allowed refs to non-existing content. This will cause Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can <ahref="https://gohugo.io/content-management/cross-references/#link-to-another-language-version">reconfigure the error handling</a> of Hugos implementation.</p>
<p>In the best case your usage of the old implementation is already standard complient and you don’t need to change anything. You’ll notice this very easily once you’ve started <code>hugo server</code> after an upgrade and no errors are written to the console.</p>
<p>You may see errors on the console after the update in the form:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-sh"data-lang="sh"><spanclass="line"><spanclass="cl">ERROR 2021/11/19 22:29:10 <spanclass="o">[</span>en<spanclass="o">]</span> REF_NOT_FOUND: Ref <spanclass="s2">"basics/configuration/_index.md"</span>: <spanclass="s2">"hugo-theme-relearn\exampleSite\content\_index.en.md:19:22"</span>: page not found
</span></span></code></pre></div><p>In this case, you must apply one of two options:</p>
<ol>
<li>
<p>Copy the old implementation files <code>theme/hugo-theme-relearn/layouts/shortcode/ref.html</code> and <code>theme/hugo-theme-relearn/layouts/shortcode/relref.html</code> to your own projects <code>layouts/shortcode/ref.html</code> and <code>layouts/shortcode/relref.html</code> respectively. <strong>This is not recommended</strong> as your project will still rely on non-standard behavior afterwards.</p>
</li>
<li>
<p>Start up a text editor with regular expression support for search and replace. Apply the following conversions in the given order on all <code>*.md</code> files. <strong>This is the recommended choice</strong>.</p>
<p><strong>Change</strong>: Although never officially documented, this release removes the font <code>Novacento</code>/<code>Novecento</code>. If you use it in an overwritten CSS please replace it with <code>Work Sans</code>. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for czech.</p>
</li>
<li>
<p><strong>New</strong>: The theme now supports favicons served from <code>static/images/</code> named as <code>favicon</code> or <code>logo</code> in SVG, PNG or ICO format <ahref="/hugo-theme-relearn/basics/customization/#change-the-favicon">out of the box</a>. An overridden partial <code>layouts/partials/favicon.html</code> may not be necessary anymore in most cases.</p>
</li>
<li>
<p><strong>New</strong>: You can hide the table of contents menu for the whole site by setting the <code>disableToc</code> option in your <code>config.toml</code>. For an example see <ahref="/hugo-theme-relearn/basics/configuration/#global-site-parameters">the example configuration</a>.</p>
</li>
</ul>
<hr>
<h2id="270">2.7.0</h2>
<ul>
<li><strong>New</strong>: Optional second parameter for <ahref="/hugo-theme-relearn/shortcodes/notice/"><code>notice</code></a> shortcode to set title in box header.</li>
</ul>
<hr>
<h2id="260">2.6.0</h2>
<ul>
<li><strong>New</strong>: Your site can now be served from a subfolder if you set <code>baseURL</code> and <code>canonifyURLs=true</code> in your <code>config.toml</code>. See the <ahref="/hugo-theme-relearn/basics/configuration/#a-word-on-running-your-site-in-a-subfolder">documentation</a> for a detailed example.</li>
</ul>
<hr>
<h2id="250">2.5.0</h2>
<ul>
<li><strong>Change</strong>: New colors <code>--CODE-BLOCK-color</code> and <code>--CODE-BLOCK-BG-color</code> were added to provide a fallback for Hugos syntax highlightning in case <code>guessSyntax=true</code> is set. Ideally the colors are set to the same values as the ones from your chosen chroma style.</li>
</ul>
<hr>
<h2id="240">2.4.0</h2>
<ul>
<li>
<p><strong>Change</strong>: Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included.</p>
</li>
<li>
<p><strong>New</strong>: Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting <code>disableTagHiddenPages=true</code> in your <code>config.toml</code>.</p>
</li>
<li>
<p><strong>New</strong>: You can define the expansion state of your menus for the whole site by setting the <code>alwaysopen</code> option in your <code>config.toml</code>. Please see further <ahref="/hugo-theme-relearn/cont/pages/#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and default behavior.</p>
</li>
<li>
<p><strong>New</strong>: New frontmatter <code>ordersectionsby</code> option to change immediate children sorting in menu and <code>children</code> shortcode. Possible values are <code>title</code> or <code>weight</code>.</p>
</li>
<li>
<p><strong>New</strong>: Alternate content of a page is now advertised in the HTML meta tags. See <ahref="https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head">Hugo documentation</a>.</p>
<li><strong>New</strong>: Showcase multilanguage features by provding a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Pirates one due to maintenance constraints.</li>
<li><strong>New</strong>: Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting <code>disableSeoHiddenPages=true</code> in your <code>config.toml</code>.</li>
</ul>
<hr>
<h2id="210">2.1.0</h2>
<ul>
<li>
<p><strong>Change</strong>: In case the site’s structure contains addional *.md files not part of the site (eg files that are meant to be included by site pages - see <code>CHANGELOG.md</code> in the exampleSite), they will now be ignored by the search.</p>
</li>
<li>
<p><strong>New</strong>: Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting <code>disableSearchHiddenPages=true</code> in your <code>config.toml</code>.</p>
</li>
<li>
<p><strong>New</strong>: If a search term is found in an <code>expand</code> shortcode, the expand will be opened.</p>
</li>
<li>
<p><strong>New</strong>: The menu will scroll the active item into view on load.</p>
</li>
</ul>
<hr>
<h2id="200">2.0.0</h2>
<ul>
<li>
<p><strong>Change</strong>: Syntaxhighlightning was switched to the <ahref="https://gohugo.io/content-management/syntax-highlighting/">built in Hugo mechanism</a>. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation</p>
</li>
<li>
<p><strong>Change</strong>: In the predefined stylesheets there was a typo and <code>--MENU-HOME-LINK-HOVERED-color</code> must be changed to <code>--MENU-HOME-LINK-HOVER-color</code>. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</p>
</li>
<li>
<p><strong>Change</strong>: <code>--MENU-HOME-LINK-color</code> and <code>--MENU-HOME-LINK-HOVER-color</code> were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.</p>
</li>
<li>
<p><strong>Change</strong>: Arrow navigation and <code>children</code> shortcode were ignoring setting for <code>ordersectionsby</code>. This is now changed and may result in different sorting order of your sub pages.</p>
</li>
<li>
<p><strong>Change</strong>: If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.</p>
</li>
<li>
<p><strong>Change</strong>: A page without a <code>title</code> will be treated as <code>hidden=true</code>.</p>
</li>
<li>
<p><strong>New</strong>: You can define the expansion state of your menus in the frontmatter. Please see further <ahref="/hugo-theme-relearn/cont/pages/#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and default behavior.</p>
</li>
<li>
<p><strong>New</strong>: New partials for defining pre/post content for menu items and the content. See <ahref="/hugo-theme-relearn/basics/customization/">documentation</a> for further reading.</p>
</li>
<li>
<p><strong>New</strong>: Shortcode <ahref="/hugo-theme-relearn/shortcodes/children/"><code>children</code></a> with new parameter <code>containerstyle</code>.</p>
</li>
<li>
<p><strong>New</strong>: New shortcode <ahref="/hugo-theme-relearn/shortcodes/include/"><code>include</code></a> to include arbitrary file content into a page.</p>
</li>
</ul>
<hr>
<h2id="120">1.2.0</h2>
<ul>
<li><strong>New</strong>: Shortcode <ahref="/hugo-theme-relearn/shortcodes/expand/"><code>expand</code></a> with new parameter to open on page load.</li>
</ul>
<hr>
<h2id="110">1.1.0</h2>
<ul>
<li><strong>New</strong>: <ahref="/hugo-theme-relearn/shortcodes/mermaid/#configuration"><code>Mermaid</code></a> config options can be set in <code>config.toml</code>.</li>
<li><strong>New</strong>: Initial fork of the <ahref="https://github.com/matcornic/hugo-theme-learn">Learn theme</a> based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to <code>Relearn</code> and a new logo. For the reasons behind forking the Learn theme, see <ahref="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495">this comment</a> in the Learn issues.</li>
<p>Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.</p>
<p>Just download latest version of <ahref="https://gohugo.io/getting-started/installing/">Hugo binary</a> for your OS (Windows, Linux, Mac) : it’s that simple.</p>
<p>The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this <ahref="https://gohugo.io/overview/quickstart/">great documentation for beginners</a>.</p>
<h2id="create-your-project">Create your project</h2>
<p>Hugo provides a <code>new</code> command to create a new website.</p>
<pretabindex="0"><code>hugo new site <new_project>
</code></pre><h2id="install-the-theme">Install the theme</h2>
<p>Install the Relearn theme by following <ahref="https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme">this documentation</a></p>
<p>This theme’s repository is: <ahref="https://github.com/McShelby/hugo-theme-relearn.git">https://github.com/McShelby/hugo-theme-relearn.git</a></p>
<p>Alternatively, you can <ahref="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip">download the theme as .zip</a> file and extract it in the <code>themes</code> directory</p>
<p>When building the website, you can set a theme by using <code>--theme</code> option. However, we suggest you modify the configuration file (<code>config.toml</code>) and set the theme as the default. You can also add the <code>[outputs]</code> section to enable the search functionality.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># Change the default theme to be use when building the site with Hugo</span>
</span></span></code></pre></div><h2id="create-your-first-chapter-page">Create your first chapter page</h2>
<p>Chapters are pages that contain other child pages. It has a special layout style and usually just contains a <em>chapter name</em>, the <em>title</em> and a <em>brief abstract</em> of the section.</p>
<p>The Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind chapter basics/_index.md
</span></span></code></pre></div><p>By opening the given file, you should see the property <code>chapter=true</code> on top, meaning this page is a <em>chapter</em>.</p>
<p>By default all chapters and pages are created as a draft. If you want to render these pages, remove the property <code>draft: true</code> from the metadata.</p>
<h2id="create-your-first-content-pages">Create your first content pages</h2>
<p>Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new basics/first-content.md
</span></span><spanclass="line"><spanclass="cl">hugo new basics/second-content/_index.md
</span></span></code></pre></div><p>Feel free to edit those files by adding some sample content and replacing the <code>title</code> value in the beginning of the files.</p>
<h2id="launching-the-website-locally">Launching the website locally</h2>
</span></span></code></pre></div><p>Go to <code>http://localhost:1313</code></p>
<p>You should notice three things:</p>
<ol>
<li>You have a left-side <strong>Basics</strong> menu, containing two submenus with names equal to the <code>title</code> properties in the previously created files.</li>
<li>The home page explains how to customize it by following the instructions.</li>
<li>When you run <code>hugo serve</code>, when the contents of the files change, the page automatically refreshes with the changes. Neat!</li>
</ol>
<h2id="build-the-website">Build the website</h2>
<p>When your site is ready to deploy, run the following command:</p>
</span></span></code></pre></div><p>A <code>public</code> folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.</p>
<p>This website can be automatically published and hosted with <ahref="https://www.netlify.com/">Netlify</a> (Read more about <ahref="https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/">Automated HUGO deployments with Netlify</a>). Alternatively, you can use <ahref="https://gohugo.io/hosting-and-deployment/hosting-on-github/">GitHub pages</a></p>
</div>
</div>
<footerclass="footline">
</footer>
</article>
<article>
<h1>Configuration</h1>
<h2id="global-site-parameters">Global site parameters</h2>
<p>On top of <ahref="https://gohugo.io/overview/configuration/">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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># This controls whether submenus will be expanded (true), or collapsed (false) in the</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># menu; if no setting is given, the first menu level is set to false, all others to true;</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># this can be overridden in the pages frontmatter</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Prefix URL to edit current page. Will display an "Edit" button on top right hand corner of every page.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Useful to give opportunity to people to create merge request for your doc.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># See the config.toml file from this documentation site to have an example.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Javascript and CSS cache are automatically busted when new version of site is generated.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Set this to true to disable this behavior (some proxies don't handle well this optimization)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># A title for shortcuts in menu is set by default. Set this to true to disable it.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to false, a Home button will appear below the search bar on the menu.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># It is redirecting to the landing page of the current language if specified. (Default is "/")</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to false, load the Swagger module on every page regardless if a Swagger shortcode is present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Hide Next and Previous page buttons normally displayed full height beside content</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Order sections in menu by "weight" or "title". Default to "weight";</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># this can be overridden in the pages frontmatter</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Change default color scheme with a variant one. Eg. can be "red", "blue", "green" or an array like [ "blue", "green" ].</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to true, the menu in the sidebar will be displayed in a collapsible tree view.</span>
</span></span></code></pre></div><h2id="a-word-on-running-your-site-in-a-subfolder">A word on running your site in a subfolder</h2>
<p>The theme runs best if your site is installed in the root of your webserver. 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>
</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 <ahref="https://github.com/gohugoio/hugo/issues/5226">https://github.com/gohugoio/hugo/issues/5226</a>.</p>
<h2id="activate-search">Activate search</h2>
<p>If not already present, add the follow lines in the same <code>config.toml</code> file.</p>
</span></span></code></pre></div><p>Relearn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.</p>
<blockquote>
<p>Hugo generate lunrjs index.json at the root of public folder.
When you build the site with <code>hugo server</code>, hugo generates it internally and of course it doesn’t show up in the filesystem</p>
<p>You can activate print support to add the capability to print whole chapters or even the complete site. Just add the <code>PRINT</code> output format to your home, section and page in your <code>config.toml</code> as seen below:</p>
</span></span></code></pre></div><p>This will add a little printer icon in the top bar. It will switch the page to print preview when clicked. You can then send this page to the printer by using your browser’s usual print functionality.</p>
<p>While colors of your chosen color variant are reset to the theme’s light standard values for printing, this does not apply for Mermaid diagrams and Swagger/OpenAPI Specification. Those will still use the colors of your chosen color variant which may cause a non coherent look on paper.</p>
</div>
</div>
<h2id="mermaid">Mermaid</h2>
<p>The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See <ahref="/hugo-theme-relearn/shortcodes/mermaid/">Mermaid</a> for additional documentation.</p>
<blockquote>
<p>Example:</p>
<p>Mermaid is globally disabled. By default it won’t be loaded by any page.
On page “Architecture” you need a class diagram. You can set the Mermaid parameters locally to only load mermaid on this page (not on the others).</p>
</blockquote>
<p>You also can disable Mermaid for specific pages while globally enabled.</p>
</span></span></code></pre></div><p>The home button is going to look like this:</p>
<p><imgsrc="/hugo-theme-relearn/basics/configuration/images/home_button_defaults.png?classes=shadow&width=300px"alt="Default Home Button"></p>
<footerclass="footline">
</footer>
</article>
<article>
<h1>Customization</h1>
<p>The Relearn theme has been built to be as configurable as possible by defining multiple <ahref="https://gohugo.io/templates/partials/">partials</a></p>
<p>In <code>themes/hugo-theme-relearn/layouts/partials/</code>, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead <ahref="https://gohugo.io/themes/customizing/">follow this page</a>. You’d create a new partial in the <code>layouts/partials</code> folder of your local project. This partial will have the priority.</p>
<p>This theme defines the following partials :</p>
<ul>
<li><code>header.html</code>: the header of the page. <em>Not meant to be overwritten</em></li>
<li><code>footer.html</code>: the footer of the page.<em>Not meant to be overwritten</em></li>
<li><code>menu.html</code>: left menu. <em>Not meant to be overwritten</em></li>
<li><code>search.html</code>: search box. <em>Not meant to be overwritten</em></li>
<li><code>custom-header.html</code>: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include <code>style</code> HTML tag directive in your file.</li>
<li><code>custom-footer.html</code>: custom footer in page. Meant to be overwritten when adding Javacript. Don’t forget to include <code>javascript</code> HTML tag directive in your file.</li>
<li><code>favicon.html</code>: the favicon</li>
<li><code>logo.html</code>: the logo, on top left hand corner</li>
<li><code>meta.html</code>: HTML meta tags, if you want to change default behavior</li>
<li><code>menu-pre.html</code>: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page’s <code>pre</code> setting into account.</li>
<li><code>menu-post.html</code>: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page’s <code>post</code> setting into account.</li>
<li><code>menu-footer.html</code>: footer of the the left menu</li>
<li><code>toc.html</code>: table of contents</li>
<li><code>content.html</code>: the content page itself. This can be overridden if you wan’t to display page’s meta data above or below the content.</li>
<li><code>content-footer</code>: footer below the content, has a default implementation but you can overwrite it if you don’t like it.</li>
</ul>
<h2id="change-the-logo">Change the logo</h2>
<p>Create a new file in <code>layouts/partials/</code> named <code>logo.html</code>. Then write any HTML you want.
You could use an <code>img</code> HTML tag and reference an image created under the <em>static</em> folder, or you could paste a SVG definition!</p>
<p>The size of the logo will adapt automatically</p>
</div>
</div>
<h2id="change-the-favicon">Change the favicon</h2>
<p>If your favicon is a SVG, PNG or ICO, just drop off your image in your local <code>static/images/</code> folder and name it <code>favicon.svg</code>, <code>favicon.png</code> or <code>favicon.ico</code> respectivly.</p>
<p>If no favicon file is found, the theme will lookup the alternative filename <code>logo</code> in the same location and will repeat the search for the list of supported file types.</p>
<p>If you need to change this default behavior, create a new file in <code>layouts/partials/</code> named <code>favicon.html</code>. Then write something like this:</p>
</span></span></code></pre></div><p>In the above exaple your theme file has to be named <code>theme-relearn-light.css</code></p>
<h3id="multiple-variants">Multiple variants</h3>
<p>You can also set multiple variants. In this case, the first variant is the default choosen on first view and a variant switch will be shown in the menu footer.</p>
<p>If you want to switch the syntax highlightning theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation <ahref="https://gohugo.io/content-management/syntax-highlighting/">according to Hugo’s documentation</a>, and <code>@import</code> this stylesheet in your color variant stylesheet. For an example, take a look into <code>theme-relearn-light.css</code> and <code>config.toml</code> of the exampleSite.</p>
</div>
</div>
<h3id="roll-your-own">Roll your own</h3>
<p>If you are not happy with the shipped variants you can either copy one of the shipped files, edit them in a text editor and configure the <code>themeVariant</code> parameter in your <code>config.toml</code> or just use the <ahref="/hugo-theme-relearn/basics/generator/">interactive variant generator</a>.</p>
<footerclass="footline">
</footer>
</article>
<article>
<h1>Stylesheet generator</h1>
<p>This interactive tool may help you to generate your own color variant stylesheet.</p>
<p>To get started, first select a color variant from the variant switch that fits you best as a starting point.</p>
<p>The graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly.</p>
<p>The arrowed lines reflects how colors are inherited thru different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.</p>
<p>To better understand this select the <code>neon</code> variant and modify the differnet heading colors. There, colors for the heading <code>h2</code>, <code>h3</code> and <code>h4</code> are explicitly set. <code>h5</code> is not set and inherits its value from <code>h4</code>. <code>h6</code> is also not set and inherits its value from <code>h5</code>.</p>
<p>Once you’ve changed a color, the variant switch will show a “My custom variant” entry and your changes are stored in the browser. You can change pages and even close the browser without losing your changes.</p>
<p>Once you are satisfied, you can download the new variants file and install it in your site.</p>
<li>[<strong>feature</strong>] shortcodes: add named parameter if missing <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/260">#260</a></li>
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: remove –MAIN-ANCHOR-color from stylesheet <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/256">#256</a></li>
<li>[<strong>feature</strong>] i18n: add italian translation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/254">#254</a></li>
<li>[<strong>feature</strong>] attachments: support for brand colors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/252">#252</a></li>
<li>[<strong>feature</strong>] notice: support for brand colors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/251">#251</a></li>
<li>[<strong>feature</strong>] theme: use proper file extension for page-meta.go <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/246">#246</a></li>
<li>[<strong>feature</strong>] variant: add support for brand color variables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/239">#239</a></li>
<li>[<strong>bug</strong>] shortcodes: accept boolean parameters if given as string <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/261">#261</a></li>
<li>[<strong>bug</strong>] print: adjust button and tab size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/259">#259</a></li>
<li>[<strong>bug</strong>] print: show Mermaid if requested in frontmatter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/255">#255</a></li>
<li>[<strong>bug</strong>] Scrollbar slider is too thin <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/244">#244</a></li>
<li>[<strong>bug</strong>] Scrollbar broken on mobile <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/243">#243</a></li>
<li>[<strong>bug</strong>] theme: let browser scroll page on CTRL+f <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/242">#242</a></li>
<li>[<strong>bug</strong>] theme: fix display of tooltip for heading anchor <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/241">#241</a></li>
<li>[<strong>feature</strong>] i18n: add traditional chinese translation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/233">#233</a></li>
<li>[<strong>feature</strong>] menu: expand/collapse menu items without navigation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/231">#231</a></li>
<li>[<strong>feature</strong>] theme: add CSS font variables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/227">#227</a></li>
<li>[<strong>feature</strong>] swagger: add support for oas/swagger documentation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/226">#226</a></li>
<li>[<strong>bug</strong>] variant: make variant switch work on slow networks <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/228">#228</a></li>
<li>[<strong>bug</strong>] print: fix minor inconsistencies <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/225">#225</a></li>
<li>[<strong>bug</strong>] print: show more than just the title page <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/224">#224</a></li>
<li>[<strong>bug</strong>] theme: align content scrollbar to the right on big screens <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/223">#223</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] mermaid: support differing themes for color variant switch <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/219">#219</a></li>
<li>[<strong>bug</strong>] theme: make storage of multiple Hugo sites on same server distinct <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/214">#214</a></li>
<li>[<strong>bug</strong>] variant: switch breadcrumb color in Chrome <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/213">#213</a></li>
<li>[<strong>bug</strong>] mobile: improve behavior of sidebar menu <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/210">#210</a></li>
<li>[<strong>bug</strong>] variant: fix occasional fail when resetting generator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/208">#208</a></li>
<li>[<strong>bug</strong>] docs: don’t move header on logo hover in IE11 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/207">#207</a></li>
<li>[<strong>bug</strong>] variant: avoid flash of menu header when non default variant is active <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/206">#206</a></li>
<li>[<strong>bug</strong>] theme: fix wrong HTML closing tag order in chapters <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/205">#205</a></li>
<li>[<strong>bug</strong>] theme: adjust breadcrumb and title for empty home page titles <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/202">#202</a></li>
<li>[<strong>bug</strong>] theme: remove Hugo build warning if page is not file based <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/197">#197</a></li>
<li>[<strong>bug</strong>] tags: adhere to titleSeparator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/196">#196</a></li>
<li>[<strong>bug</strong>] theme: hide footer divider and variant selector in IE11 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/194">#194</a></li>
<li>[<strong>feature</strong>] children: set containerstyle automatically according to style <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/192">#192</a></li>
<li>[<strong>bug</strong>] theme: revert fontawsome to version 5 for IE11 compat <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/191">#191</a></li>
<li>[<strong>feature</strong>] variant: build a variant generator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/188">#188</a></li>
<li>[<strong>feature</strong>] nav: only show toc if the page has headings <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/182">#182</a></li>
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: change default colors to Relearn defaults <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/181">#181</a></li>
<li>[<strong>feature</strong>] variant: add a variant selector <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/178">#178</a></li>
<li>[<strong>bug</strong>] search: remove additional X in filled out search box in IE11 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/190">#190</a></li>
<li>[<strong>bug</strong>][<strong>change</strong>] search: fix color change for icons on hover <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/176">#176</a></li>
<li>[<strong>bug</strong>] exampleSite: fix links in official documentation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/168">#168</a></li>
<li>[<strong>bug</strong>] menu: invalid URL when the shortcut is an internal link <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/163">#163</a></li>
<li>[<strong>bug</strong>] theme: fix selection of *.ico files as favicons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/160">#160</a></li>
<li>[<strong>bug</strong>] menu: fix significantly low performance for collecting of meta info <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/157">#157</a></li>
<li>[<strong>bug</strong>] search: make dropdown stick to search field when scrolling <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/155">#155</a></li>
<li>[<strong>bug</strong>] menu: align long text properly <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/154">#154</a></li>
<li>[<strong>bug</strong>] copyToClipBoard: add missing right border for inline code if <code>disableInlineCopyToClipBoard=true</code><ahref="https://github.com/McShelby/hugo-theme-relearn/issues/153">#153</a></li>
<li>[<strong>bug</strong>] menu: show hidden sibling pages reliably <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/152">#152</a></li>
<li>[<strong>bug</strong>] menu: bring active item in sight for large menus <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/149">#149</a></li>
<li>[<strong>bug</strong>] mermaid: always load javascript to avoid break if code fences are used <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/142">#142</a></li>
<li>[<strong>bug</strong>] search: don’t break JS in multilang setup if search is disabled <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/140">#140</a></li>
<li>[<strong>feature</strong>] toc: make disableTOC globally available via config.toml <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/133">#133</a></li>
<li>[<strong>feature</strong>] mermaid: only load javascript if necessary <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/95">#95</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: switch font <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/83">#83</a></li>
<li>[<strong>feature</strong>] theme: make favicon configurable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/2">#2</a></li>
<li>[<strong>bug</strong>] mermaid: assert that window.mermaid is actually mermaid <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/136">#136</a></li>
<li>[<strong>bug</strong>] menu: remove usage of Hugos UniqueID <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/131">#131</a></li>
<li>[<strong>bug</strong>] theme: reduce margin for children shortcode <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/130">#130</a></li>
<li>[<strong>bug</strong>] theme: left-align h3 in chapters <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/129">#129</a></li>
<li>[<strong>bug</strong>] theme: align copy link to clipboard <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/128">#128</a></li>
<li>[<strong>bug</strong>] theme: generate correct links if theme served from subdirectory <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/120">#120</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] syntax highlight: provide default colors for unknown languages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/113">#113</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: simplify stylesheet for color variants <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/107">#107</a></li>
<li>[<strong>feature</strong>] theme: announce alternative content in header <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/101">#101</a></li>
<li>[<strong>feature</strong>] menu: frontmatter option to change sort predicate <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/98">#98</a></li>
<li>[<strong>feature</strong>] menu: add default setting for menu expansion <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/97">#97</a></li>
<li>[<strong>bug</strong>] include: don’t generate additional HTML if file should be displayed “as is”<ahref="https://github.com/McShelby/hugo-theme-relearn/issues/110">#110</a></li>
<li>[<strong>bug</strong>] attachments: fix broken links if multilang config is used <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/105">#105</a></li>
<li>[<strong>bug</strong>] theme: fix sticky header to remove horizontal scrollbar <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/82">#82</a></li>
<li>[<strong>bug</strong>] docs: rename english pirate translation to avoid crash on rendering <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/90">#90</a></li>
<li>[<strong>feature</strong>] sitemap: hide hidden pages from sitemap and SEO indexing <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/85">#85</a></li>
<li>[<strong>bug</strong>] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/86">#86</a></li>
</ul>
<h3id="maintenance-3">Maintenance</h3>
<ul>
<li>[<strong>task</strong>] theme: switch from data-vocabulary to schema <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/84">#84</a></li>
<li>[<strong>feature</strong>] search: open expand if it contains search term <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/80">#80</a></li>
<li>[<strong>feature</strong>] menu: scroll active item into view <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/79">#79</a></li>
<li>[<strong>feature</strong>] search: disable search in hidden pages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/76">#76</a></li>
<li>[<strong>feature</strong>] search: improve readablility of index.json <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/75">#75</a></li>
<li>[<strong>feature</strong>] menu: show hidden pages if accessed directly <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/60">#60</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: treat pages without title as hidden <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/59">#59</a></li>
<li>[<strong>feature</strong>] search: show search results if field gains focus <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/58">#58</a></li>
<li>[<strong>feature</strong>] theme: add partial templates for pre/post menu entries <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/56">#56</a></li>
<li>[<strong>feature</strong>] theme: make chapter archetype more readable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/55">#55</a></li>
<li>[<strong>feature</strong>] children: add parameter for container style <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/53">#53</a></li>
<li>[<strong>feature</strong>] theme: make content a template <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/50">#50</a></li>
<li>[<strong>feature</strong>] menu: control menu expansion with alwaysopen parameter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/49">#49</a></li>
<li>[<strong>feature</strong>] include: new shortcode to include other files <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/43">#43</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] code highligher: switch to standard hugo highlighter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/32">#32</a></li>
<li>[<strong>bug</strong>] theme: remove superflous singular taxonomy from taxonomy title <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/46">#46</a></li>
<li>[<strong>bug</strong>][<strong>change</strong>] theme: missing –MENU-HOME-LINK-HOVER-color in documentation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/45">#45</a></li>
<li>[<strong>bug</strong>] theme: fix home link when base URL has some path <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/44">#44</a></li>
</ul>
<h3id="maintenance-4">Maintenance</h3>
<ul>
<li>[<strong>task</strong>] docs: include changelog in exampleSite <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/33">#33</a></li>
<li>[<strong>feature</strong>] attachments: adjust style between notice boxes and attachments <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/28">#28</a></li>
<li>[<strong>feature</strong>] notice: make restyling of notice boxes more robust <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/20">#20</a></li>
<li>[<strong>feature</strong>] notice: align box colors to common standards <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/18">#18</a></li>
<li>[<strong>feature</strong>] notice: use distinct icons for notice box type <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/17">#17</a></li>
<li>[<strong>bug</strong>] attachments: support i18n for attachment size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/21">#21</a></li>
<li>[<strong>bug</strong>] notice: support i18n for box labels <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/16">#16</a></li>
<li>[<strong>bug</strong>] notice: support multiple blocks in one box <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/15">#15</a></li>
</ul>
<h3id="maintenance-5">Maintenance</h3>
<ul>
<li>[<strong>task</strong>] dependency: upgrade jquery to 3.6.0 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/30">#30</a></li>
</ul>
<hr>
<h2id="111-2021-07-04">1.1.1 (2021-07-04)</h2>
<h3id="maintenance-6">Maintenance</h3>
<ul>
<li>[<strong>task</strong>] theme: prepare for new hugo theme registration <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/13">#13</a></li>
<li>[<strong>bug</strong>] mermaid: config option for CDN url not used <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/12">#12</a></li>
<li>[<strong>bug</strong>] mermaid: only highlight text in HTML elements <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/10">#10</a></li>
<li>[<strong>bug</strong>] mermaid: support pan & zoom for graphs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/9">#9</a></li>
<li>[<strong>bug</strong>] mermaid: code fences not always rendered <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/6">#6</a></li>
<li>[<strong>bug</strong>] mermaid: search term on load may bomb chart <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/5">#5</a></li>
</ul>
<h3id="maintenance-7">Maintenance</h3>
<ul>
<li>[<strong>task</strong>] mermaid: update to 8.10.2 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/7">#7</a></li>
</ul>
<hr>
<h2id="101-2021-07-01">1.0.1 (2021-07-01)</h2>
<h3id="maintenance-8">Maintenance</h3>
<ul>
<li>[<strong>task</strong>] Prepare for hugo showcase <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/3">#3</a></li>
<p>Find out how to create and organize your content quickly and intuitively.</p>
<footerclass="footline">
</footer>
</article>
<section>
<article>
<h1>Pages organization</h1>
<p>In <strong>Hugo</strong>, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.</p>
<h2id="folders">Folders</h2>
<p>Organize your site like <ahref="https://gohugo.io/content/organization/">any other Hugo project</a>. Typically, you will have a <em>content</em> folder with all your pages.</p>
<p><code>_index.md</code> is required in each folder, it’s your “folder home page”</p>
</div>
</div>
<h2id="types">Types</h2>
<p>The Relearn theme defines two types of pages. <em>Default</em> and <em>Chapter</em>. Both can be used at any level of the documentation, the only difference being layout display.</p>
<h3id="chapter-style">Chapter</h3>
<p>A <strong>Chapter</strong> displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found under it.</p>
<p>You can define any HTML as prefix for the menu. In the example below, it’s just a number but that could be an <ahref="https://fortawesome.github.io/Font-Awesome/">icon</a>.</p>
</span></span><spanclass="line"><spanclass="cl">Discover what this Hugo theme is all about and the core-concepts behind it.
</span></span></code></pre></div><p>To tell the Relearn theme to consider a page as a chapter, set <code>chapter=true</code> in the Front Matter of the page.</p>
<h3id="default">Default</h3>
<p>A <strong>Default</strong> page is any other content page.</p>
</span></span></code></pre></div><p>The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you to train by following this <ahref="https://gohugo.io/overview/quickstart/">great documentation for beginners</a>.</p>
<h2id="create-your-project">Create your project</h2>
<p>Hugo provides a <code>new</code> command to create a new website.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new site <new_project>
</span></span></code></pre></div><p>The Relearn theme provides <ahref="/hugo-theme-relearn/cont/archetypes/">archetypes</a> to help you create this kind of pages.</p>
<p>Each Hugo page has to define a <ahref="https://gohugo.io/content/front-matter/">Front Matter</a> in <em>toml</em>, <em>yaml</em> or <em>json</em>. This site will use <em>toml</em> in all cases.</p>
<p>The Relearn theme uses the following parameters on top of Hugo ones :</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Table of contents (toc) is enabled by default. Set this parameter to true to disable it.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Note: Toc is always disabled for chapter pages</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will be used for the page's menu entry (instead of the `title` attribute)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will explicitly override common rules for the expand state of a page's menu entry</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will explicitly override common rules for the sorting order of a page's submenu entries</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Display name of this page modifier. If set, it will be displayed in the footer.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer</span>
</span></span></code></pre></div><p><imgsrc="/hugo-theme-relearn/cont/pages/images/frontmatter-icon.png?classes=shadow&width=300px"alt="Title with icon"></p>
</span></span></code></pre></div><h3id="override-expand-state-rules-for-menu-entries">Override expand state rules for menu entries</h3>
<p>You can change how the theme expands menu entries on the side of the content with the <code>alwaysopen</code> setting on a per page basis. If <code>alwaysopen=false</code> for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.</p>
<p>The theme generates the menu based on the following rules:</p>
<ul>
<li>all parent entries of the active page including their siblings are shown regardless of any settings</li>
<li>immediate children entries of the active page are shown regardless of any settings</li>
<li>if not overridden, all other first level entries behave like they would have been given <code>alwaysopen=false</code></li>
<li>if not overridden, all other entries of levels besides the first behave like they would have been given <code>alwaysopen=true</code></li>
<li>all visible entries show their immediate children entries if <code>alwaysopen=true</code>; this proceeds recursivley</li>
<li>all remaining entries are not shown</li>
</ul>
<p>You can see this feature in action on the example page for <ahref="/hugo-theme-relearn/shortcodes/children/">children shortcode</a> and its children pages.</p>
<h2id="your-page">Your Page</h2>
<p>To configure your page, you basically have three choices:</p>
<ol>
<li>Create an <code>_index.md</code> document in <code>content</code> folder and fill the file with <em>Markdown content</em></li>
<li>Create an <code>index.html</code> file in the <code>static</code> folder and fill the file with <em>HTML content</em></li>
<li>Configure your server to automatically redirect home page to one your documentation page</li>
</ol>
<footerclass="footline">
</footer>
</article>
<article>
<h1>Archetypes</h1>
<p>Using the command: <code>hugo new [relative new content path]</code>, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: <ahref="https://gohugo.io/content/archetypes/">archetypes</a>.</p>
<p>It is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences.</p>
<h2id="archetypes-chapter">Chapter</h2>
<p>To create a Chapter page, run the following commands</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind chapter <name>/_index.md
</span></span></code></pre></div><p>It will create a page with predefined Front-Matter:</p>
<p>To create a default page, run either one of the following commands either</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new <chapter>/<name>/_index.md
</span></span></code></pre></div><p>or</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new <chapter>/<name>.md
</span></span></code></pre></div><p>It will create a page with predefined Front-Matter:</p>
<p>Let’s face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.</p>
<p><strong>Markdown</strong> is a better way to write <strong>HTML</strong>, without all the complexities and ugliness that usually accompanies it.</p>
<p>Some of the key benefits are:</p>
<ol>
<li>Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content.</li>
<li>Less chance of errors when writing in Markdown.</li>
<li>Produces valid XHTML output.</li>
<li>Keeps the content and the visual display separate, so you cannot mess up the look of your site.</li>
<li>Write in any text editor or Markdown application you like.</li>
<li>Markdown is a joy to use!</li>
</ol>
<p>John Gruber, the author of Markdown, puts it like this:</p>
<blockquote>
<p>The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
<cite>John Gruber</cite></p>
</blockquote>
<p>Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:</p>
<p><iclass="fas fa-bookmark"></i> Bookmark this page and the <ahref="https://commonmark.org/help/">official Commonmark reference</a> for easy future reference!</p>
</div>
</div>
<h2id="headings">Headings</h2>
<p>Headings from <code>h1</code> through <code>h6</code> are constructed with a <code>#</code> for each level:</p>
</span></span></code></pre></div><p>Comment below should <strong>NOT</strong> be seen:</p>
<!--
This is a comment
-->
<h2id="horizontal-rules">Horizontal Rules</h2>
<p>The HTML <code><hr></code> element is for creating a “thematic break” between paragraph-level elements. In Markdown, you can create a <code><hr></code> with <code>---</code> - three consecutive dashes</p>
<p>renders to:</p>
<hr>
<h2id="paragraphs">Paragraphs</h2>
<p>Any text not starting with a special sign is written as normal, plain text and will be wrapped within <code><p></p></code> tags in the rendered HTML.</p>
<p>So this body copy:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
</span></span></code></pre></div><p>renders to this HTML:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">p</span><spanclass="p">></span>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.<spanclass="p"></</span><spanclass="nt">p</span><spanclass="p">></span>
<p>For emphasizing a snippet of text with a heavier font-weight.</p>
<p>The following snippet of text is <strong>rendered as bold text</strong>.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">**rendered as bold text**
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">strong</span><spanclass="p">></span>rendered as bold text<spanclass="p"></</span><spanclass="nt">strong</span><spanclass="p">></span>
<p>For emphasizing a snippet of text with italics.</p>
<p>The following snippet of text is <em>rendered as italicized text</em>.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">_rendered as italicized text_
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">em</span><spanclass="p">></span>rendered as italicized text<spanclass="p"></</span><spanclass="nt">em</span><spanclass="p">></span>
<p>In GFM (GitHub flavored Markdown) you can do strikethroughs.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">~~Strike through this text.~~
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">del</span><spanclass="p">></span>Strike through this text.<spanclass="p"></</span><spanclass="nt">del</span><spanclass="p">></span>
<p>For quoting blocks of content from another source within your document.</p>
<p>Add <code>></code> before any text you want to quote.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">**Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
<p><strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">p</span><spanclass="p">><</span><spanclass="nt">strong</span><spanclass="p">></span>Fusion Drive<spanclass="p"></</span><spanclass="nt">strong</span><spanclass="p">></span> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.<spanclass="p"></</span><spanclass="nt">p</span><spanclass="p">></span>
</span></span></code></pre></div><p>Blockquotes can also be nested:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="k"></span><spanclass="ge">>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="k"></span><spanclass="ge">> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
<p>Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.</p>
<blockquote>
<p>Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.</p>
</blockquote>
<p>Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</p>
</blockquote>
<h2id="lists">Lists</h2>
<h3id="unordered">Unordered</h3>
<p>A list of items in which the order of the items does not explicitly matter.</p>
<p>You may use any of the following symbols to denote bullets for each list item:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">+ Lorem ipsum dolor sit amet
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Lorem ipsum dolor sit amet<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Integer molestie lorem at massa<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Facilisis in pretium nisl aliquet<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Purus sodales ultricies<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Faucibus porta lacus fringilla vel<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Aenean sit amet erat nunc<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
<p>A list of items in which the order of items does explicitly matter.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Lorem ipsum dolor sit amet
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Lorem ipsum dolor sit amet<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Integer molestie lorem at massa<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Facilisis in pretium nisl aliquet<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Faucibus porta lacus fringilla vel<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Aenean sit amet erat nunc<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
<p>If you just use <code>1.</code> for each number, Markdown will automatically number each item. For example:</p>
</div>
</div>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Lorem ipsum dolor sit amet
<p>Wrap inline snippets of code with <code>`</code>.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">In this example, <spanclass="sb">`<div></div>`</span> should be wrapped as <spanclass="gs">**code**</span>.
<p>In this example, <code><div></div></code> should be wrapped as <strong>code</strong>.</p>
<p>HTML:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">p</span><spanclass="p">></span>In this example, <spanclass="p"><</span><spanclass="nt">code</span><spanclass="p">></span><spanclass="ni">&lt;</span>div<spanclass="ni">&gt;&lt;</span>/div<spanclass="ni">&gt;</span><spanclass="p"></</span><spanclass="nt">code</span><spanclass="p">></span> should be wrapped as <spanclass="p"><</span><spanclass="nt">strong</span><spanclass="p">></span>code<spanclass="p"></</span><spanclass="nt">strong</span><spanclass="p">></span>.<spanclass="p"></</span><spanclass="nt">p</span><spanclass="p">></span>
<p>Or indent several lines of code by at least two spaces, as in:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"> // Some comments
</span></span><spanclass="line"><spanclass="cl"> line 1 of code
</span></span><spanclass="line"><spanclass="cl"> line 2 of code
</span></span><spanclass="line"><spanclass="cl"> line 3 of code
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">code</span><spanclass="p">></span>Sample text here...<spanclass="p"></</span><spanclass="nt">code</span><spanclass="p">></span>
<p>GFM, or “GitHub Flavored Markdown” also supports syntax highlighting. To activate it, usually you simply add the file extension of the language you want to use directly after the first code “fence”, <code>```js</code>, and syntax highlighting will automatically be applied in the rendered HTML.</p>
<p>See <ahref="/hugo-theme-relearn/cont/syntaxhighlight/">Code Highlighting</a> for additional documentation.</p>
<p>For example, to apply syntax highlighting to JavaScript code:</p>
<p>Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">td</span><spanclass="p">></span>path to data files to supply the data that will be passed into templates.<spanclass="p"></</span><spanclass="nt">td</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">td</span><spanclass="p">></span>engine to be used for processing templates. Handlebars is the default.<spanclass="p"></</span><spanclass="nt">td</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">td</span><spanclass="p">></span>extension to be used for dest files.<spanclass="p"></</span><spanclass="nt">td</span><spanclass="p">></span>
<p>Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="gh"># Table of Contents
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="gu"></span>Content for chapter one.
</span></span></code></pre></div><p><strong>NOTE</strong> that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.</p>
<h2id="images">Images</h2>
<p>Images have a similar syntax to links but include a preceding exclamation point.</p>
<p>The Hugo Markdown parser supports additional non-standard functionality.</p>
<h4id="resizing-image">Resizing image</h4>
<p>Add HTTP parameters <code>width</code> and/or <code>height</code> to the link image to resize the image. Values are CSS values (default is <code>auto</code>).</p>
<p>Add a HTTP <code>classes</code> parameter to the link image to add CSS classes. <code>shadow</code>and <code>border</code> are available but you could define other ones.</p>
<p>Add a HTTP <code>featherlight</code> parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining <code>featherlight</code> to <code>false</code>.</p>
<p>Hugo comes with a <ahref="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages">remarkable list</a> of supported languages.</p>
<p>You can choose a color theme from the <ahref="https://xyproto.github.io/splash/docs/all.html">list of supported themes</a> and add it in your <code>config.toml</code></p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># if set to `guessSyntax = true`, there will be no unstyled code even if no language</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># was given BUT mermaid code fences will not work anymore! So this is a mandatory</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># setting for your site</span>
</span></span></code></pre></div><p>By default, shortcuts are preceded by a title. This title can be disabled by setting <code>disableShortcutsTitle=true</code>.
However, if you want to keep the title but change its value, it can be overriden by changing your local i18n translation string configuration.</p>
<p>For example, in your local <code>i18n/en.toml</code> file, add the following content</p>
</span></span></code></pre></div><p>Read more about <ahref="https://gohugo.io/extras/menus/">hugo menu</a> and <ahref="https://gohugo.io/content-management/multilingual/#translation-of-strings">hugo i18n translation strings</a></p>
<h2id="i18n">Configuration for Multilingual mode</h2>
<p>When using a multilingual website, you can set different menus for each language. In the <code>config.toml</code> file, prefix your menu configuration by <code>Languages.<language-id></code>.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s2">"Cap'n Hugo Relearrrn Theme"</span>
</span></span></code></pre></div><p>Read more about <ahref="https://gohugo.io/extras/menus/">hugo menu</a> and <ahref="https://gohugo.io/content-management/multilingual/#menus">hugo multilingual menus</a></p>
<footerclass="footline">
</footer>
</article>
<article>
<h1>Icons and logos</h1>
<p>The Relearn theme for Hugo loads the <ahref="https://fontawesome.com"><strong>Font Awesome</strong></a> library, allowing you to easily display any icon or logo available in the Font Awesome free collection.</p>
<h2id="finding-an-icon">Finding an icon</h2>
<p>Browse through the available icons in the <ahref="https://fontawesome.com/v5/search?m=free">Font Awesome Gallery</a>. Notice that the <strong>free</strong> filter is enabled, as only the free icons are available by default.</p>
<p>Once on the Font Awesome page for a specific icon, for example the page for the <ahref="https://fontawesome.com/v5/icons/heart?s=solid">heart</a>, copy the HTML reference and paste into the Markdown content.</p>
</span></span></code></pre></div><h2id="including-in-markdown">Including in markdown</h2>
<p>Paste the <code><i></code> HTML into markup and Font Awesome will load the relevant icon.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl">Built with <spanclass="p"><</span><spanclass="nt">i</span><spanclass="na">class</span><spanclass="o">=</span><spanclass="s">"fas fa-heart"</span><spanclass="p">></</span><spanclass="nt">i</span><spanclass="p">></span> by Relearn and Hugo
<p>After learning <ahref="https://gohugo.io/content-management/multilingual">how Hugo handle multilingual websites</a>, define your languages in your <code>config.toml</code> file.</p>
<p>For example with current English and Piratized English website.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># English is the default language</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s2">"Cap'n Hugo Relearrrn Theme"</span>
<p>Translations strings are used for common default values used in the theme (<em>Edit</em> button, <em>Search placeholder</em> and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.</p>
<p>To override these values, create a new file in your local i18n folder <code>i18n/<idlanguage>.toml</code> and inspire yourself from the theme <code>themes/hugo-theme-relearn/i18n/en.toml</code></p>
<h2id="disable-language-switching">Disable language switching</h2>
<p>Switching the language in the browser is a great feature, but for some reasons you may want to disable it.</p>
<p>Just set <code>disableLanguageSwitchingButton=true</code> in your <code>config.toml</code></p>
<p>Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.</p>
<p>But this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.</p>
<p>To avoid this limitations, Hugo created <ahref="https://gohugo.io/extras/shortcodes/">shortcodes</a>. A shortcode is a simple snippet inside a page.</p>
<p>The Relearn theme provides multiple shortcodes on top of existing ones.</p>
<tdstyle="text-align:left">The color scheme used to highlight the box content.<br/><br/>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><nd color: <code>primary</code>, <code>secondary</code><br/>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br/>- by special color: <code>default</code>,t`</td>
<tdstyle="text-align:left">Arbitray text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwault.<br/><br/>- for severity styles: the matching title for the severity<br/>- for all other colors: <code>Attachments</code><br/><br/>If you wa you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<tdstyle="text-align:left"><ahref="/hugo-theme-relearn/cont/icons/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending le** there may be a default icon. Any given value will overwrite the default.<br/><br/>- for severity styles: a nice matching iseverity<br/>- for all other colors: <code>paperclip</code><br/><br/>If you want no icon, you have to set this parameter to <code>""</code> (a non empty d with spaces)</td>
<tdstyle="text-align:left">A <ahref="https://en.wikipedia.org/wiki/Regular_expression">regular expressions</a>, used to filter the attachments by file name. For example:<br/><br/>- to match a file suffix of ‘jpg’, use <code>.*jpg</code> (not <code>*.jpg</code>)<br/>- to match file names ending in <code>jpg</code> or <code>png</code>, use <code>.*(jpg|png)</code></td>
<p>For further examples for <strong>style</strong>, <strong>title</strong> and <strong>icon</strong>, see the <ahref="/hugo-theme-relearn/shortcodes/notice/"><code>notice</code> shortcode</a> documentation. The parameter are working the same way for both shortcodes, besides having different defaults.</p>
<tdstyle="text-align:left">The destination URL for the button. If this parameter is not set, the button will do nothing but is still displayed as clickable.</td>
<tdstyle="text-align:left">The color scheme used to paint the button.<br/><br/>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br/>- by brand color: <code>primary</code>, <code>secondary</code><br/>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br/>- by special color: <code>default</code>, <code>transparent</code></td>
<tdstyle="text-align:left"><ahref="/hugo-theme-relearn/cont/icons/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br/><br/>- for severity styles: a nice matching icon for the severity<br/>- for all other colors: <em><empty></em><br/><br/>If you want no icon for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<tdstyle="text-align:left">Arbitray text for the button title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br/><br/>- for severity styles: the matching title for the severity<br/>- for all other colors: <em><empty></em><br/><br/>If you want no title for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<tdstyle="text-align:left">When <code>true</code> shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - <ahref="https://gohugo.io/content/summaries/">read more info about summaries on gohugo.io</a>.</td>
<tdstyle="text-align:left">The depth of descendants to display. For example, if the value is <code>2</code>, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. <code>999</code>.</td>
<tdstyle="text-align:left">The sort order of the displayed list.<br/><br/>If not set it is sorted by the <ahref="/hugo-theme-relearn/basics/configuration/#global-site-parameters"><code>ordersectionsby</code></a> setting of the site and the pages frontmatter<br/><br/>- <code>weight</code>: to sort on menu order<br/>- <code>title</code>: to sort alphabetically on menu label.</td>
<p>This is a demo child page with a hidden child. You can still access the hidden child <ahref="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/">directly</a> or via the search.</p>
<h2id="subpages-of-this-page">Subpages of this page</h2>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">expand</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"Show me almost endless possibilities"</span><spanclass="o">%</span><spanclass="p">}}</span>
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
<li><ahref="https://example.com">links</a></li>
<li>etc.</li>
</ul>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code
<tdstyle="text-align:left">The path to the file to be included. Path resolution adheres to <ahref="https://gohugo.io/functions/readfile/">Hugo’s build-in <code>readFile</code> function</a></td>
<tdstyle="text-align:left">When <code>false</code> and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files.</td>
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
<li><ahref="https://example.com">links</a></li>
<li>etc.</li>
</ul>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code
<p>the possiblities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)</p>
<p>With the <ahref="https://mermaidjs.github.io/">Mermaid</a> library and shortcode, you can generate diagrams and flowcharts from text, in a similar manner as Markdown.</p>
<p>Due to limitations with <ahref="https://github.com/mermaid-js/mermaid/issues/1846">Mermaid</a>, it is currently not possible to use Mermaid code fences in an initially collapsed <code>expand</code> shortcode. This is a know issue and <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/187">can’t be fixed by this theme</a>.</p>
<p>The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.</p>
<p>While the examples are using shortcode syntax it is recommended to use codefence syntax instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.</p>
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting (<ahref="#configuration">see the configuration section</a>).</p>
<p>Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files thru a JSON object in your <code>config.toml</code>, override these settings per page thru your pages frontmatter or override these setting per diagramm thru <ahref="https://mermaid-js.github.io/mermaid/#/directives?id=directives">diagram directives</a>.</p>
<p>The JSON object of your <code>config.toml</code> / frontmatter is forwarded into Mermaid’s <code>mermaid.initialize()</code> function.</p>
<p>See <ahref="http://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults">Mermaid documentation</a> for all allowed settings.</p>
<p>The <code>theme</code> setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in <code>config.toml</code>, frontmatter or diagram directives.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># if set to `guessSyntax = true`, there will be no unstyled code even if no language</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># was given BUT mermaid code fences will not work anymore! So this is a mandatory</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># setting for your site</span>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"primary"</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"There may be pirates"</span><spanclass="nx">icon</span><spanclass="p">=</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">primary</span><spanclass="s">"There may be pirates"</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<tdstyle="text-align:left">The color scheme used to highlight the box content.<br/><br/>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br/>- by brand color: <code>primary</code>, <code>secondary</code><br/>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br/>- by special color: <code>default</code>, <code>transparent</code></td>
<tdstyle="text-align:left">Arbitray text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br/><br/>- for severity styles: the matching title for the severity<br/>- for all other colors: <em><empty></em><br/><br/>If you want no title for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<tdstyle="text-align:left"><ahref="/hugo-theme-relearn/cont/icons/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br/><br/>- for severity styles: a nice matching icon for the severity<br/>- for all other colors: <em><empty></em><br/><br/>If you want no icon for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"warning"</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"Here are dragons"</span><spanclass="nx">icon</span><spanclass="p">=</span><spanclass="s">"dragon"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"default"</span><spanclass="nx">title</span><spanclass="s">"Pay Attention to this Note!"</span><spanclass="nx">icon</span><spanclass="p">=</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"transparent"</span><spanclass="nx">title</span><spanclass="s">"Pay Attention to this Note!"</span><spanclass="nx">icon</span><spanclass="p">=</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<tdstyle="text-align:left">The URL to the OpenAPI Specification file. This can be relative to the URL of your page if it is a leaf or branch bundle.</td>
<p>Swagger is configured with default settings. You can customize Swagger’s default settings for all of your files thru a JSON object in your <code>config.toml</code> or override these settings per page thru your pages frontmatter.</p>
<p>The JSON object of your <code>config.toml</code> / frontmatter is forwarded into Swagger’s initialization. At the moment, only the <code>theme</code> setting is supported.</p>
<p>The <code>theme</code> setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in <code>config.toml</code> or frontmatter.</p>
<p>The <code>tabs</code> shortcode displays arbitrary content in unlimited number of tabs. This comes in handy eg. for providing code snippets for multiple languages or providing configuration in different formats.</p>
<tdstyle="text-align:left">Arbitrary name of the group the tab view belongs to.<br/><br/>Tab views with the same <strong>groupId</strong> sychronize their selected tab. This sychronization applies to the whole site!</td>
<p>When using tab views with different content sets, make sure to use a common <code>groupId</code> for equal sets of tabs but distinct <code>groupId</code> for different sets.</p>
<p>The tab selection is restored automatically based on the <code>groupId</code> and if it cannot find a tab item because it came from the <code>'default'</code> group on a different page then all tabs will be empty at first!</p>
<lidata-nav-id="/hugo-theme-relearn/cont/menushortcuts/"title="Menu extra shortcuts"class="dd-item"><ahref="/hugo-theme-relearn/cont/menushortcuts/">Menu extra shortcuts<iclass="fas fa-check read-icon"></i></a></li>
<lidata-nav-id="/hugo-theme-relearn/cont/icons/"title="Icons and logos"class="dd-item"><ahref="/hugo-theme-relearn/cont/icons/">Icons and logos<iclass="fas fa-check read-icon"></i></a></li>
<lidata-nav-id="/hugo-theme-relearn/cont/i18n/"title="Multilingual and i18n"class="dd-item"><ahref="/hugo-theme-relearn/cont/i18n/">Multilingual and i18n<iclass="fas fa-check read-icon"></i></a></li>
<aclass="github-button"href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip"data-icon="octicon-cloud-download"aria-label="Download McShelby/hugo-theme-relearn on GitHub">Download</a>
<aclass="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>
<aclass="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 <ahref="https://github.com/McShelby/hugo-theme-relearn"><iclass="fas fa-heart"></i></a> by <ahref="https://gohugo.io/">Hugo</a></p>
