<metaname="description"content="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.">
<metaname="twitter:description"content="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.">
<metaproperty="og:description"content="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.">
<metaitemprop="description"content="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>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>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.
<p>If not otherwise noted, the showed 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>
<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>
<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 of standard Markdown adhering to <ahref="https://michelf.ca/projects/php-markdown/extra/"rel="external"target="_self">PHP Markdown</a>.</p>
<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>
<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>
<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>
<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>
<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"><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 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"><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>
<divclass="highlight wrap-code"><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>
<divclass="highlight wrap-code"><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>
<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"><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"><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>
<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>
<divclass="highlight wrap-code"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">The ++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> 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"><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"><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">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">Three consecutive dots <spanclass="sb">`...`</span> are replaced by an ellipsis <spanclass="ge">**</span>...** entity.</span></span></code></pre></div>
<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>
<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"><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"><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> You can use the <code><kbd></code> element to 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> to end your shift early.</span></span></code></pre></div>
<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"><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> You can add task lists resulting in checked or unchecked non-clickable 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> 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>
<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> is 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> 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><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>
<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 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>
<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>
<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 is a link to https://example.com.</span></span></code></pre></div>
<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>
<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 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"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">That's some text with a footnote[^1]
<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>
<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. The default <ahref="/hugo-theme-relearn/cont/imageeffects/index.html">behavior is configurable</a> through your <code>hugo.toml</code> or frontmatter parameter.</p>
<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>
