<liitemscopeitemtype="https://schema.org/ListItem"itemprop="itemListElement"class="a11y-only"><aitemprop="item"href="/hugo-theme-relearn/pir/index.html"><spanitemprop="name">Cap'n Hugo Relearrrn Theme</span></a><metaitemprop="position"content="1"> > </li>
<p>Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.</p>
<p><strong>Marrrkdown</strong> be a better way t' write <strong>HTML</strong>, without all th' complexities an' ugliness that usually accompanies it.</p>
<p>Some o' th' key benefits be:</p>
<ol>
<li>Marrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n.</li>
<li>Less chance o' errors when writ'n 'n Marrrkdown.</li>
<li>Produces valid HTML output.</li>
<li>Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship.</li>
<li>Write 'n any text editor or Marrrkdown applicat'n ye like.</li>
<li>Marrrkdown be a joy t' use!</li>
</ol>
<p>John Gruber, th' author o' Marrrkdown, puts it like this:</p>
<blockquote>
<p>Th' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' 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>
Smarrrt Arrrse
</summary>
<divclass="box-content">
<p><iclass="fa-fw fas fa-bookmark"></i> Bookmark this plank fer easy future reference!</p>
<p>If not otherwise noted, th' shown examples adhere t' th' <ahref="https://commonmark.org/help/"rel="external"target="_self">CommonMark</a> standard. In addit'n th' theme supports th' follow'n extensions that <ahref="https://gohugo.io/getting-started/configuration-markup/#goldmark"rel="external"target="_self">can be activated</a> 'n yer <code>hugo.toml</code> or be built into th' 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 o' standard Marrrkdown adher'n t' <ahref="https://github.github.com/gfm/"rel="external"target="_self">GitHub Flavored Marrrkdown</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 o' standard Marrrkdown adher'n t' <ahref="https://michelf.ca/projects/php-markdown/extra/"rel="external"target="_self">PHP Marrrkdown</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 adher'n t' <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;">Cap'n Hugo</span></span><ahref="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension"rel="external"target="_self">Cap'n Hugo Extra Extension</a> supported by Cap'n 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 th' <ahref="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe"rel="external"target="_self">usage o' HTML</a> be allowed, th' theme supports styl'n fer 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;">Relearrrn</span></span> Extension specific t' this theme.</p>
</li>
</ul>
<h2id="paragraphs">Paragraphs</h2>
<p>In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.</p>
<p>Any text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' 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">Head'ns</h2>
<p>A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from <code>h1</code> through <code>h6</code> be constructed wit' a <code>#</code> fer each level.</p>
<p>In Hugo ye usually don’t use <code>h1</code> as this be generated by yer theme an' ye should only have one such element 'n a document.</p>
<p>T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' 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">Quotat'ns</h3>
<p>For quot'n blocks o' rrrambl'n from another source within yer document add <code>></code> before any text ye want t' 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 'n, 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 adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n 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 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.</p>
<blockquote>
<p>Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n 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 Cap'n 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> be also supported. Please note, that color'n an' ay'cons o' severities may defer between GitHub an' this theme.</p>
<p>If ye be 'n need o' more advanced opt'ns t' style yer alerts, like ay'cons, use th' <ahref="/hugo-theme-relearn/pir/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 o' certain act'ns.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Key informat'n users need t' know t' achieve their goal.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Useful informat'n that users should know, even when skimm'n rrrambl'n.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Helpful advice fer do'n th'ns better or more easily.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span>> Urgent info that needs immediate user attent'n t' 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>
Caut'n
</summary>
<divclass="box-content">
<p>Advises about risks or negative outcomes o' certain act'ns.</p>
<p>Key informat'n users need t' know t' achieve their goal.</p>
</div>
</details>
<detailsopenclass=" box cstyle notices info">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-info-circle"></i>
Ahoi
</summary>
<divclass="box-content">
<p>Informat'n that users <ins><em>might</em></ins> find interest'n.</p>
</div>
</details>
<detailsopenclass=" box cstyle notices note">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-exclamation-circle"></i>
Avast
</summary>
<divclass="box-content">
<p>Useful informat'n that users should know, even when skimm'n rrrambl'n.</p>
</div>
</details>
<detailsopenclass=" box cstyle notices tip">
<summaryclass="box-label"tabindex="-1">
<iclass="fa-fw fas fa-lightbulb"></i>
Smarrrt Arrrse
</summary>
<divclass="box-content">
<p>Helpful advice fer do'n th'ns 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>
Arrr
</summary>
<divclass="box-content">
<p>Urgent info that needs immediate user attent'n t' 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 Cap'n 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> be also supported. Which enables configur'ble title text an' expand/collapse.</p>
<p>If ye be 'n need o' more advanced opt'ns t' style yer alerts, like ay'cons, use th' <ahref="/hugo-theme-relearn/pir/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]- Be callouts fold'ble?
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span><spanclass="k">></span><spanclass="ge">Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">[!note]+ Be callouts fold'ble?
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="ge"></span>> Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed</span></span></code></pre></div>
<p>Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed</p>
</div>
</details>
</div>
</details>
<h2id="text-markers">Text Markers</h2>
<h3id="bold">Bold</h3>
<p>Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' 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 wit' **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 wit' <strong>bold text</strong></p>
</div>
</details>
<h3id="italics">Italics</h3>
<p>Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' 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 wit' _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 wit' <em>italicized text</em></p>
</div>
</details>
<h3id="marked-text">Marked Text</h3>
<p>Ye can mark text 'n th' predefined accent color o' yer 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;">Cap'n Hugo</span></span> Since Cap'n Hugo 0.126.0, ye can <ahref="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension"rel="external"target="_self">activate this through th' <em>Cap'n Hugo Extra Extension</em></a> 'n yer <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== o' 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> Ye can also use it by configur'n Hugo fer <ahref="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe"rel="external"target="_self">usage o' 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> o' this text <spanclass="p"><</span><spanclass="nt">mark</span><spanclass="p">></span>be 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> o' this text <mark>be marked!</mark></p>
</div>
</details>
<h3id="inserted-text">Inserted Text</h3>
<p>Ye can mark text addit'ns t' exist'n 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;">Cap'n Hugo</span></span> Since Cap'n Hugo 0.126.0, ye can <ahref="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension"rel="external"target="_self">activate this through th' <em>Cap'n Hugo Extra Extension</em></a> 'n yer <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> Ye can also use it by configur'n Hugo fer <ahref="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe"rel="external"target="_self">usage o' 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> Ye can do strikethroughs by enclos'n text wit' two tildes <code>~~</code>. See <ahref="https://gohugo.io/getting-started/configuration-markup/#extras"rel="external"target="_self">Hugo’s documentat'n remarks</a> if ye want t' use this together wit' th' subscript rules.</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> Ye can combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' 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">Do'ble quotes <spanclass="sb">`"`</span> an' single quotes <spanclass="sb">`'`</span> o' enclosed text be replaced by <spanclass="ge">**</span>"do'ble curly quotes"** an' <spanclass="ge">**</span>'single curly quotes'**.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">Do'ble dashes <spanclass="sb">`--`</span> an' triple dashes <spanclass="sb">`---`</span> be replaced by en-dash <spanclass="ge">**</span>--** an' em-dash <spanclass="ge">**</span>---** entities.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">Do'ble arrows point'n left <spanclass="sb">`<<`</span> or right <spanclass="sb">`>>`</span> be replaced by arrow <spanclass="ge">**</span><spanclass="err"><<</span>** an' <spanclass="ge">**</span>>>** entities.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">Three consecutive dots <spanclass="sb">`...`</span> be 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>Do'ble quotes <code>"</code> an' single quotes <code>'</code> o' enclosed text be replaced by <strong>“do'ble curly quotes”</strong> an' <strong>‘single curly quotes’</strong>.</p>
<p>Do'ble dashes <code>--</code> an' triple dashes <code>---</code> be replaced by en-dash <strong>–</strong> an' em-dash <strong>—</strong> entities.</p>
<p>Do'ble arrows point'n left <code><<</code> or right <code>>></code> be replaced by arrow <strong>«</strong> an' <strong>»</strong> entities.</p>
<p>Three consecutive dots <code>...</code> be replaced by an ellipsis <strong>…</strong> entity.</p>
<p>Ye can also use subscript an' superscript text. For more complex stuff, ye can use th' <ahref="/hugo-theme-relearn/pir/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;">Cap'n Hugo</span></span> Since Cap'n Hugo 0.126.0, ye can <ahref="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension"rel="external"target="_self">activate this through th' <em>Cap'n Hugo Extra Extension</em></a> 'n yer <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> Ye can also use it by configur'n Hugo fer <ahref="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe"rel="external"target="_self">usage o' 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> Ye can use th' <code><kbd></code> element t' 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> t' end yer 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> t' end yer shift early.</p>
</div>
</details>
<h2id="lists">Lists</h2>
<h3id="unordered">Unordered</h3>
<p>Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.</p>
<p>It be poss'ble t' nest lists by indent'n an item fer th' next sublevel.</p>
<p>Ye may use any o' <code>-</code>, <code>*</code> or <code>+</code> t' denote bullets fer 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 adipisc'n 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>Ye can create a list o' items 'n which th' order o' items does explicitly matter.</p>
<p>It be poss'ble t' nest lists by indent'n an item fer th' next sublevel.</p>
<p>Marrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be 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 'n 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 adipisc'n elit
<ol>
<li>Integer molestie lorem at massa</li>
<li>Facilisis 'n 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> Ye can add task lists result'n 'n checked or unchecked non-click'ble 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;">Relearrrn</span></span> Ye can add lists as a tree wit' configur'ble ay'cons an' colors.</p>
<p>Th' name can be followed by an optional pipe (<code>|</code>) t' define an ay'con an' further optional pipe t' define th' icon’s color.</p>
<p>More details can be found 'n th' <ahref="/hugo-theme-relearn/pir/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">Definit'ns</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> Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.</p>
<p>A definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.</p>
<p>If ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble</p>
</span></span><spanclass="line"><spanclass="cl">: Th' fruit o' an evergreen tree o' th' genus Citrus.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl"> Ye can make juice out o' it.
</span></span><spanclass="line"><spanclass="cl">: A telecommunicat'n company.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl"> Ye can't make juice out o' 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 o' plants o' th' genus Malus 'n th' family Rosaceae.</dd>
<dd>An American computer company.</dd>
<dt>Orange</dt>
<dd>Th' fruit o' an evergreen tree o' th' genus Citrus.
<p>Ye can make juice out o' it.</p>
</dd>
<dd>A telecommunicat'n company.
<p>Ye can’t make juice out o' it.</p>
</dd>
</dl>
</div>
</details>
<h2id="code">Code</h2>
<h3id="inline-code">Inline Code</h3>
<p>Inline snippets o' code can be wrapped wit' 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> be 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> be marked as code.</p>
<p>A simple code block can be generated by indent'n several lines o' 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 o' code
</span></span><spanclass="line"><spanclass="cl"> line 2 o' code
</span></span><spanclass="line"><spanclass="cl"> line 3 o' 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 o' code
line 2 o' code
line 3 o' code
</code></pre>
</div>
</details>
<h3id="fenced-code-block">Fenced Code Block</h3>
<p>If ye want t' gain more control o' yer code block ye can enclose yer 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> Ye can also add a language specifier directly after th' open'n fence, <code>```js</code>, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.</p>
<p>See <ahref="/hugo-theme-relearn/pir/shortcodes/highlight/index.html">Code Highlight'n</a> fer additional documentat'n.</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> Ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.</p>
</span></span><spanclass="line"><spanclass="cl">| data | 1 | path t' data files t' supply th' data that will be passed into templates. |
</span></span><spanclass="line"><spanclass="cl">| engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. |
</span></span><spanclass="line"><spanclass="cl">| ext | 3 | extension t' be used fer 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">Opt'n</th>
<thstyle="text-align: center">Number</th>
<thstyle="text-align: left">Descript'n</th>
</tr>
</thead>
<tbody>
<tr>
<tdstyle="text-align: right">data</td>
<tdstyle="text-align: center">1</td>
<tdstyle="text-align: left">path t' data files t' supply th' 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 t' be used fer process'n templates. Handlebars be th' default.</td>
</tr>
<tr>
<tdstyle="text-align: right">ext</td>
<tdstyle="text-align: center">3</td>
<tdstyle="text-align: left">extension t' be used fer 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 be a link t' 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 be a link t' <ahref="https://example.com"rel="external"target="_self">https://example.com</a>.</p>
</div>
</details>
<h3id="basic-link">Basic Link</h3>
<p>Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.</p>
<p>Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.</p>
</span></span><spanclass="line"><spanclass="cl">[somelinkID]: https://example.com "Go t' 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 t' 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 be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.</p>
<p>Usually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.</p>
<p>Footnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.</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 wit' a footnote[^1]
<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;">Relearrrn</span></span> This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' URL. See th' <ahref="/hugo-theme-relearn/pir/authoring/linking/linkeffects/index.html">link effects docs</a> fer a detailed example an' how t' configure it.</p>
<h4id="target">Target</h4>
<p>Add query parameter <code>target=_self</code> or <code>target=_blank</code> t' override <ahref="/hugo-theme-relearn/pir/authoring/frontmatter/linking/index.html#opening-links">site-wide sett'ns</a> o' <ahref="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target"rel="external"target="_self">th' target behavior</a> individuallly fer 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 'n 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/pir/images/magic.gif?target=_blank"target="_blank">Magic 'n new window</a></p>
</div>
</details>
<h4id="download">Download</h4>
<p>Add query parameter <code>download</code> or <code>download=myfile.gif</code> t' force yer browser <ahref="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download"rel="external"target="_self">t' download th' link target</a> instead o' open'n 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/pir/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 rules t' links but include a preced'n exclamat'n mark.</p>
<p>Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n 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;">Relearrrn</span></span> This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. See th' <ahref="/hugo-theme-relearn/pir/authoring/linking/imageeffects/index.html">image effects docs</a> fer a detailed example an' how t' configure it.</p>
<h4id="resizing">Resiz'n</h4>
<p>Add query parameter <code>width</code> and/or <code>height</code> t' th' link image t' resize th' image. Values be CSS values (default be <code>auto</code>).</p>
<p>Add a query parameter <code>classes</code> t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.</p>
<p>If ye want t' wrap an image 'n a link an' <code>lightbox=true</code> be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:</p>