Skip to content

Markdown Syntax Note

Headings

# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6

Paragraphs And Text

This is markdown text.

This is markdown long text, showing how to use markdown to write a long text paragraph.

Output looks like this:

This is markdown text.

This is markdown long text, showing how to use markdown to write a long text paragraph.

Horizontal Rules

***

---

_________________

Output looks like this:




Emphasis

Bold

This is an example of bold text: **bold text 1**.

This is an example of bold text: __bold text 2__.

Output looks like this:

This is an example of bold text: bold text 1.

This is an example of bold text: bold text 2.

Italic

This is an example of italicized text: *italicized text 1*.

This is an example of italicized text: _italicized text 2_.

Output looks like this:

This is an example of italicized text: italicized text 1.

This is an example of italicized text: italicized text 2.

Bold and Italic

This is an example of bold italic text: ***Bold italic text 1***.

This is an example of bold italic text: ___Bold italic text 2___.

This is an example of bold italic text: __*Bold italic text 3*__.

This is an example of bold italic text: **_Bold italic text 4_**.

Output looks like this:

This is an example of bold italic text: Bold italic text 1.

This is an example of bold italic text: Bold italic text 2.

This is an example of bold italic text: Bold italic text 3.

This is an example of bold italic text: Bold italic text 4_.

Denote

This is a denote example, like `Denote`.

Output looks like this:

This is a denote example, like Denote.

Lists

Ordered Lists

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

Output looks like this:

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

Unordered Lists

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

Output looks like this:

  • First item
  • Second item
  • Third item
    • Indented item
    • Indented item
  • Fourth item

Adding Elements in Lists

Blockquote in Lists

- This is the first list item.
- Here's the second list item.
    > Using a blockquote below the second list item.
- And here's the third list item.

Output looks like this:

  • This is the first list item.
  • Here's the second list item. > Using a blockquote below the second list item.
  • And here's the third list item.

Blockquote

> This is an example of a markdown reference block.

Output looks like this:

This is an example of a markdown reference block.

Blockquote with Multiple Paragraphs

> This is an example 1 of a markdown reference block.
>
> This is an example 2 of a markdown reference block.

Output looks like this:

This is an example 1 of a markdown reference block.

This is an example 2 of a markdown reference block.

Nested Blockquote

> This is an example 1 of a markdown reference block.
>
>> This is an example 2 of a markdown reference block.

Output looks like this:

This is an example 1 of a markdown reference block.

This is an example 2 of a markdown reference block.

Blockquote with Other Elements

> #### Using headings in block references
>
> - Using unordered lists in block references 1.
> - Using unordered lists in block references 2.
>
> Using *italic text* and **bold text** in block references.

Output looks like this:

Using headings in block references

  • Using unordered lists in block references 1.
  • Using unordered lists in block references 2.

Using italic text and bold text in block references.

Code

    ```c
    #include <stdio.h>
    int main() {
        printf("Hello, World!\n");
        return 0;
    }
    ```

Output looks like this:

#include <stdio.h>
int main() {
    printf("Hello, World!\n");
    return 0;
}

Images

![This is an example of a local image](../../assets/images/illustration.png)

Output looks like this:

This is an example of a local image

Linking Images

[![This is an example image link](../../assets/images/illustration.png "ReferBe")](https://referbe.com)

Output looks like this:

This is an example image link

ReferBe(<https://referbe.com>) is an aggregation site for quickly retrieving precise documents.

Output looks like this:

ReferBe(https://referbe.com) is an aggregation site for quickly retrieving precise documents.

[ReferBe](https://referbe.com "ReferBe Website") is an aggregation site for quickly retrieving precise documents.

Output looks like this:

ReferBe is an aggregation site for quickly retrieving precise documents.

URLs and Email Addresses

<https://www.referbe.com>

<fake@example.com>

Output looks like this:

https://www.referbe.com

fake@example.com

ReferBe link is **[ReferBe](https://referbe.com)**.

ReferBe link is *[ReferBe](https://www.referbe.com)*.

Images part is [`Images`](#Images).

Output looks like this:

ReferBe link is ReferBe.

ReferBe link is ReferBe.

Images part is Images.

ReferBe[1]

ReferBe [2]

[1]: https://referbe.com
[2]: https://referbe.com

Output looks like this:

ReferBe1

ReferBe 2

Ignore symbols

\* Ignore asterisks, if there are no backslashes, this will be a bullet in an unordered list.

Output looks like this:

* Ignore asterisks, if there are no backslashes, this will be a bullet in an unordered list.

Symbols that you can ignore

Symbol 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)