<h2class="children-title"id="front-matter"><ahref="/hugo-theme-relearn/authoring/frontmatter/index.html">Front Matter</a></h2><p>All things front matter</p>
<h2class="children-title"id="meta-information"><ahref="/hugo-theme-relearn/authoring/meta/index.html">Meta Information</a></h2><p>What page meta information are available</p>
<h2class="children-title"id="markdown-syntax"><ahref="/hugo-theme-relearn/authoring/markdown/index.html">Markdown Syntax</a></h2><p>Reference of CommonMark and Markdown extensions</p>
<h2class="children-title"id="linking"><ahref="/hugo-theme-relearn/authoring/linking/index.html">Linking</a></h2><p>How to link your content</p>
<p>In <strong>Hugo</strong>, pages are the core of your site.</p>
<p>The theme generates the navigation menu out of the given directory structure.</p>
<p>Organize your site like <ahref="https://gohugo.io/content/structure/"rel="external"target="_self">any other Hugo project</a>. Typically, you will have a <em>content</em> directory with all your pages.</p>
<li><iclass="fa-fw fab fa-markdown cstyle secondary"></i><span>third-day.md</span></li>
<li><iclass="fa-fw fab fa-markdown cstyle secondary"></i><span>_index.md</span></li>
</ul>
</li>
<li><iclass="fa-fw fab fa-markdown cstyle secondary"></i><span>_index.md</span></li>
</ul>
</li>
</ul>
</div>
<detailsopenclass=" box cstyle notices note">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-exclamation-circle"></i>
Note
</summary>
<divclass="box-content">
<p>While you can also go different, <code>_index.md</code> (with an underscore) is recommended for each directory, it’s your <em>directory’s home page</em>.</p>
<p>See <ahref="https://gohugo.io/content-management/"rel="external"target="_self">Hugo’s guide for content </a> to learn more.</p>
<h2class="children-title"id="page-designs"><ahref="/hugo-theme-relearn/authoring/frontmatter/designs/index.html">Page Designs</a></h2><p>How to vary layouts by using page designs</p>
<h2class="children-title"id="menus"><ahref="/hugo-theme-relearn/authoring/frontmatter/menus/index.html">Menus</a></h2><p>Setting the behavior of the menus</p>
<h2class="children-title"id="linking"><ahref="/hugo-theme-relearn/authoring/frontmatter/linking/index.html">Linking</a></h2><p>What options are available for links and images</p>
<h2class="children-title"id="topbar"><ahref="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html">Topbar</a></h2><p>Configure the topbar</p>
<h2class="children-title"id="reference"><ahref="/hugo-theme-relearn/authoring/frontmatter/reference/index.html">Reference</a></h2><p>All front matter for the Relearn theme</p>
<h1class="a11y-only">Subsections of Front Matter</h1>
<articleclass="default">
<headerclass="headline">
</header>
<h1id="page-designs">Page Designs</h1>
<p>Page designs are used to provide different layouts for your pages.</p>
<p>A page is displayed by exactly one page design and is represented by <ahref="https://gohugo.io/content-management/front-matter/#type"rel="external"target="_self">Hugo’s reserved <code>type</code> front matter</a>.</p>
<p>The Relearn theme ships with the page designs <code>home</code>, <code>chapter</code>, and <code>default</code> for the HTML output format but you can <ahref="/hugo-theme-relearn/configuration/customization/designs/index.html">define further custom page designs</a>.</p>
<h2id="using-a-page-design">Using a Page Design</h2>
<p>Regardless of shipped or custom page design, you are using them in the same way.</p>
<ul>
<li>
<p>If you have an <ahref="https://gohugo.io/content-management/archetypes/"rel="external"target="_self">archetype file</a>, you can just do</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind chapter log/_index.md</span></span></code></pre></div>
</li>
<li>
<p>If you are creating your Markdown files manually, you can achieve the same by just setting <code>type='chapter'</code> in the front matter to make your page displayed with the <code>chapter</code> page design.</p>
<p>If no <code>type</code> is set in your front matter or the page design doesn’t exist for a given output format, the page is treated as if <code>type='default'</code> was set.</p>
<h2id="predefined-designs-for-the-html-output-format">Predefined Designs for the HTML Output Format</h2>
<h3id="archetypes-home">Home</h3>
<p>A <strong>Home</strong> page is the starting page of your project. It’s best to have only one page of this kind in your project.</p>
<p>To create a home page, run the following command</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind home _index.md</span></span></code></pre></div>
<p>A <strong>Chapter</strong> displays a page meant to be used as introduction for a set of child pages.</p>
<p>Commonly, it contains a title front matter and a short description in the content.</p>
<p>To create a chapter page, run the following command</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind chapter log/_index.md</span></span></code></pre></div>
<p>If a numerical <code>weight</code> front matter is set, it will be used to generate the subtitle of the chapter page. Set the number to a consecutive value starting at 1 for each new chapter on the same directory level.</p>
<p>A <strong>Default</strong> page is any other content page.</p>
<p>To create a default page, run either one of the following commands</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new log/first-day/_index.md</span></span></code></pre></div>
<p>or</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new log/second-day/index.md</span></span></code></pre></div>
<p>or</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new log/third-day.md</span></span></code></pre></div>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> By default, external links open in a new tab. To change this, use the <code>externalLinkTarget</code> setting with a proper <ahref="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target"rel="external"target="_self">link target</a>.</p>
<p>To set default values for all links, use <ahref="/hugo-theme-relearn/authoring/linking/linkeffects/index.html">link effects</a>.</p>
<p>For example, this will open links in the same tab</p>
<h2id="enabling-link-and-image-link-warnings">Enabling Link and Image Link Warnings</h2>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> You can use <code>link.errorlevel</code> and <code>image.errorlevel</code> to control what should happen if a local link can not be resolved to a page and/or a resource.</p>
<p>If not set or empty, any unresolved link is written as given into the resulting output. If set to <code>warning</code> the same happens and an additional warning is printed in the built console. If set to <code>error</code> an error message is printed and the build is aborted.</p>
<p>Please note that this can not resolve files inside of your <code>static</code> directory. The file must be a resource of the page or the site.</p>
<p>Link warnings are also available for the <ahref="/hugo-theme-relearn/shortcodes/include/index.html#enabling-link-warnings">include</a> and <ahref="/hugo-theme-relearn/shortcodes/openapi/index.html#enabling-link-warnings">openapi</a> shortcodes.</p>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> In case you want to use link warnings but are bothered by false negatives, you can configure an ignore list of regular expressions. The referenced address will be checked against all regexes of this list. If the address matches at least one regex, no output will be written to the console. The check uses <ahref="https://gohugo.io/functions/strings/findre/"rel="external"target="_self">Hugo’s <code>findRE</code> function</a>.</p>
<p>This page is about how to configure the topbar using configuration options. If you want to add further buttons or functionality, <ahref="/hugo-theme-relearn/configuration/customization/topbar/index.html">see this section</a>.</p>
<p>Your topbar contains the following elements. Some of them are configuarable:</p>
<ul>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fas fa-bars"></i></span></span><strong>sidebar</strong>: opens the sidebar flyout if in mobile layout</li>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fas fa-list-alt"></i></span></span><strong>toc</strong>: <ahref="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#table-of-contents">opens the table of contents in an overlay</a></li>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fas fa-empty"></i></span></span><strong>breadcrumb</strong>: shows the clickable <ahref="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#breadcrumbs">breadcrumbs</a></li>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fas fa-pen"></i></span></span><strong>edit</strong>: browses to the editable page if the <code>editURL</code><ahref="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#edit-button">parameter is set</a></li>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fas fa-code"></i></span></span><strong>source</strong>: browses to the <ahref="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#source-button">chapters source code</a> if <ahref="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#source-support">source support</a> was activated</li>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fab fa-markdown"></i></span></span><strong>markdown</strong>: browses to the <ahref="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#markdown-button">chapters Markdown source</a> if <ahref="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#markdown-support">markdown support</a> was activated</li>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fas fa-print"></i></span></span><strong>print</strong>: browses to the <ahref="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#print-button">chapters printable page</a> if <ahref="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#print-support">print support</a> was activated</li>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fas fa-chevron-left"></i></span></span><strong>prev</strong>: browses to the <ahref="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#arrow-navigation">previous page</a> if there is one</li>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fas fa-chevron-right"></i></span></span><strong>next</strong>: browses to the <ahref="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html#arrow-navigation">next page</a> if there is one</li>
<li><spanclass="btn cstyle transparent"><span><iclass="fa-fw fas fa-ellipsis-v"></i></span></span><strong>more</strong>: opens the overlay if screen space is limited</li>
</ul>
<h2id="table-of-contents">Table of Contents</h2>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> Set <code>disableToc=true</code> to hide the TOC button on all pages. If the button is hidden, also the keyboard shortcut is disabled. This can be overridden in a page’s front matter.</p>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> Set <code>disableBreadcrumb=true</code> to hide the breadcrumb in the topbar.</p>
<p>Further breadcrumbs settings can be found in the <ahref="/hugo-theme-relearn/configuration/content/titles/index.html">content configuration section</a>.</p>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> If <code>editURL</code> is set to a URL, an edit button will be shown in the topbar. If the button is hidden, also the keyboard shortcut is disabled.</p>
<p>The value can contain the macro <code>${FilePath}</code> which will be replaced by the file path of your displayed page. If no <code>${FilePath}</code> is given in the value, the value is treated as if the <code>${FilePath}</code> was appended at the end of the value. This can be overridden in the pages front matter.</p>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> You can hide the Markdown button if the <ahref="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#markdown-support">Markdown output format</a> is active by setting <code>disableMarkdownButton=true</code>.</p>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> You can hide the Source button if the <ahref="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#source-support">Source output format</a> is active by setting <code>disableSourceButton=true</code>.</p>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> You can hide the print button if the <ahref="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html#print-support">print output format</a> is active by setting <code>disablePrintButton=true</code>.</p>
<p><spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> You can hide the previous/next buttons by setting <code>disableNextPrev=true</code>. If the buttons are hidden, also the keyboard shortcuts are disabled.</p>
<p>In addition to <ahref="https://gohugo.io/content-management/front-matter/#fields"rel="external"target="_self">Hugo’s standard front matter</a>, the Relearn theme offers extras settings listed here.</p>
<p>Throughout the documentation, theme-specific front matter is marked with a <spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> badge.</p>
<p>Add theme front matter directly to the root of your page’s front matter. For example:</p>
<p>Here’s a list of all available front matter with example values. Default values are described in the <ahref="/hugo-theme-relearn/authoring/frontmatter/reference/index.html#annotated-front-matter">annotated example</a> below or in each front matter’s documentation.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># The page design to be used</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Default: not set</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># This decides the layout of your page. The theme ships 'home', 'chapter' and</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># 'default'. If not set, 'default' is taken.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># type = ''</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># The URL prefix to edit a page.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Default: not set</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, an edit button will be shown in the topbar. If the button is hidden,</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># also the keyboard shortcuts are disabled. The value can contain the macro</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># `${FilePath}` which will be replaced by the file path of your displayed page.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If not set, the set value of your site's hugo.toml is used. If the global</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># parameter is given but you want to hide the button for the displayed page,</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># you can set the value to an empty string. If instead of hiding you want to have</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># an disabled button, you can set the value to a string containing just spaces.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># This is useful if you want to give the opportunity for people to create merge</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># request for your content.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Submenus can be ordered by 'weight', 'title', 'linktitle', 'modifieddate',</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># 'expirydate', 'publishdate', 'date', 'length' or 'default' (adhering to</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># The initial expand state of submenus.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Default: not set</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># This controls whether submenus will be expanded (true), or collapsed (false)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># in the menu. If not set, the first menu level is set to false, all others</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># levels are set to true. If not set, the value of the parent menu entry is used.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If the displayed page has submenus, they will always been displayed expanded</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># regardless of this option.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - `identifier` is mandatory. In case of `type=page`, anything can be used,</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># in case of `type=menu` the `identifier` key must be identical to the</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># key of the menu definition.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - `main`, boolean. If `true`, the first tree level is spaced more generous</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># and the text is emphasized. Default: `true` for `type=page` and `false`</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># for `type=menu` and `type=custom`</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - `disableTitle`, boolean. If `true`, there is no title above the tree.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Default: `true` for `type=page` and `false` for `type=menu`. If a title</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># should be used, in case of `type=page` it will be taken from the page's</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># `menuTitle` front matter and if not set, from the translation files, using</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># the menu `identifier` as key. In case of `type=menu` it will be taken</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># from the menu `title` according to Hugo's documentation and if not set</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># from the menu `name` and if this is not set form the page's `linkTitle`.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - `pageRef`, optional. In case of `type=page` this is the starting page's</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># path. If not set, the home page will be used.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - `elements`, optional. In case of `type=custom` the list of elements to</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># display. The theme shipps with the following predefined snippets which</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># all accept the `icon` parameter to overwrite the default icon</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - languageswitcher: will display the language switcher</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - variantswitcher: will display the variant switcher</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - versionswitcher: will display the version switcher</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - historyclearer: will display a button to clear the history of visited links</span>
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># The sidebar header menu.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Default: see notes</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If not given, defaults to</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - a home button if configured; if you redefine this, use a Hugo menu and a type=menu to replicate this</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - a divider to separate from the sidebarmenus (depending on the configuration of the theme variant)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># The main sidebar header.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Default: see notes</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - a divider to separate from the sidebarmenus if any of the following is configured</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - the language switcher if multilingual is configured</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - the variant switcher if multiple variants are configured</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - the history clearer if you configured to mark visited pages</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># These options configure how hidden pages are treated.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># A page flagged as hidden, is only removed from the navigation menu if you are</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># currently not on this page or the hidden page is not part of current page's</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># ancestors. For all other functionality in Hugo a hidden page behaves like any</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># other page if not otherwise configured.</span>
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Hide a page's menu entry.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># You can control what should happen if a path can not be resolved to as</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># a resource or via the file system. If not set, no output will be written</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># for the unresolved path. If set to `warning` the same happens and an additional</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># warning is printed. If set to `error` an error message is printed and the build</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># is aborted.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If not set, the set value of your site's hugo.toml is used.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># You can control what should happen if a local image can not be resolved to as</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># a resource. If not set, the unresolved link is written as given into the resulting</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># output. If set to `warning` the same happens and an additional warning is</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># printed. If set to `error` an error message is printed and the build is</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># See the documentation for how you can even add your own arbitrary effects to</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># the list.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># All effect values default to the values of your site's hugo.toml and can be</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># overridden through URL parameter given to the image. See the documentation for</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Please note that with Hugo < 0.123.0 + `uglyURLs=true` this can lead to false</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Link effects.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># See the documentation for how you can even add your own arbitrary effects to</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># the list.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># All effect values default to the values of your site's hugo.toml and can be</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># overridden through URL parameter given to the link. See the documentation for</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If a, Math shortcode or codefence is found, the option will be ignored and</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Math will be loaded regardlessly. This option is useful in case you</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># are using passthrough configuration to render your math. In this case no shortcode or</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># codefence is involved and the library is not loaded by default so you can</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># force loading it by setting `math=true`.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># This option has an alias `math.force`.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If not set, the set value of your site's hugo.toml is used.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># You can control what should happen if a local OpenAPI spec link can not be resolved</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># to a resource. If not set, the unresolved link is written as given into the resulting</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># output. If set to `warning` the same happens and an additional warning is</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># printed. If set to `error` an error message is printed and the build is</span>
<p>The <code>title</code> will be used in the heading and meta information of your HTML.</p>
<p>A page without a title is <ahref="/hugo-theme-relearn/authoring/meta/index.html#hidden">treated as if <code>hidden=true</code></a> has been set.</p>
<p>The <code>description</code> is used for generating HTML meta information, in the <ahref="/hugo-theme-relearn/shortcodes/children/index.html">children</a> shortcode and in social media meta information.</p>
<p>If not set, the set value of your site’s hugo.toml is used for the HTML meta information and social media meta information. It appears empty for the <ahref="/hugo-theme-relearn/shortcodes/children/index.html">children</a> shortcode.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">description</span><spanclass="p">=</span><spanclass="s1">'Some lenghty example description'</span>
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="w"></span><spanclass="nt">description</span><spanclass="p">:</span><spanclass="w"></span><spanclass="l">Some lenghty example description</span><spanclass="w">
</span></span><spanclass="line"><spanclass="cl"><spanclass="nt">"description"</span><spanclass="p">:</span><spanclass="s2">"Some lenghty example description"</span>
<h2id="social-media-images">Social Media Images</h2>
<p>The theme adds social media meta tags including feature images for the <ahref="https://gohugo.io/templates/internal/#open-graph"rel="external"target="_self">Open Graph</a> protocol and <ahref="https://gohugo.io/templates/internal/#twitter-cards"rel="external"target="_self">Twitter Cards</a> to your site. These are configured as mentioned in the linked Hugo docs.</p>
<p><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> You can hide your pages from the menu by setting <code>hidden=true</code>.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-bars"></i></span><spanclass="badge-content"style="background-color: blueviolet;">Menu</span></span> For <ahref="https://gohugo.io/content-management/menus/"rel="external"target="_self">Hugo menus</a>, you have to set <code>params.hidden=true</code> instead.</p>
<p><ahref="/hugo-theme-relearn/configuration/content/hidden/index.html">See how you can further configure visibility</a> throughout your site.</p>
<h2id="add-icon-to-the-title-heading">Add Icon to the Title Heading</h2>
<p><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> In the page front matter, add a <code>headingPre</code> to insert any HTML code before the title heading. You can also set <code>headingPost</code> to insert HTML code after the title heading.</p>
<p>You also may want to <ahref="/hugo-theme-relearn/configuration/customization/extending/index.html#adding-javascript-or-stylesheets-to-all-pages">apply further CSS</a> in this case.</p>
<p><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> If you use the default <code>layouts/partials/content-footer.html</code> is not overridden by you, it will display authoring information, namely</p>
<ul>
<li><code>AuthorName</code> if <ahref="https://gohugo.io/methods/page/gitinfo/"rel="external"target="_self">GitInfo</a> is active, otherwise <code>LastModifierDisplayName</code> front matter</li>
<li><code>AuthorEmail</code> if <ahref="https://gohugo.io/methods/page/gitinfo/"rel="external"target="_self">GitInfo</a> is active, otherwise <code>LastModifierEmail</code> front matter</li>
<li><code>AuthorDate</code> if <ahref="https://gohugo.io/methods/page/gitinfo/"rel="external"target="_self">GitInfo</a> is active, otherwise <ahref="https://gohugo.io/methods/page/date/"rel="external"target="_self">Hugo’s <code>date</code> front matter</a></li>
</ul>
<p>See how to further <ahref="/hugo-theme-relearn/configuration/content/meta/index.html">configure this information</a> on a site-wide basis.</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 HTML 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>
<detailsopenclass=" box cstyle notices tip">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-lightbulb"></i>
Tip
</summary>
<divclass="box-content">
<p><iclass="fa-fw fas fa-bookmark"></i> Bookmark this page for easy future reference!</p>
</div>
</details>
<h2id="standard-and-extensions">Standard and Extensions</h2>
<p>If not otherwise noted, the shown examples adhere to the <ahref="https://commonmark.org/help/"rel="external"target="_self">CommonMark</a> standard. In addition the theme supports the following extensions that <ahref="https://gohugo.io/getting-started/configuration-markup/#goldmark"rel="external"target="_self">can be activated</a> in your <code>hugo.toml</code> or are built into the theme:</p>
<ul>
<li>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-github"></i></span><spanclass="badge-content"style="background-color: darkgray;">GFM</span></span> Extension on top of standard Markdown adhering to <ahref="https://github.github.com/gfm/"rel="external"target="_self">GitHub Flavored Markdown</a>.</p>
</li>
<li>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-php"></i></span><spanclass="badge-content"style="background-color: #888cc4;">PHP</span></span> Extension on top of standard Markdown adhering to <ahref="https://michelf.ca/projects/php-markdown/extra/"rel="external"target="_self">PHP Markdown</a>.</p>
</li>
<li>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-lightbulb"></i></span><spanclass="badge-content"style="background-color: darkorange;">Pants</span></span> Extension by John Gruber adhering to <ahref="https://daringfireball.net/projects/smartypants/"rel="external"target="_self">SmartyPants</a>.</p>
</li>
<li>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">Hugo</span></span><ahref="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension"rel="external"target="_self">Hugo Extra Extension</a> supported by Hugo.</p>
</li>
<li>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw far fa-gem"></i></span><spanclass="badge-content"style="background-color: #7c3aed;">Obsidian</span></span> Extension implemented by <ahref="https://obsidian.md/"rel="external"target="_self">Obsidian</a>.</p>
</li>
<li>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-code"></i></span><spanclass="badge-content"style="background-color: orangered;">HTML</span></span> If the <ahref="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe"rel="external"target="_self">usage of HTML</a> is allowed, the theme supports styling for further HTML elements.</p>
</li>
<li>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-puzzle-piece"></i></span><spanclass="badge-content"style="background-color: #7dc903;">Relearn</span></span> Extension specific to this theme.</p>
</li>
</ul>
<h2id="paragraphs">Paragraphs</h2>
<p>In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.</p>
<p>Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">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>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.</p>
<p>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.</p>
</div>
</details>
<h2id="headings">Headings</h2>
<p>A good idea is to structure your content using headings and subheadings. HTML-headings from <code>h1</code> through <code>h6</code> are constructed with a <code>#</code> for each level.</p>
<p>In Hugo you usually don’t use <code>h1</code> as this is generated by your theme and you should only have one such element in a document.</p>
<p>To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes <code>---</code>.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
</span></span><spanclass="line"><spanclass="cl">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>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.</p>
<hr>
<p>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.</p>
</div>
</details>
<h2id="blockquotes">Blockquotes</h2>
<h3id="quotations">Quotations</h3>
<p>For quoting blocks of content from another source within your document add <code>></code> before any text you want to quote.</p>
<p>Blockquotes can also be nested.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc 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><spanclass="line"><spanclass="cl">> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<blockquote>
<p>Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc 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>
</div>
</details>
<h3id="github-alerts">GitHub Alerts</h3>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-github"></i></span><spanclass="badge-content"style="background-color: darkgray;">GFM</span></span> Since Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.132.0</span></span><ahref="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts"rel="external"target="_self">GitHub alerts</a> are also supported. Please note, that coloring and icons of severities may defer between GitHub and this theme.</p>
<p>If you are in need of more advanced options to style your alerts, like icons, use the <ahref="/hugo-theme-relearn/shortcodes/notice/index.html">notice shortcode</a>.</p>
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Advises about risks or negative outcomes of certain actions.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Key information users need to know to achieve their goal.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Useful information that users should know, even when skimming content.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Helpful advice for doing things better or more easily.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span>> Urgent info that needs immediate user attention to avoid problems.</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<detailsopenclass=" box cstyle notices caution">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-hand"></i>
Caution
</summary>
<divclass="box-content">
<p>Advises about risks or negative outcomes of certain actions.</p>
<p>Key information users need to know to achieve their goal.</p>
</div>
</details>
<detailsopenclass=" box cstyle notices info">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-info-circle"></i>
Info
</summary>
<divclass="box-content">
<p>Information that users <ins><em>might</em></ins> find interesting.</p>
</div>
</details>
<detailsopenclass=" box cstyle notices note">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-exclamation-circle"></i>
Note
</summary>
<divclass="box-content">
<p>Useful information that users should know, even when skimming content.</p>
</div>
</details>
<detailsopenclass=" box cstyle notices tip">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-lightbulb"></i>
Tip
</summary>
<divclass="box-content">
<p>Helpful advice for doing things better or more easily.</p>
</div>
</details>
<detailsopenclass=" box cstyle notices warning">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-exclamation-triangle"></i>
Warning
</summary>
<divclass="box-content">
<p>Urgent info that needs immediate user attention to avoid problems.</p>
</div>
</details>
</div>
</details>
<h3id="obsidian-callouts">Obsidian Callouts</h3>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw far fa-gem"></i></span><spanclass="badge-content"style="background-color: #7c3aed;">Obsidian</span></span> Since Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.134.0</span></span><ahref="https://help.obsidian.md/Editing+and+formatting/Callouts#Change+the+title"rel="external"target="_self">Obsidian callouts</a> are also supported. Which enables configurable title text and expand/collapse.</p>
<p>If you are in need of more advanced options to style your alerts, like icons, use the <ahref="/hugo-theme-relearn/shortcodes/notice/index.html">notice shortcode</a>.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">[!tip] Callouts can have custom titles
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Like this one.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">[!note]- Are callouts foldable?
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Yes! In a foldable callout, the contents are hidden when the callout is collapsed
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">[!note]+ Are callouts foldable?
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span>> Yes! In a foldable callout, the contents are hidden when the callout is collapsed</span></span></code></pre></div>
<p>Yes! In a foldable callout, the contents are hidden when the callout is collapsed</p>
</div>
</details>
</div>
</details>
<h2id="text-markers">Text Markers</h2>
<h3id="bold">Bold</h3>
<p>You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks <code>**</code>.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">I am rendered with **bold text**</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>I am rendered with <strong>bold text</strong></p>
</div>
</details>
<h3id="italics">Italics</h3>
<p>You can emphasize a snippet of text with italics by enclosing it with underscores <code>_</code>.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">I am rendered with _italicized text_</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>I am rendered with <em>italicized text</em></p>
</div>
</details>
<h3id="marked-text">Marked Text</h3>
<p>You can mark text in the predefined accent color of your stylesheet.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">Hugo</span></span> Since Hugo 0.126.0, you can <ahref="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension"rel="external"target="_self">activate this through the <em>Hugo Extra Extension</em></a> in your <code>hugo.toml</code></p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">==Parts== of this text ==are marked!==</span></span></code></pre></div>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-code"></i></span><spanclass="badge-content"style="background-color: orangered;">HTML</span></span> You can also use it by configuring Hugo for <ahref="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe"rel="external"target="_self">usage of HTML</a>.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">mark</span><spanclass="p">></span>Parts<spanclass="p"></</span><spanclass="nt">mark</span><spanclass="p">></span> of this text <spanclass="p"><</span><spanclass="nt">mark</span><spanclass="p">></span>are marked!<spanclass="p"></</span><spanclass="nt">mark</span><spanclass="p">></span></span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p><mark>Parts</mark> of this text <mark>are marked!</mark></p>
</div>
</details>
<h3id="inserted-text">Inserted Text</h3>
<p>You can mark text additions to existing text.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">Hugo</span></span> Since Hugo 0.126.0, you can <ahref="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension"rel="external"target="_self">activate this through the <em>Hugo Extra Extension</em></a> in your <code>hugo.toml</code></p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-code"></i></span><spanclass="badge-content"style="background-color: orangered;">HTML</span></span> You can also use it by configuring Hugo for <ahref="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe"rel="external"target="_self">usage of HTML</a>.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-github"></i></span><spanclass="badge-content"style="background-color: darkgray;">GFM</span></span> You can do strikethroughs by enclosing text with two tildes <code>~~</code>. See <ahref="https://gohugo.io/getting-started/configuration-markup/#extras"rel="external"target="_self">Hugo’s documentation remarks</a> if you want to use this together with the subscript syntax.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">~~Strike through~~ this text</span></span></code></pre></div>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-lightbulb"></i></span><spanclass="badge-content"style="background-color: darkorange;">Pants</span></span> You can combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">Double quotes <spanclass="sb">`"`</span> and single quotes <spanclass="sb">`'`</span> of enclosed text are replaced by <spanclass="ge">**</span>"double curly quotes"** and <spanclass="ge">**</span>'single curly quotes'**.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">Double dashes <spanclass="sb">`--`</span> and triple dashes <spanclass="sb">`---`</span> are replaced by en-dash <spanclass="ge">**</span>--** and em-dash <spanclass="ge">**</span>---** entities.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">Double arrows pointing left <spanclass="sb">`<<`</span> or right <spanclass="sb">`>>`</span> are replaced by arrow <spanclass="ge">**</span><spanclass="err"><<</span>** and <spanclass="ge">**</span>>>** entities.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">Three consecutive dots <spanclass="sb">`...`</span> are replaced by an ellipsis <spanclass="ge">**</span>...** entity.</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>Double quotes <code>"</code> and single quotes <code>'</code> of enclosed text are replaced by <strong>“double curly quotes”</strong> and <strong>‘single curly quotes’</strong>.</p>
<p>Double dashes <code>--</code> and triple dashes <code>---</code> are replaced by en-dash <strong>–</strong> and em-dash <strong>—</strong> entities.</p>
<p>Double arrows pointing left <code><<</code> or right <code>>></code> are replaced by arrow <strong>«</strong> and <strong>»</strong> entities.</p>
<p>Three consecutive dots <code>...</code> are replaced by an ellipsis <strong>…</strong> entity.</p>
</div>
</details>
<h3id="subscript-and-superscript">Subscript and Superscript</h3>
<p>You can also use subscript and superscript text. For more complex stuff, you can use the <ahref="/hugo-theme-relearn/shortcodes/math/index.html"><code>math</code> shortcode</a>.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">Hugo</span></span> Since Hugo 0.126.0, you can <ahref="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension"rel="external"target="_self">activate this through the <em>Hugo Extra Extension</em></a> in your <code>hugo.toml</code></p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">How many liters H~2~O fit into 1dm^3^?</span></span></code></pre></div>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-code"></i></span><spanclass="badge-content"style="background-color: orangered;">HTML</span></span> You can also use it by configuring Hugo for <ahref="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe"rel="external"target="_self">usage of HTML</a>.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl">How many liters H<spanclass="p"><</span><spanclass="nt">sub</span><spanclass="p">></span>2<spanclass="p"></</span><spanclass="nt">sub</span><spanclass="p">></span>O fit into 1dm<spanclass="p"><</span><spanclass="nt">sup</span><spanclass="p">></span>3<spanclass="p"></</span><spanclass="nt">sup</span><spanclass="p">></span>?</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>How many liters H<sub>2</sub>O fit into 1dm<sup>3</sup>?</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-code"></i></span><spanclass="badge-content"style="background-color: orangered;">HTML</span></span> You can use the <code><kbd></code> element to style keyboard shortcuts.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl">Press <spanclass="p"><</span><spanclass="nt">kbd</span><spanclass="p">></span>STRG<spanclass="p"></</span><spanclass="nt">kbd</span><spanclass="p">></span><spanclass="p"><</span><spanclass="nt">kbd</span><spanclass="p">></span>ALT<spanclass="p"></</span><spanclass="nt">kbd</span><spanclass="p">></span><spanclass="p"><</span><spanclass="nt">kbd</span><spanclass="p">></span>DEL<spanclass="p"></</span><spanclass="nt">kbd</span><spanclass="p">></span> to end your shift early.</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>Press <kbd>STRG</kbd><kbd>ALT</kbd><kbd>DEL</kbd> to end your shift early.</p>
</div>
</details>
<h2id="lists">Lists</h2>
<h3id="unordered">Unordered</h3>
<p>You can write a list of items in which the order of the items does not explicitly matter.</p>
<p>It is possible to nest lists by indenting an item for the next sublevel.</p>
<p>You may use any of <code>-</code>, <code>*</code> or <code>+</code> to denote bullets for each list item but should not switch between those symbols inside one whole list.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl"><spanclass="k">-</span> Lorem ipsum dolor sit amet
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">-</span> Vestibulum laoreet porttitor sem
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">-</span> Ac tristique libero volutpat at
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">-</span> Nulla volutpat aliquam velit
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">-</span> Phasellus iaculis neque
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">-</span> Purus sodales ultricies
</span></span><spanclass="line"><spanclass="cl">- Faucibus porta lacus fringilla vel</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<ul>
<li>Lorem ipsum dolor sit amet</li>
<li>Consectetur adipiscing elit
<ul>
<li>Vestibulum laoreet porttitor sem</li>
<li>Ac tristique libero volutpat at</li>
</ul>
</li>
<li>Nulla volutpat aliquam velit
<ul>
<li>Phasellus iaculis neque</li>
<li>Purus sodales ultricies</li>
</ul>
</li>
<li>Faucibus porta lacus fringilla vel</li>
</ul>
</div>
</details>
<h3id="ordered">Ordered</h3>
<p>You can create a list of items in which the order of items does explicitly matter.</p>
<p>It is possible to nest lists by indenting an item for the next sublevel.</p>
<p>Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Lorem ipsum dolor sit amet
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Integer molestie lorem at massa
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">7.</span> Facilisis in pretium nisl aliquet
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">99.</span> Nulla volutpat aliquam velit
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Faucibus porta lacus fringilla vel
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Aenean sit amet erat nunc
</span></span><spanclass="line"><spanclass="cl">17. Eget porttitor lorem</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<ol>
<li>Lorem ipsum dolor sit amet</li>
<li>Consectetur adipiscing elit
<ol>
<li>Integer molestie lorem at massa</li>
<li>Facilisis in pretium nisl aliquet</li>
</ol>
</li>
<li>Nulla volutpat aliquam velit
<ol>
<li>Faucibus porta lacus fringilla vel</li>
<li>Aenean sit amet erat nunc</li>
</ol>
</li>
<li>Eget porttitor lorem</li>
</ol>
</div>
</details>
<h3id="tasks">Tasks</h3>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-github"></i></span><spanclass="badge-content"style="background-color: darkgray;">GFM</span></span> You can add task lists resulting in checked or unchecked non-clickable items</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl"><spanclass="k">- [x]</span> Basic Test
</span></span><spanclass="line"><spanclass="cl"><spanclass="k">- [ ]</span> More Tests
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-puzzle-piece"></i></span><spanclass="badge-content"style="background-color: #7dc903;">Relearn</span></span> You can add lists as a tree with configurable icons and colors.</p>
<p>The name can be followed by an optional pipe (<code>|</code>) to define an icon and further optional pipe to define the icon’s color.</p>
<p>More details can be found in the <ahref="/hugo-theme-relearn/shortcodes/tree/index.html"><code>tree</code> shortcode docs</a>.</p>
<li><iclass="fa-fw fab fa-php"style="color: #888cc4;"></i><span>home.php</span></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</details>
<h3id="definitions">Definitions</h3>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-php"></i></span><spanclass="badge-content"style="background-color: #888cc4;">PHP</span></span> Definition lists are made of terms and definitions of these terms, much like in a dictionary.</p>
<p>A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.</p>
<p>If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible</p>
</span></span><spanclass="line"><spanclass="cl">: The fruit of an evergreen tree of the genus Citrus.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl"> You can make juice out of it.
</span></span><spanclass="line"><spanclass="cl">: A telecommunication company.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl"> You can't make juice out of it.</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<dl>
<dt>Apple</dt>
<dd>Pomaceous fruit of plants of the genus Malus in the family Rosaceae.</dd>
<dd>An American computer company.</dd>
<dt>Orange</dt>
<dd>The fruit of an evergreen tree of the genus Citrus.
<p>You can make juice out of it.</p>
</dd>
<dd>A telecommunication company.
<p>You can’t make juice out of it.</p>
</dd>
</dl>
</div>
</details>
<h2id="code">Code</h2>
<h3id="inline-code">Inline Code</h3>
<p>Inline snippets of code can be wrapped with backticks <code>`</code>.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">In this example, <spanclass="sb">`<div></div>`</span> is marked as code.</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>In this example, <code><div></div></code> is marked as code.</p>
<p>A simple code block can be generated by indenting several lines of code by at least two spaces.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">Be impressed by my advanced code:
</span></span><spanclass="line"><spanclass="cl">
</span></span><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></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>Be impressed by my advanced code:</p>
<pre><code>// Some comments
line 1 of code
line 2 of code
line 3 of code
</code></pre>
</div>
</details>
<h3id="fenced-code-block">Fenced Code Block</h3>
<p>If you want to gain more control of your code block you can enclose your code by at least three backticks <code>```</code> a so called fence.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-github"></i></span><spanclass="badge-content"style="background-color: darkgray;">GFM</span></span> You can also add a language specifier directly after the opening fence, <code>```js</code>, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.</p>
<p>See <ahref="/hugo-theme-relearn/shortcodes/highlight/index.html">Code Highlighting</a> for additional documentation.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-github"></i></span><spanclass="badge-content"style="background-color: darkgray;">GFM</span></span> You can create tables 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">| data | 1 | path to data files to supply the data that will be passed into templates. |
</span></span><spanclass="line"><spanclass="cl">| engine | 2 | engine to be used for processing templates. Handlebars is the default. |
</span></span><spanclass="line"><spanclass="cl">| ext | 3 | extension to be used for dest files. |</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<table>
<thead>
<tr>
<thstyle="text-align: right">Option</th>
<thstyle="text-align: center">Number</th>
<thstyle="text-align: left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<tdstyle="text-align: right">data</td>
<tdstyle="text-align: center">1</td>
<tdstyle="text-align: left">path to data files to supply the data that will be passed into templates.</td>
</tr>
<tr>
<tdstyle="text-align: right">engine</td>
<tdstyle="text-align: center">2</td>
<tdstyle="text-align: left">engine to be used for processing templates. Handlebars is the default.</td>
</tr>
<tr>
<tdstyle="text-align: right">ext</td>
<tdstyle="text-align: center">3</td>
<tdstyle="text-align: left">extension to be used for dest files.</td>
</tr>
</tbody>
</table>
</div>
</details>
<h2id="links">Links</h2>
<h3id="autolink">Autolink</h3>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-github"></i></span><spanclass="badge-content"style="background-color: darkgray;">GFM</span></span> Absolute URLs will automatically be converted into a link.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">This is a link to https://example.com.</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p>This is a link to <ahref="https://example.com"rel="external"target="_self">https://example.com</a>.</p>
</div>
</details>
<h3id="basic-link">Basic Link</h3>
<p>You can explicitly define links in case you want to use non-absolute URLs or want to give different text.</p>
<p>Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.</p>
</span></span><spanclass="line"><spanclass="cl">[somelinkID]: https://example.com "Go to example domain"</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p><ahref="https://example.com"rel="external"target="_self"title="Go to example domain">Example</a></p>
</div>
</details>
<h3id="footnotes">Footnotes</h3>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-php"></i></span><spanclass="badge-content"style="background-color: #888cc4;">PHP</span></span> Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.</p>
<p>Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.</p>
<p>Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">That's some text with a footnote[^1]
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">[^1]: And that's the footnote.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">That's some more text with a footnote.[^someid]
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-puzzle-piece"></i></span><spanclass="badge-content"style="background-color: #7dc903;">Relearn</span></span> This theme allows additional non-standard formatting by setting query parameter at the end of the URL. See the <ahref="/hugo-theme-relearn/authoring/linking/linkeffects/index.html">link effects docs</a> for a detailed example and how to configure it.</p>
<h4id="target">Target</h4>
<p>Add query parameter <code>target=_self</code> or <code>target=_blank</code> to override <ahref="/hugo-theme-relearn/authoring/frontmatter/linking/index.html#opening-links">site-wide settings</a> of <ahref="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target"rel="external"target="_self">the target behavior</a> individuallly for each link.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">[<spanclass="nt">Magic in new window</span>](<spanclass="na">images/magic.gif?target=_blank</span>)</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p><ahref="/hugo-theme-relearn/images/magic.gif?target=_blank"target="_blank">Magic in new window</a></p>
</div>
</details>
<h4id="download">Download</h4>
<p>Add query parameter <code>download</code> or <code>download=myfile.gif</code> to force your browser <ahref="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download"rel="external"target="_self">to download the link target</a> instead of opening it.</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">[<spanclass="nt">Magic as a download</span>](<spanclass="na">images/magic.gif?download</span>)</span></span></code></pre></div>
<detailsopenclass=" box cstyle notices code">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-eye"></i>
Result
</summary>
<divclass="box-content">
<p><aclass="download"downloadhref="/hugo-theme-relearn/images/magic.gif?download">Magic as a download</a></p>
</div>
</details>
<h2id="images">Images</h2>
<h3id="basic-images">Basic Images</h3>
<p>Images have a similar syntax to links but include a preceding exclamation mark.</p>
<p>Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.</p>
</span></span><spanclass="line"><spanclass="cl">[laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"</span></span></code></pre></div>
<ahref="javascript:history.back();"class="lightbox-back"id="R-image-0c266d26eeb582e99607c9fe13c1acd9"><imgalt="La Forge"class="bg-white border lazy lightbox lightbox-image"loading="lazy"src="https://octodex.github.com/images/trekkie.jpg?width=20vw"title="Geordi La Forge"></a></p>
</div>
</details>
<h3id="image-effects">Image Effects</h3>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-puzzle-piece"></i></span><spanclass="badge-content"style="background-color: #7dc903;">Relearn</span></span> This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. See the <ahref="/hugo-theme-relearn/authoring/linking/imageeffects/index.html">image effects docs</a> for a detailed example and how to configure it.</p>
<h4id="resizing">Resizing</h4>
<p>Add query parameter <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 query parameter <code>classes</code> to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.</p>
<p>If you want to wrap an image in a link and <code>lightbox=true</code> is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:</p>
<h2class="children-title"id="pages--resources"><ahref="/hugo-theme-relearn/authoring/linking/pages/index.html">Pages & Resources</a></h2><p>How to link to pages and resources</p>
<h2class="children-title"id="link-effects"><ahref="/hugo-theme-relearn/authoring/linking/linkeffects/index.html">Link Effects</a></h2><p>How to apply effects to your links</p>
<h2class="children-title"id="image-effects"><ahref="/hugo-theme-relearn/authoring/linking/imageeffects/index.html">Image Effects</a></h2><p>How to apply effects to your images</p>
<h1id="pages--resources">Pages & Resources</h1>
<h2id="standard-links">Standard Links</h2>
<p>The usual way to link to a page or a resource is to use a Markdown link in the form of <code>[some page](a-page)</code> or <code></code>.</p>
<p>Images are searched in the resources of the current page and your global <code>assets</code> directory.</p>
<h2id="links-to-other-page-translations">Links to Other Page Translations</h2>
<p>By giving the query parameter <code>lang</code>, containing the language code, you can link to pages of other translations of your site, e.g. <code>[some translated page](my-page?lang=pir)</code>.</p>
<h2id="links-to-other-page-output-formats">Links to Other Page Output Formats</h2>
<p>You can link to different output formats of a page by adding the query parameter <code>format</code>. For example to link to the print format of a page, write <code>[a printable page](my-page?format=print)</code>.</p>
<p>The theme offers <ahref="/hugo-theme-relearn/authoring/markdown/index.html#link-effects">effects</a> for your linked links.</p>
<p>You can <ahref="/hugo-theme-relearn/configuration/customization/linkeffects/index.html">define additional custom link effects and set defaults</a> in your configuration.</p>
<p>The default link effects shipped with the theme are</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>download</td>
<td>Causes the linked resource to be downloaded instead of shown in your browser.<br><br>- <code>false</code>: a usual link sending you to the location in your browser<br>- <code>true</code>: a link to download the resource<br>- <em><string></em>: a link to download the resource with the given filename</td>
</tr>
<tr>
<td>target</td>
<td>Whether to show the link in a separate browser tab.<br><br>- <code>false</code>: shown in the same tab<br>- <em><string></em>: <ahref="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target"rel="external"target="_self">a valid <code>a</code><code>target</code> value</a><br><br>If <ahref="/hugo-theme-relearn/authoring/frontmatter/linking/index.html#opening-links"><code>externalLinkTarget</code> is configured</a> and the URL is external, this will overwrite the link effect value of your <code>hugo.toml</code> and page’s front matter but can still be overwritten in the URL query parameter.</td>
</tr>
</tbody>
</table>
<p>One way to use them is to add them as URL query parameter to each individual link.</p>
<p>This can become cumbersome to be done consistently for the whole site. Instead, you can <ahref="/hugo-theme-relearn/configuration/customization/linkeffects/index.html">configure the defaults</a> in your <code>hugo.toml</code> as well as overriding these defaults in a page’s front matter.</p>
<p>Explicitly set URL query parameter will override the defaults set for a page or your site.</p>
<p>If an effect accepts boolean values, only setting the parameter name without a value in the URL will set it to <code>true</code>.</p>
<p>Without any settings in your <code>hugo.toml</code><code>linkEffects</code> defaults to</p>
<p><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> This can be overridden in a pages front matter for example by</p>
<divclass="highlight wrap-code"dir="auto"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">[<spanclass="nt">Magic in new window</span>](<spanclass="na">images/magic.gif?target=_self</span>)</span></span></code></pre></div>
</div>
</div>
</div>
</div><p>The settings applied to the above link would be</p>
<p>The theme offers <ahref="/hugo-theme-relearn/authoring/markdown/index.html#image-effects">effects</a> for your linked images.</p>
<p>You can <ahref="/hugo-theme-relearn/configuration/customization/imageeffects/index.html">define additional custom image effects and set defaults</a> in your configuration.</p>
<p>The default image effects shipped with the theme are</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>border</td>
<td>Draws a light thin border around the image</td>
</tr>
<tr>
<td>dataurl</td>
<td>if the linked image points to a resource, it is converted to a base64 encoded dataurl</td>
</tr>
<tr>
<td>inlinecontent</td>
<td>if the linked image points to a SVG resource, the content will be used instead of an <code><img></code> element, this is useful for applying additional CSS styles to the elements inside of the SVG which is otherwise impossible</td>
</tr>
<tr>
<td>lazy</td>
<td>Lets the image be lazy loaded</td>
</tr>
<tr>
<td>lightbox</td>
<td>The image will be clickable to show it enlarged</td>
</tr>
<tr>
<td>shadow</td>
<td>Draws a shadow around the image to make it appear hovered/glowing</td>
</tr>
</tbody>
</table>
<p>One way to use them is to add them as URL query parameter to each individually linked image.</p>
<p>This can become cumbersome to be done consistently for the whole site. Instead, you can <ahref="/hugo-theme-relearn/configuration/customization/imageeffects/index.html">configure the defaults</a> in your <code>hugo.toml</code> as well as overriding these defaults in a page’s front matter.</p>
<p>Explicitly set URL query parameter will override the defaults set for a page or your site.</p>
<p>If an effect accepts boolean values, only setting the parameter name without a value in the URL will set it to <code>true</code>.</p>
<p>Without any settings in your <code>hugo.toml</code><code>imageEffects</code> defaults to</p>
<p><spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span> This can be overridden in a pages front matter for example by</p>
