<aclass=github-buttonhref=https://github.com/McShelby/hugo-theme-relearn/archive/main.zipdata-icon=octicon-cloud-downloadaria-label="Download McShelby/hugo-theme-relearn on GitHub">Download</a>
<aclass=github-buttonhref=https://github.com/McShelby/hugo-theme-relearndata-icon=octicon-stardata-show-count=truearia-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
<aclass=github-buttonhref=https://github.com/McShelby/hugo-theme-relearn/forkdata-icon=octicon-repo-forkeddata-show-count=truearia-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
<p>Built with <ahref=https://github.com/McShelby/hugo-theme-relearn><iclass="fas fa-heart"></i></a> by <ahref=https://gohugo.io/>Hugo</a></p>
<aclass=github-linktitle="Edit this plank"href=https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/cont/markdown.pir.mdtarget=blank>
<p>Let’s face it: Writ'n rambl'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 rambl'n.</li>
<li>Less chance o' errors when writ'n 'n Marrrkdown.</li>
<li>Produces valid XHTML output.</li>
<li>Keeps th' rambl'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>
<p>Without further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:</p>
<divclass="notices info">
<divclass=label>Ahoi</div><p><iclass="fas fa-bookmark"></i> Bookmark this plank an' th' <ahref=https://commonmark.org/help/>official Commonmark reference</a> fer easy future reference!</p>
</div>
<h2id=headings>Head'ns</h2>
<p>Head'ns from <code>h1</code> through <code>h6</code> be constructed wit' a <code>#</code> fer each level:</p>
</code></pre></div><p>Comment below should <strong>NOT</strong> be seen:</p>
<h2id=horizontal-rules>Horizontal Rules</h2>
<p>Th' HTML <code><hr></code> element be fer creat'n a “thematic break” between paragraph-level elements. In Marrrkdown, ye can create a <code><hr></code> wit' <code>---</code> - three consecutive dashes</p>
<p>renders t':</p>
<hr>
<h2id=paragraphs>Paragraphs</h2>
<p>Any text not start'n wit' a special sign be written as normal, plain text an' will be wrapped within <code><p></p></code> tags 'n th' rendered HTML.</p>
<p>So this body copy:</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
</code></pre></div><p>renders t' this HTML:</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-htmldata-lang=html><<spanstyle=color:#ff6ac1>p</span>>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</<spanstyle=color:#ff6ac1>p</span>>
<p>For emphasiz'n a snippet o' text wit' a heavier font-weight.</p>
<p>Th' follow'n snippet o' text be <strong>rendered as bold text</strong>.</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown>**rendered as bold text**
</code></pre></div><p>renders t':</p>
<p><strong>rendered as bold text</strong></p>
<p>an' this HTML</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-htmldata-lang=html><<spanstyle=color:#ff6ac1>strong</span>>rendered as bold text</<spanstyle=color:#ff6ac1>strong</span>>
</code></pre></div><h3id=italics>Italics</h3>
<p>For emphasiz'n a snippet o' text wit' italics.</p>
<p>Th' follow'n snippet o' text be <em>rendered as italicized text</em>.</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown>_rendered as italicized text_
</code></pre></div><p>renders t':</p>
<p><em>rendered as italicized text</em></p>
<p>an' this HTML:</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-htmldata-lang=html><<spanstyle=color:#ff6ac1>em</span>>rendered as italicized text</<spanstyle=color:#ff6ac1>em</span>>
<p>In GFM (GitHub flavored Markdown) ye can do strikethroughs.</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown>~~Strike through this text.~~
</code></pre></div><p>Which renders t':</p>
<p><del>Strike through this text.</del></p>
<p>HTML:</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-htmldata-lang=html><<spanstyle=color:#ff6ac1>del</span>>Strike through this text.</<spanstyle=color:#ff6ac1>del</span>>
<p>For quot'n blocks o' rambl'n from another source within yer document.</p>
<p>Add <code>></code> before any text ye want t' quote.</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown><spanstyle=color:#ff6ac1>></span><spanstyle="text-decorat'n:underline">**Fusion Drive** combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.
</span></code></pre></div><p>Renders t':</p>
<blockquote>
<p><strong>Fusion Drive</strong> combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.</p>
<<spanstyle=color:#ff6ac1>p</span>><<spanstyle=color:#ff6ac1>strong</span>>Fusion Drive</<spanstyle=color:#ff6ac1>strong</span>> combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.</<spanstyle=color:#ff6ac1>p</span>>
</code></pre></div><p>Blockquotes can also be nested:</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown><spanstyle=color:#ff6ac1>></span><spanstyle="text-decorat'n:underline">Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
</span><spanstyle=color:#ff6ac1></span><spanstyle="text-decorat'n:underline">>> 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><spanstyle=color:#ff6ac1></span><spanstyle="text-decorat'n:underline">> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
</span></code></pre></div><p>Renders t':</p>
<blockquote>
<p>Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue 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>
<h2id=lists>Lists</h2>
<h3id=unordered>Unordered</h3>
<p>A list o' items 'n which th' order o' th' items does not explicitly matter.</p>
<p>Ye may use any o' th' follow'n symbols t' denote bullets fer each list item:</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown>+ Lorem ipsum dolor sit amet
+ Consectetur adipisc'n elit
+ Integer molestie lorem at massa
+ Facilisis 'n pretium nisl aliquet
+ Nulla volutpat aliquam velit
<spanstyle=color:#ff6ac1>-</span> Phasellus iaculis neque
<spanstyle=color:#ff6ac1>-</span> Purus sodales ultricies
<spanstyle=color:#ff6ac1>-</span> Vestibulum laoreet porttitor sem
<spanstyle=color:#ff6ac1>-</span> Ac tristique libero volutpat at
<p>A list o' items 'n which th' order o' items does explicitly matter.</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown><spanstyle=color:#ff6ac1>1.</span> Lorem ipsum dolor sit amet
<divclass=label>Smarrrt Arrrse</div><p>If ye just use <code>1.</code> fer each number, Marrrkdown will automatically number each item. For example:</p>
</div>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown><spanstyle=color:#ff6ac1>1.</span> Lorem ipsum dolor sit amet
<spanstyle=color:#ff6ac1>1.</span> Integer molestie lorem at massa
<spanstyle=color:#ff6ac1>1.</span> Facilisis 'n pretium nisl aliquet
<spanstyle=color:#ff6ac1>1.</span> Nulla volutpat aliquam velit
<spanstyle=color:#ff6ac1>1.</span> Faucibus porta lacus fringilla vel
<spanstyle=color:#ff6ac1>1.</span> Aenean sit amet erat nunc
<spanstyle=color:#ff6ac1>1.</span> Eget porttitor lorem
</code></pre></div><p>Renders t':</p>
<ol>
<li>Lorem ipsum dolor sit amet</li>
<li>Consectetur adipisc'n elit</li>
<li>Integer molestie lorem at massa</li>
<li>Facilisis 'n pretium nisl aliquet</li>
<li>Nulla volutpat aliquam velit</li>
<li>Faucibus porta lacus fringilla vel</li>
<li>Aenean sit amet erat nunc</li>
<li>Eget porttitor lorem</li>
</ol>
<h2id=code>Code</h2>
<h3id=inline-code>Inline code</h3>
<p>Wrap inline snippets o' code wit' <code>`</code>.</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown>In this example, <spanstyle=color:#5af78e>`<div></div>`</span> should be wrapped as <spanstyle=font-style:italic>**code**</span>.
</code></pre></div><p>Renders t':</p>
<p>In this example, <code><div></div></code> should be wrapped as <strong>code</strong>.</p>
<p>HTML:</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-htmldata-lang=html><<spanstyle=color:#ff6ac1>p</span>>In this example, <<spanstyle=color:#ff6ac1>code</span>>&lt;div&gt;&lt;/div&gt;</<spanstyle=color:#ff6ac1>code</span>> should be wrapped as <<spanstyle=color:#ff6ac1>strong</span>>code</<spanstyle=color:#ff6ac1>strong</span>>.</<spanstyle=color:#ff6ac1>p</span>>
<p>Or indent several lines o' code by at least two spaces, as 'n:</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown> // Some comments
<p>GFM, or “GitHub Flavored Markdown” also supports rules highlight'n. T' activate it, usually ye simply add th' file extension o' th' language ye want t' use directly aft th' first code “fence”, <code>```js</code>, an' rules highlight'n will automatically be applied 'n th' rendered HTML.</p>
<p>Tables be created 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>
<<spanstyle=color:#ff6ac1>td</span>>path t' data files t' supply th' data that will be passed into templates.</<spanstyle=color:#ff6ac1>td</span>>
<<spanstyle=color:#ff6ac1>td</span>>engine t' be used fer process'n templates. Handlebars be th' default.</<spanstyle=color:#ff6ac1>td</span>>
<p>Named anchors en'ble ye t' jump t' th' specified anchor point on th' same plank. For example, each o' these chapters:</p>
<divclass=highlight><pretabindex=0style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-markdowndata-lang=markdown><spanstyle=font-weight:700># T'ble o' Contents
</span><spanstyle=font-weight:700></span>Rambl'n fer chapter one.
</code></pre></div><p><strong>NOTE</strong> that specific placement o' th' anchor tag seems t' be arbitrary. They be placed inline here since it seems t' be unobtrusive, an' it works.</p>
<h2id=images>Images</h2>
<p>Images have a similar rules t' links but include a preced'n exclamat'n point.</p>
<p>Add a HTTP <code>classes</code> parameter t' th' link image t' add CSS classes. <code>shadow</code>an' <code>border</code> be avail'ble but ye could define other ones.</p>
<p>Add a HTTP <code>featherlight</code> parameter t' th' link image t' dis'ble lightbox. By default lightbox be enabled us'n th' featherlight.js plugin. Ye can dis'ble this by defin'n <code>featherlight</code> t' <code>false</code>.</p>
