congo/blog/markdown-syntax/index.html

242 lines
12 KiB
HTML

<!doctype html><html lang=en-au><head>
<meta charset=utf-8>
<meta http-equiv=content-language content="en-AU">
<meta name=viewport content="width=device-width,initial-scale=1">
<meta http-equiv=x-ua-compatible content="ie=edge">
<title>Markdown Syntax Guide &#183; Congo</title>
<meta name=title content="Markdown Syntax Guide &#183; Congo">
<meta name=description content="Sample article showcasing basic Markdown syntax and formatting for HTML elements.">
<base href=https://jpanther.github.io/Congo/>
<link rel=canonical href=https://jpanther.github.io/Congo/blog/markdown-syntax/>
<link type=text/css rel=stylesheet href=https://jpanther.github.io/Congo/css/main.css>
<link rel=apple-touch-icon sizes=180x180 href=https://jpanther.github.io/apple-touch-icon.png>
<link rel=icon type=image/png sizes=32x32 href=https://jpanther.github.io/favicon-32x32.png>
<link rel=icon type=image/png sizes=16x16 href=https://jpanther.github.io/favicon-16x16.png>
<link rel=manifest href=https://jpanther.github.io/site.webmanifest>
<meta property="og:title" content="Markdown Syntax Guide">
<meta property="og:description" content="Sample article showcasing basic Markdown syntax and formatting for HTML elements.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://jpanther.github.io/Congo/blog/markdown-syntax/"><meta property="article:section" content="blog">
<meta property="article:published_time" content="2019-03-11T00:00:00+00:00">
<meta property="article:modified_time" content="2019-03-11T00:00:00+00:00">
<meta name=twitter:card content="summary">
<meta name=twitter:title content="Markdown Syntax Guide">
<meta name=twitter:description content="Sample article showcasing basic Markdown syntax and formatting for HTML elements.">
<meta name=generator content="Hugo 0.87.0">
<meta name=author content="Freddy Blogger">
<link href=https://twitter.com/ rel=me>
<link href=https://github.com/ rel=me>
<link href=https://linkedin.com/ rel=me>
</head>
<body class="flex flex-col h-screen px-8 text-lg leading-7 text-grey-900 sm:px-14 md:px-24 lg:px-32 dark:bg-gray-800 dark:text-white"><header class="flex justify-between py-10 font-semibold">
<div>
<a class=hover:underline rel=me href=https://jpanther.github.io/Congo/>Congo</a>
</div>
<nav>
<ul class="flex list-none">
<li class="mr-7 last:mr-0">
<a class=hover:underline href=/Congo/blog/ title=Blog>Blog</a>
</li>
<li class="mr-7 last:mr-0">
<a class=hover:underline href=/Congo/about/ title=About>About</a>
</li>
<li class="mr-7 last:mr-0">
<a class=hover:underline href=tags title>Tags</a>
</li>
</ul>
</nav>
</header>
<main class=flex-grow>
<article class=max-w-prose>
<header>
<h1 class="mt-0 text-4xl font-extrabold">Markdown Syntax Guide</h1>
<div class="mt-8 mb-12 text-base text-gray-400 dark:text-gray-500">
<time datetime="2019-03-11 00:00:00 +0000 UTC">11 March 2019</time>
<span class=px-1>&#183;</span>
<span title="Reading time">
3
mins
</span>
</div>
</header>
<section class="prose dark:prose-light">
<p>This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.</p>
<h2 id=headings>Headings&nbsp;<a class=heading-anchor href=#headings aria-label=Anchor>#</a> </h2>
<p>The following HTML <code>&lt;h1></code><code>&lt;h6></code> elements represent six levels of section headings. <code>&lt;h1></code> is the highest section level while <code>&lt;h6></code> is the lowest.</p>
<h1 id=h1>H1</h1>
<h2 id=h2>H2&nbsp;<a class=heading-anchor href=#h2 aria-label=Anchor>#</a> </h2>
<h3 id=h3>H3&nbsp;<a class=heading-anchor href=#h3 aria-label=Anchor>#</a> </h3>
<h4 id=h4>H4&nbsp;<a class=heading-anchor href=#h4 aria-label=Anchor>#</a> </h4>
<h5 id=h5>H5</h5>
<h6 id=h6>H6</h6>
<h2 id=paragraph>Paragraph&nbsp;<a class=heading-anchor href=#paragraph aria-label=Anchor>#</a> </h2>
<p>Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.</p>
<p>Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.</p>
<h2 id=blockquotes>Blockquotes&nbsp;<a class=heading-anchor href=#blockquotes aria-label=Anchor>#</a> </h2>
<p>The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a <code>footer</code> or <code>cite</code> element, and optionally with in-line changes such as annotations and abbreviations.</p>
<h4 id=blockquote-without-attribution>Blockquote without attribution&nbsp;<a class=heading-anchor href=#blockquote-without-attribution aria-label=Anchor>#</a> </h4>
<blockquote>
<p>Tiam, ad mint andaepu dandae nostion secatur sequo quae.
<strong>Note</strong> that you can use <em>Markdown syntax</em> within a blockquote.</p>
</blockquote>
<h4 id=blockquote-with-attribution>Blockquote with attribution&nbsp;<a class=heading-anchor href=#blockquote-with-attribution aria-label=Anchor>#</a> </h4>
<blockquote>
<p>Don&rsquo;t communicate by sharing memory, share memory by communicating.
— Rob Pike<sup id=fnref:1><a href=#fn:1 class=footnote-ref role=doc-noteref>1</a></sup></p>
</blockquote>
<h2 id=tables>Tables&nbsp;<a class=heading-anchor href=#tables aria-label=Anchor>#</a> </h2>
<p>Tables aren&rsquo;t part of the core Markdown spec, but Hugo supports supports them out-of-the-box.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Age</th>
</tr>
</thead>
<tbody>
<tr>
<td>Bob</td>
<td>27</td>
</tr>
<tr>
<td>Alice</td>
<td>23</td>
</tr>
</tbody>
</table>
<h4 id=inline-markdown-within-tables>Inline Markdown within tables&nbsp;<a class=heading-anchor href=#inline-markdown-within-tables aria-label=Anchor>#</a> </h4>
<table>
<thead>
<tr>
<th>Italics</th>
<th>Bold</th>
<th>Code</th>
</tr>
</thead>
<tbody>
<tr>
<td><em>italics</em></td>
<td><strong>bold</strong></td>
<td><code>code</code></td>
</tr>
</tbody>
</table>
<h2 id=code-blocks>Code Blocks&nbsp;<a class=heading-anchor href=#code-blocks aria-label=Anchor>#</a> </h2>
<h4 id=code-block-with-backticks>Code block with backticks&nbsp;<a class=heading-anchor href=#code-block-with-backticks aria-label=Anchor>#</a> </h4>
<div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html><span style=color:#75715e>&lt;!DOCTYPE html&gt;</span>
&lt;<span style=color:#f92672>html</span> <span style=color:#a6e22e>lang</span><span style=color:#f92672>=</span><span style=color:#e6db74>&#34;en&#34;</span>&gt;
&lt;<span style=color:#f92672>head</span>&gt;
&lt;<span style=color:#f92672>meta</span> <span style=color:#a6e22e>charset</span><span style=color:#f92672>=</span><span style=color:#e6db74>&#34;utf-8&#34;</span> /&gt;
&lt;<span style=color:#f92672>title</span>&gt;Example HTML5 Document&lt;/<span style=color:#f92672>title</span>&gt;
&lt;/<span style=color:#f92672>head</span>&gt;
&lt;<span style=color:#f92672>body</span>&gt;
&lt;<span style=color:#f92672>p</span>&gt;Test&lt;/<span style=color:#f92672>p</span>&gt;
&lt;/<span style=color:#f92672>body</span>&gt;
&lt;/<span style=color:#f92672>html</span>&gt;
</code></pre></div><h4 id=code-block-indented-with-four-spaces>Code block indented with four spaces&nbsp;<a class=heading-anchor href=#code-block-indented-with-four-spaces aria-label=Anchor>#</a> </h4>
<pre><code>&lt;!doctype html&gt;
&lt;html lang=&quot;en&quot;&gt;
&lt;head&gt;
&lt;meta charset=&quot;utf-8&quot;&gt;
&lt;title&gt;Example HTML5 Document&lt;/title&gt;
&lt;/head&gt;
&lt;body&gt;
&lt;p&gt;Test&lt;/p&gt;
&lt;/body&gt;
&lt;/html&gt;
</code></pre>
<h4 id=code-block-with-hugos-internal-highlight-shortcode>Code block with Hugo&rsquo;s internal highlight shortcode&nbsp;<a class=heading-anchor href=#code-block-with-hugos-internal-highlight-shortcode aria-label=Anchor>#</a> </h4>
<div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html><span style=color:#75715e>&lt;!doctype html&gt;</span>
&lt;<span style=color:#f92672>html</span> <span style=color:#a6e22e>lang</span><span style=color:#f92672>=</span><span style=color:#e6db74>&#34;en&#34;</span>&gt;
&lt;<span style=color:#f92672>head</span>&gt;
&lt;<span style=color:#f92672>meta</span> <span style=color:#a6e22e>charset</span><span style=color:#f92672>=</span><span style=color:#e6db74>&#34;utf-8&#34;</span>&gt;
&lt;<span style=color:#f92672>title</span>&gt;Example HTML5 Document&lt;/<span style=color:#f92672>title</span>&gt;
&lt;/<span style=color:#f92672>head</span>&gt;
&lt;<span style=color:#f92672>body</span>&gt;
&lt;<span style=color:#f92672>p</span>&gt;Test&lt;/<span style=color:#f92672>p</span>&gt;
&lt;/<span style=color:#f92672>body</span>&gt;
&lt;/<span style=color:#f92672>html</span>&gt;</code></pre></div>
<h2 id=list-types>List Types&nbsp;<a class=heading-anchor href=#list-types aria-label=Anchor>#</a> </h2>
<h4 id=ordered-list>Ordered List&nbsp;<a class=heading-anchor href=#ordered-list aria-label=Anchor>#</a> </h4>
<ol>
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
</ol>
<h4 id=unordered-list>Unordered List&nbsp;<a class=heading-anchor href=#unordered-list aria-label=Anchor>#</a> </h4>
<ul>
<li>List item</li>
<li>Another item</li>
<li>And another item</li>
</ul>
<h4 id=nested-list>Nested list&nbsp;<a class=heading-anchor href=#nested-list aria-label=Anchor>#</a> </h4>
<ul>
<li>Fruit
<ul>
<li>Apple</li>
<li>Orange</li>
<li>Banana</li>
</ul>
</li>
<li>Dairy
<ul>
<li>Milk</li>
<li>Cheese</li>
</ul>
</li>
</ul>
<h2 id=other-elements--abbr-sub-sup-kbd-mark>Other Elements — abbr, sub, sup, kbd, mark&nbsp;<a class=heading-anchor href=#other-elements--abbr-sub-sup-kbd-mark aria-label=Anchor>#</a> </h2>
<p>GIF is a bitmap image format.</p>
<p>H2O</p>
<p>Xn + Yn = Zn</p>
<p>Press CTRL+ALT+Delete to end the session.</p>
<p>Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.</p>
<section class=footnotes role=doc-endnotes>
<hr>
<ol>
<li id=fn:1 role=doc-endnote>
<p>The above quote is excerpted from Rob Pike&rsquo;s <a href="https://www.youtube.com/watch?v=PAAkCSZUG1c">talk</a> during Gopherfest, November 18, 2015.&#160;<a href=#fnref:1 class=footnote-backref role=doc-backlink>&#8617;&#xfe0e;</a></p>
</li>
</ol>
</section>
</section>
<footer>
<div class="flex items-center pt-8">
<img class="w-24 h-24 !mt-0 !mb-0 mr-4 rounded-full" src="https://i.pravatar.cc/150?img=11">
<div>
<div class="font-semibold leading-6 text-gray-800 dark:text-gray-300">
Freddy Blogger
</div>
<div class="flex text-lg text-gray-400 dark:text-gray-500">
<a class="mr-2 hover:text-primary-700 dark:hover:text-primary-400" href=https://twitter.com/ target=_blank title=Twitter><span class="relative inline-block align-text-bottom icon">
icons/twitter-brands.svg
</span>
</a>
<a class="mr-2 hover:text-primary-700 dark:hover:text-primary-400" href=https://github.com/ target=_blank title=GitHub><span class="relative inline-block align-text-bottom icon">
icons/github-brands.svg
</span>
</a>
<a class="mr-2 hover:text-primary-700 dark:hover:text-primary-400" href=https://linkedin.com/ target=_blank title=Linkedin><span class="relative inline-block align-text-bottom icon">
icons/linkedin-brands.svg
</span>
</a>
</div>
</div>
</div>
</footer>
</article>
</main><footer class="py-10 text-sm">
<p class="text-gray-400 dark:text-gray-500">
&copy;
2021
Freddy Blogger
</p>
<p class="text-xs text-gray-300 dark:text-gray-600">
Powered by
<a class=hover:underline href=https://gohugo.io/ target=_blank>Hugo</a>
&
<a class=hover:underline href=https://git.io/hugo-congo target=_blank>Congo</a>
</p>
</footer>
</body>
</html>