<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>
<p>Built with <ahref="https://github.com/McShelby/hugo-theme-relearn"title="love"><iclass="fas fa-heart"></i></a> by <ahref="https://gohugo.io/">Hugo</a></p>
<script>
function githubButtonsScheme(){
var scheme = 'light';
var colorPropertyValue = window.getComputedStyle( document.querySelector( '#R-sidebar' ) ).getPropertyValue( 'background-color' );
var colorValues = colorPropertyValue.match( /\d+/g ).map( function( e ){ return parseInt(e,10); });
<aclass="github-button"href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip"data-color-scheme="${scheme}"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-color-scheme="${scheme}"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-color-scheme="${scheme}"data-icon="octicon-repo-forked"data-show-count="true"aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
