Part 1: Basic markdown syntax | Surfland Theme by SURFVERSE.COM & Bogdan Mateescu

Overview

Nearly all Markdown applications support the basic syntax outlined in the original Markdown design document. There are minor variations and discrepancies between Markdown processors — those are noted inline wherever possible. 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.

if ([1,"one",2,"two"].includes(value)){
  console.log("Number is either 1 or 2.");  // comment
}

Math

\[ \begin{aligned} KL(\hat{y} || y) &= \sum_{c=1}^{M}\hat{y}_c \log{\frac{\hat{y}_c}{y_c}} \\ JS(\hat{y} || y) &= \frac{1}{2}(KL(y||\frac{y+\hat{y}}{2}) + KL(\hat{y}||\frac{y+\hat{y}}{2})) \end{aligned} \]

Notice Alert

This is a default notice.

This is a success notice.

This is a error notice. Be warned!

This is a warning notice. Be warned!

Task List

a task list item
list syntax required
incomplete
completed

Headings

To create a heading, add number signs (#) in front of a word or phrase. The number of number signs you use should correspond to the heading level. For example, to create a heading level three (<h3>), use three number signs (e.g., ### My Header).

Markdown	HTML	Rendered Output
`# Heading level 1`	`<h1>Heading level 1</h1>`	Heading level 1
`## Heading level 2`	`<h2>Heading level 2</h2>`	Heading level 2
`### Heading level 3`	`<h3>Heading level 3</h3>`	Heading level 3
`#### Heading level 4`	`<h4>Heading level 4</h4>`	Heading level 4
`##### Heading level 5`	`<h5>Heading level 5</h5>`	Heading level 5
`###### Heading level 6`	`<h6>Heading level 6</h6>`	Heading level 6

Alternate Syntax

Alternatively, on the line below the text, add any number of == characters for heading level 1 or -- characters for heading level 2.

Markdown	HTML	Rendered Output
`Heading level 1 ===============`	`<h1>Heading level 1</h1>`	Heading level 1
`Heading level 2 ---------------`	`<h2>Heading level 2</h2>`	Heading level 2

Heading Best Practices

Markdown applications don’t agree on how to handle a missing space between the number signs (#) and the heading name. For compatibility, always put a space between the number signs and the heading name.

✅ Do this	❌ Don't do this
`# Here's a Heading`	`#Here's a Heading`

You should also put blank lines before and after a heading for compatibility.

✅ Do this	❌ Don't do this
`Try to put a blank line before... # Heading<br><br> ...and after a heading. </code> </td> <td> <code class="highlighter-rouge"> Without blank lines, this might not look right.<br> # Heading<br> Don't do this! </code> </td> </tr>`

Paragraphs

To create paragraphs, use a blank line to separate one or more lines of text.

Paragraph Best Practices

Unless the paragraph is in a list, don’t indent paragraphs with spaces or tabs.

Note: If you need to indent paragraphs in the output, see the section on how to indent (tab).

✅ Do this ❌ Don't do this

✅ Do this	❌ Don't do this
`Don't put tabs or spaces in front of your paragraphs. Keep lines left-aligned like this.<br><br> </code> </td> <td> <code class="highlighter-rouge">     This can result in unexpected formatting problems.<br><br>   Don't add tabs or spaces in front of paragraphs. </code> </td> </tr>`


          Don't put tabs or spaces in front of your paragraphs.


      Keep lines left-aligned like this.<br><br>
    </code>
  </td>
  <td>
    <code class="highlighter-rouge">
    &nbsp;&nbsp;&nbsp;&nbsp;This can result in unexpected
    formatting problems.<br><br>

    &nbsp;&nbsp;Don't add tabs or spaces in front of paragraphs.
    </code>
  </td>
</tr>

Line breaks

To create a line break or new line (<br>), end a line with two or more spaces, and then type return.

Markdown	HTML	Rendered Output
`This is the first line. And this is the second line.`	`<p>This is the first line.<br> And this is the second line.</p></code> </td> <td> <p>This is the first line.<br /> And this is the second line.</p> </td> </tr>`

Line Break Best Practices

You can use two or more spaces (commonly referred to as “trailing whitespace”) for line breaks in nearly every Markdown application, but it’s controversial. It’s hard to see trailing whitespace in an editor, and many people accidentally or intentionally put two spaces after every sentence. For this reason, you may want to use something other than trailing whitespace for line breaks. If your Markdown application supports HTML, you can use the <br> HTML tag.

For compatibility, use trailing white space or the <br> HTML tag at the end of the line.

There are two other options I don’t recommend using. CommonMark and a few other lightweight markup languages let you type a backslash (\) at the end of the line, but not all Markdown applications support this, so it isn’t a great option from a compatibility perspective. And at least a couple lightweight markup languages don’t require anything at the end of the line — just type return and they’ll create a line break.

✅ Do this ❌ Don't do this

✅ Do this	❌ Don't do this
`First line with two spaces after. And the next line. First line with the HTML tag after.<br><br> And the next line.<br><br> </code> </td> <td> <code class="highlighter-rouge"> First line with a backslash after.\<br> And the next line.<br><br> First line with nothing after.<br> And the next line.<br><br> </code> </td> </tr>`


          First line with two spaces after.  

          And the next line.


      First line with the HTML tag after.&lt;br&gt;<br>
      And the next line.<br><br>
    </code>
  </td>
  <td>
    <code class="highlighter-rouge">
    First line with a backslash after.\<br>
    And the next line.<br><br>

    First line with nothing after.<br>
    And the next line.<br><br>
    </code>
  </td>
</tr>

Emphasis

Bold and Italic

To emphasize text with bold and italics at the same time, add three asterisks or underscores before and after a word or phrase. To bold and italicize the middle of a word for emphasis, add three asterisks without spaces around the letters.

Markdown	HTML	Rendered Output
`This text is *really important*.`	`This text is <em><strong>really important</strong></em>.`	This text is really important.
`This text is ___really important___.`	`This text is <em><strong>really important</strong></em>.`	This text is really important.
`This text is __really important__.`	`This text is <em><strong>really important</strong></em>.`	This text is really important.
`This text is _really important_.`	`This text is <em><strong>really important</strong></em>.`	This text is really important.
`This is really*very*important text.`	`This is really<em><strong>very</strong></em>important text.`	This is reallyveryimportant text.

Note: The order of the em and strong tags might be reversed depending on the Markdown processor you're using.

Bold and Italic Best Practices

Markdown applications don’t agree on how to handle underscores in the middle of a word. For compatibility, use asterisks to bold and italicize the middle of a word for emphasis.

✅ Do this	❌ Don't do this
`This is really*very*important text.`	`This is really___very___important text.`

Blockquotes

To create a blockquote, add a > in front of a paragraph.

> Dorothy followed her through many of the beautiful rooms in her castle.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

Blockquotes with Multiple Paragraphs

Blockquotes can contain multiple paragraphs. Add a > on the blank lines between the paragraphs.

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Nested Blockquotes

Blockquotes can be nested. Add a >> in front of the paragraph you want to nest.

> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Blockquotes with Other Elements

Blockquotes can contain other Markdown formatted elements. Not all elements can be used — you’ll need to experiment to see which ones work.

> #### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
>  *Everything* is going according to **plan**.

The rendered output looks like this:

The quarterly results look great!

Revenue was off the chart.

Profits were higher than ever.

Everything is going according to plan.

Blockquotes Best Practices

For compatibility, put blank lines before and after blockquotes.

✅ Do this ❌ Don't do this

✅ Do this	❌ Don't do this
`Try to put a blank line before... > This is a blockquote<br><br> ...and after a blockquote. </code> </td> <td> <code class="highlighter-rouge"> Without blank lines, this might not look right.<br> > This is a blockquote<br> Don't do this! </code> </td> </tr>`


        Try to put a blank line before...


    > This is a blockquote<br><br>

    ...and after a blockquote.
    </code>
  </td>
  <td>
    <code class="highlighter-rouge">
    Without blank lines, this might not look right.<br>
    > This is a blockquote<br>
    Don't do this!
    </code>
  </td>
</tr>

Lists

You can organize items into ordered and unordered lists.

Adding Elements in Lists

To add another element in a list while preserving the continuity of the list, indent the element four spaces or one tab, as shown in the following examples.

Tip: If things don't appear the way you expect, double check that you've indented the elements in the list four spaces or one tab.

Paragraphs

* This is the first list item.
* Here's the second list item.

    I need to add another paragraph below the second list item.

* And here's the third list item.

The rendered output looks like this:

This is the first list item.
Here’s the second list item.

I need to add another paragraph below the second list item.
And here’s the third list item.

Blockquotes

* This is the first list item.
* Here's the second list item.

    > A blockquote would look great below the second list item.

* And here's the third list item.

The rendered output looks like this:

This is the first list item.
Here’s the second list item.

A blockquote would look great below the second list item.
And here’s the third list item.

Code Blocks

Code blocks are normally indented four spaces or one tab. When they’re in a list, indent them eight spaces or two tabs.

1. Open the file.
2. Find the following code block on line 21:

        <html>
          <head>
            <title>Test</title>
          </head>

3. Update the title to match the name of your website.

The rendered output looks like this:

Open the file.

Find the following code block on line 21:

<html>
  <head>
    <title>Test</title>
  </head>

Update the title to match the name of your website.

Images

1. Open the file containing the Linux mascot.
2. Marvel at its beauty.

    ![Tux, the Linux mascot](/assets/images/tux.png)

3. Close the file.

The rendered output looks like this:

Open the file containing the Linux mascot.
Marvel at its beauty.
Close the file.

Lists

You can nest an unordered list in an ordered list, or vice versa.

1. First item
2. Second item
3. Third item
    - Indented item
    - Indented item
4. Fourth item

The rendered output looks like this:

First item
Second item
Third item
- Indented item
- Indented item
Fourth item

Code

To denote a word or phrase as code, enclose it in backticks (`).

Markdown	HTML	Rendered Output
At the command prompt, type `nano`.	`At the command prompt, type <code>nano</code>.`	At the command prompt, type `nano`.

Escaping Backticks

If the word or phrase you want to denote as code includes one or more backticks, you can escape it by enclosing the word or phrase in double backticks (``).

Markdown	HTML	Rendered Output
``Use `code` in your Markdown file.``	<code>Use `code` in your Markdown file.</code>	Use `code` in your Markdown file.

Code Blocks

To create code blocks, indent every line of the block by at least four spaces or one tab.

    <html>
      <head>
      </head>
    </html>

The rendered output looks like this:

<html>
  <head>
  </head>
</html>

Note: To create code blocks without indenting lines, use fenced code blocks.

Horizontal Rules

To create a horizontal rule, use three or more asterisks (***), dashes (---), or underscores (___) on a line by themselves.

***

---

_________________

The rendered output of all three looks identical:

Horizontal Rule Best Practices

For compatibility, put blank lines before and after horizontal rules.

✅ Do this	❌ Don't do this
`Try to put a blank line before... ---<br><br> ...and after a horizontal rule. </code> </td> <td> <code class="highlighter-rouge"> Without blank lines, this would be a heading.<br> ---<br> Don't do this! </code> </td> </tr>`

Links

To create a link, enclose the link text in brackets (e.g., [Duck Duck Go]) and then follow it immediately with the URL in parentheses (e.g., (https://duckduckgo.com)).

My favorite search engine is [Duck Duck Go](https://duckduckgo.com).

The rendered output looks like this:

My favorite search engine is Duck Duck Go.

Note: To link to an element on the same page, see linking to heading IDs. To create a link that opens in a new tab or window, see the section on link targets.

Adding Titles

You can optionally add a title for a link. This will appear as a tooltip when the user hovers over the link. To add a title, enclose it in quotation marks after the URL.

My favorite search engine is [Duck Duck Go](https://duckduckgo.com "The best search engine for privacy").

The rendered output looks like this:

My favorite search engine is Duck Duck Go.

URLs and Email Addresses

To quickly turn a URL or email address into a link, enclose it in angle brackets.

<https://www.markdownguide.org>
<fake@example.com>

The rendered output looks like this:

https://www.markdownguide.org
fake@example.com

Formatting Links

To emphasize links, add asterisks before and after the brackets and parentheses. To denote links as code, add backticks in the brackets.

I love supporting the **[EFF](https://eff.org)**.
This is the *[Markdown Guide](https://www.markdownguide.org)*.
See the section on [`code`](#code).

The rendered output looks like this:

I love supporting the EFF.
This is the Markdown Guide.
See the section on code.

Reference-style Links

Reference-style links are a special kind of link that make URLs easier to display and read in Markdown. Reference-style links are constructed in two parts: the part you keep inline with your text and the part you store somewhere else in the file to keep the text easy to read.

Formatting the First Part of the Link

The first part of a reference-style link is formatted with two sets of brackets. The first set of brackets surrounds the text that should appear linked. The second set of brackets displays a label used to point to the link you’re storing elsewhere in your document.

Although not required, you can include a space between the first and second set of brackets. The label in the second set of brackets is not case sensitive and can include letters, numbers, spaces, or punctuation.

This means the following example formats are roughly equivalent for the first part of the link:

[hobbit-hole][1]
[hobbit-hole] [1]

Formatting the Second Part of the Link

The second part of a reference-style link is formatted with the following attributes:

The label, in brackets, followed immediately by a colon and at least one space (e.g., [label]: ).
The URL for the link, which you can optionally enclose in angle brackets.
The optional title for the link, which you can enclose in double quotes, single quotes, or parentheses.

This means the following example formats are all roughly equivalent for the second part of the link:

[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle 'Hobbit lifestyles'
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle (Hobbit lifestyles)
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> "Hobbit lifestyles"
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> 'Hobbit lifestyles'
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> (Hobbit lifestyles)

You can place this second part of the link anywhere in your Markdown document. Some people place them immediately after the paragraph in which they appear while other people place them at the end of the document (like endnotes or footnotes).

An Example Putting the Parts Together

Say you add a URL as a standard URL link to a paragraph and it looks like this in Markdown:

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends
of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to
eat: it was a [hobbit-hole](https://en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"), and that means comfort.

Though it may point to interesting additional information, the URL as displayed really doesn’t add much to the existing raw text other than making it harder to read. To fix that, you could format the URL like this instead:

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends
of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to
eat: it was a [hobbit-hole][1], and that means comfort.

[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> "Hobbit lifestyles"

In both instances above, the rendered output would be identical:

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to eat: it was a hobbit-hole, and that means comfort.

and the HTML for the link would be:

<a href="https://en.wikipedia.org/wiki/Hobbit#Lifestyle" title="Hobbit lifestyles">hobbit-hole</a>

Link Best Practices

Markdown applications don’t agree on how to handle spaces in the middle of a URL. For compatibility, try to URL encode any spaces with %20. Alternatively, if your Markdown application supports HTML, you could use the a HTML tag.

✅ Do this	❌ Don't do this
`[link](https://www.example.com/my%20great%20page) <a href="https://www.example.com/my great page">link</a><br><br> </code> </td> <td> <code class="highlighter-rouge"> [link](https://www.example.com/my great page)<br><br> </code> </td> </tr>`

Parentheses in the middle of a URL can also be problematic. For compatibility, try to URL encode the opening parenthesis (() with %28 and the closing parenthesis ()) with %29. Alternatively, if your Markdown application supports HTML, you could use the a HTML tag.

✅ Do this ❌ Don't do this

✅ Do this	❌ Don't do this
`[a novel](https://en.wikipedia.org/wiki/The_Milagro_Beanfield_War_%28novel%29) <a href="https://en.wikipedia.org/wiki/<wbr>The_Milagro_Beanfield_War_(novel)">a novel</a><br><br> </code> </td> <td> <code class="highlighter-rouge"> [a novel](https://en.wikipedia.org/wiki/<wbr>The_Milagro_Beanfield_War_(novel)) </code> </td> </tr>`


        [a novel](https://en.wikipedia.org/wiki/The_Milagro_Beanfield_War_%28novel%29)


    &lt;a href="https://en.wikipedia.org/wiki/<wbr>The_Milagro_Beanfield_War_(novel)"&gt;a novel&lt;/a&gt;<br><br>
    </code>
  </td>
  <td>
    <code class="highlighter-rouge">
    [a novel](https://en.wikipedia.org/wiki/<wbr>The_Milagro_Beanfield_War_(novel))
    </code>
  </td>
</tr>

Images

To add an image, add an exclamation mark (!), followed by alt text in brackets, and the path or URL to the image asset in parentheses. You can optionally add a title in quotation marks after the path or URL.

![The San Juan Mountains are beautiful!](/assets/images/san-juan-mountains.jpg "San Juan Mountains")

The rendered output looks like this:

{% include image.html file="/assets/images/san-juan-mountains.jpg" alt=“The San Juan Mountains are beautiful!” title=“San Juan Mountains” lazy=“yes” %}

Note: To resize an image, see the section on image size. To add a caption, see the section on image captions.

Linking Images

To add a link to an image, enclose the Markdown for the image in brackets, and then add the link in parentheses.

[![An old rock in the desert](/assets/images/shiprock.jpg "Shiprock, New Mexico by Beau Rogers")](https://www.flickr.com/photos/beaurogers/31833779864/in/photolist-Qv3rFw-34mt9F-a9Cmfy-5Ha3Zi-9msKdv-o3hgjr-hWpUte-4WMsJ1-KUQ8N-deshUb-vssBD-6CQci6-8AFCiD-zsJWT-nNfsgB-dPDwZJ-bn9JGn-5HtSXY-6CUhAL-a4UTXB-ugPum-KUPSo-fBLNm-6CUmpy-4WMsc9-8a7D3T-83KJev-6CQ2bK-nNusHJ-a78rQH-nw3NvT-7aq2qf-8wwBso-3nNceh-ugSKP-4mh4kh-bbeeqH-a7biME-q3PtTf-brFpgb-cg38zw-bXMZc-nJPELD-f58Lmo-bXMYG-bz8AAi-bxNtNT-bXMYi-bXMY6-bXMYv)

The rendered output looks like this:

{% include image.html file="/assets/images/shiprock.jpg" alt="An old rock in the desert" title="Shiprock, New Mexico by Beau Rogers" lazy="yes" %}

Excaping characters

To display a literal character that would otherwise be used to format text in a Markdown document, add a backslash (\) in front of the character.

\* Without the backslash, this would be a bullet in an unordered list.

The rendered output looks like this:

* Without the backslash, this would be a bullet in an unordered list.

Characters You Can Escape

You can use a backslash to escape the following characters.

Character	Name
\	backslash
`	backtick (see also escaping backticks in code)
*	asterisk
_	underscore
{ }	curly braces
[ ]	brackets
< >	angle brackets
( )	parentheses
#	pound sign
+	plus sign
-	minus sign (hyphen)
.	dot
!	exclamation mark
\|	pipe (see also escaping pipe in tables)

HTML

Many Markdown applications allow you to use HTML tags in Markdown-formatted text. This is helpful if you prefer certain HTML tags to Markdown syntax. For example, some people find it easier to use HTML tags for images. Using HTML is also helpful when you need to change the attributes of an element, like specifying the color of text or changing the width of an image.

To use HTML, place the tags in the text of your Markdown-formatted file.

This **word** is bold. This <em>word</em> is italic.

The rendered output looks like this:

This word is bold. This word is italic.

HTML Best Practices

For security reasons, not all Markdown applications support HTML in Markdown documents. When in doubt, check your Markdown application’s documentation. Some applications support only a subset of HTML tags.

Use blank lines to separate block-level HTML elements like <div>, <table>, <pre>, and <p> from the surrounding content. Try not to indent the tags with tabs or spaces — that can interfere with the formatting.

You can’t use Markdown syntax inside block-level HTML tags. For example, <p>italic and **bold**</p> won’t work.

Categories:

surfland

Tags:

This article is part of the series: Markdown Syntax

Overview

Math

Notice Alert

Task List

Headings

Heading level 1

Heading level 2

Heading level 3

Heading level 4

Heading level 5

Heading level 6

Alternate Syntax

Heading level 1

Heading level 2

Heading Best Practices

Paragraphs

Paragraph Best Practices

Line breaks

Line Break Best Practices

Emphasis

Bold and Italic

Bold and Italic Best Practices

Blockquotes

Blockquotes with Multiple Paragraphs

Nested Blockquotes

Blockquotes with Other Elements

The quarterly results look great!

Blockquotes Best Practices

Lists

Adding Elements in Lists

Paragraphs

Blockquotes

Code Blocks

Images

Lists

Code

Escaping Backticks

Code Blocks

Horizontal Rules

Horizontal Rule Best Practices

Links

Adding Titles

URLs and Email Addresses

Formatting Links

Reference-style Links

Formatting the First Part of the Link

Formatting the Second Part of the Link

An Example Putting the Parts Together

Link Best Practices

Images

Linking Images

Excaping characters

Characters You Can Escape

HTML

HTML Best Practices

See Also

🍪 Cookies Consent