<metaname="description"content="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.">
<metaname="twitter:description"content="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.">
<metaproperty="og:description"content="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.">
<metaitemprop="description"content="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>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>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.
<p>If not otherwise noted, th' showed 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>
<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>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></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>
<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>
<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>
<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"><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>
<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>
<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"><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>
<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>
<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"><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"><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>
<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"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">Th' ++hot, new++ stuff</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>
<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>.</p>
<divclass="highlight wrap-code"><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"><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">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">Three consecutive dots <spanclass="sb">`...`</span> be replaced by an ellipsis <spanclass="ge">**</span>...** entity.</span></span></code></pre></div>
<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"><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"><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>
<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"><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>
<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"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl"><spanclass="k">-</span> Lorem ipsum dolor sit amet
<divclass="highlight wrap-code"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Lorem ipsum dolor sit amet
<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"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl"><spanclass="k">- [x]</span> Basic Test
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></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>
<divclass="highlight wrap-code"><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>
<divclass="highlight wrap-code"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">Be impressed by my advanced code:
<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><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>
<divclass="highlight wrap-code"><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>
<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>
<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"><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>
<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>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></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"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">That's some text wit' a footnote[^1]
<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>
<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. Th' default <ahref="/hugo-theme-relearn/pir/cont/imageeffects/index.html">behavior be configur'ble</a> through yer <code>hugo.toml</code> or frontmatter parameter.</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>
