Basic Syntax
Markdown is intended to be as easy-to-read and easy-to-write as is feasible.
John Gruber
References
- Markdown (Daring Fireball)
- CommonMark Spec
- GitHub Flavored Markdown (GFM) Spec
- Cheat Sheet (Markdown Guide)
All
HTMLoutput examples are generated withpandoc.pandoc -f gfm -t html <<< '**Markdown**'# <p><strong>Markdown</strong></p>
Section Heading <h1> - <h6>
h1
h2
h3
h4
h5
h6
# h1
## h2
### h3
#### h4
##### h5
###### h6<h1 id="h1">h1</h1><h2 id="h2">h2</h2><h3 id="h3">h3</h3><h4 id="h4">h4</h4><h5 id="h5">h5</h5><h6 id="h6">h6</h6>Inline Code <code>
A fragment of computer code:
element name (code),
filename (index.html),
computer program (cat),
or any string a computer would recognize (~, if, else).
a fragment of computer code:element name (`code`),filename (`index.html`),computer program (`cat`),or any string a computer would recognize (`~`,`if`,`else`).<p> a fragment of computer code: element name (<code>code</code>), filename (<code>index.html</code>), computer program (<code>cat</code>), or any string a computer would recognize (<code>~</code>, <code>if</code>, <code>else</code>).</p>Emphasis <em>
Stress emphasis on the right syllable.
stress _emphasis_ on the right _syllable_.<p> Stress <em>emphasis</em> on the right <em>syllable</em>.</p>Strong Importance <strong>
Strong importance:
it should not be used to apply bold styling, use css for that.
Don't use <b> for styling either!
**Strong importance:**it should not be used to apply **bold styling**, use **`css`** for that.**Don't use** `<b>` for styling either!<p> <strong>strong importance:</strong> it should not be used to apply <strong>bold styling</strong>, use <strong><code>css</code></strong> for that. <strong>don't use</strong> <code><b></code> for styling either!</p>Block Quotation <blockquote>
The
blockquoteelement represents a section that is quoted from another source.Example
<blockquote><p>[Jane] then said she liked [...] fish.</p></blockquote>
> The `blockquote` element represents a section that is quoted from _another source_.>>> **Example**>>>> ```html>> <blockquote>>> <p>[Jane] then said she liked [...] fish.</p>>> </blockquote>>> ```<blockquote> <p> The <code>blockquote</code> element represents a section that is quoted from <em>another source</em>. </p> <blockquote> <p><strong>Example</strong></p> <div class="sourceCode" id="cb1"><pre class="sourceCode html"><code class="sourceCode html"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="dt"><</span><span class="kw">blockquote</span><span class="dt">></span></span><span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> <span class="dt"><</span><span class="kw">p</span><span class="dt">></span>[Jane] then said she liked [...] fish.<span class="dt"></</span><span class="kw">p</span><span class="dt">></span></span><span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="dt"></</span><span class="kw">blockquote</span><span class="dt">></span></span></code></pre></div> </blockquote></blockquote>Image <img>

<p> <img src="/images/lume-logo.png" alt="Astro mascot with a hard hat" /> <img src="/images/twemoji/full-moon-face-1f31d.svg" title="tooltip: full moon face" alt="full moon face, twitter emoji" /> <img src="/no-directory/images/not-available.png" alt="replacement text if the image isn't available" /></p>Anchor/Hyperlink <a>
link to usage, astro, anchor to code section
link to [usage](../../usage/),[astro](https://docs.astro.build/en/getting-started/),anchor to [code section](#inline-code-code)<p> link to <a href="../../usage/">usage</a>, <a href="https://docs.astro.build/en/getting-started/">astro</a>, anchor to <a href="#inline-code-code">code section</a></p>Unordered List <ul>
- apple
- Fuji
- Granny Smith
- Honeycrisp
- Gala
- Red Delicious
- Golden Delicious
- Pink Lady
- Braeburn
- Jonagold
- McIntosh.
- dog
- small
- Chihuahua
- Pomeranian
- Yorkshire Terrier
- Shih Tzu
- Dachshund
- Pug
- French Bulldog
- Boston Terrier
- Maltese
- Cavalier King Charles Spaniel.
- small
- number
- positive
- 1
- 1.01
- 1.1
- 2
- 3
- 1
- negative
- -1
- -1.01
- -1.1
- -2
- -3
- -1
- positive
- apple - Fuji - Granny Smith - Honeycrisp - Gala - Red Delicious - Golden Delicious - Pink Lady - Braeburn - Jonagold - McIntosh.- dog - small - Chihuahua - Pomeranian - Yorkshire Terrier - Shih Tzu - Dachshund - Pug - French Bulldog - Boston Terrier - Maltese - Cavalier King Charles Spaniel.- number - positive - 1 - 1.01 - 1.1 - 2 - 3 - negative - -1 - -1.01 - -1.1 - -2 - -3<ul> <li> apple <ul> <li>Fuji</li> <li>Granny Smith</li> <li>Honeycrisp</li> <li>Gala</li> <li>Red Delicious</li> <li>Golden Delicious</li> <li>Pink Lady</li> <li>Braeburn</li> <li>Jonagold</li> <li>McIntosh.</li> </ul> </li> <li> dog <ul> <li> small <ul> <li>Chihuahua</li> <li>Pomeranian</li> <li>Yorkshire Terrier</li> <li>Shih Tzu</li> <li>Dachshund</li> <li>Pug</li> <li>French Bulldog</li> <li>Boston Terrier</li> <li>Maltese</li> <li>Cavalier King Charles Spaniel.</li> </ul> </li> </ul> </li> <li> number <ul> <li> positive <ul> <li> 1 <ul> <li>1.01</li> <li>1.1</li> </ul> </li> <li>2</li> <li>3</li> </ul> </li> <li> negative <ul> <li> -1 <ul> <li>-1.01</li> <li>-1.1</li> </ul> </li> <li>-2</li> <li>-3</li> </ul> </li> </ul> </li></ul>Ordered List <ol>
- item 01
- item 02
- item 03
1. item 011. item 021. item 03<ol type="1"> <li>item 01</li> <li>item 02</li> <li>item 03</li></ol>Thematic Break <hr>
This is topic 1.
This is topic 2.
This is topic 3.
This is topic 4.
This is topic 1.
---
This is topic 2.
***
This is topic 3.
___
This is topic 4.<p>This is topic 1.</p><hr><p>This is topic 2.</p><hr><p>This is topic 3.</p><hr><p>This is topic 4.</p>