Markdown

Markdown #

Paragraphs #

Syntax #

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
###### Heading 5

Output #

Heading 1 #

Heading 2 #

Heading 3 #

Heading 4 #

Heading 5 #

Formatting #

Element Syntax Sample
Bold **text** text
Italic *text* text
Bold & Italic ***text*** text
Underline <ins>Underlined</ins> text

Paragraph/line breaks/new line #

Use two space characters at the end of a line in order to force a line break
You can also use a backslash at the end of the first line

Examples #

Word1
Word2

Word1 Word2


Word1

Word2

Word1

Word2


Word1<SPACE><SPACE>
Word2

Word 1
Word 2


Word1\
Word2

Word 1
Word 2

Syntax #

[Link text](URL "Link title")

[Example](https://www.example.com "Example site")

Output #

Example

Escaping characters #

Use backslash to escape markdown command characters

Examples #

\\
\*
\-

Ordered List #

Syntax #

1. One
2. Two
3. Three
4. Four

Output #

  1. One
  2. Two
  3. Three

Unordered lists #

Syntax #

- Bananas
- Apples
- Oranges

Output #

  • Bananas
  • Apples
  • Oranges

Horizontal line #

Syntax #

---

Output #


Single-line code block #

Syntax #

`console.log('Hello World');`

Output #

console.log('Hello World');

Multi-line code block #

Use “fenced code blocks”

Syntax #

```
console.log('Hola Mundo');
console.log('Bonjour le monde');
console.log('Hello World');
```

Output #

console.log('Hola Mundo');
console.log('Bonjour le monde');
console.log('Hello World');

Show 3 backticks in Multi line code block (fenced code) #

Start with 4 backticks

Syntax #

````
```
console.log('Hola Mundo');
console.log('Bonjour le monde');
console.log('Hello World');
```
````

Output #

```
console.log('Hola Mundo');
console.log('Bonjour le monde');
console.log('Hello World');
```

Syntax highlighting in code blocks #

```javascript
console.log('Hello world');
```
console.log('Hello world');

```sql
SELECT * FROM myTable;
```
SELECT * FROM myTable;

Blockquotes #

add a ‘>’ character in front of a paragraph.

> Just a sample

Just a sample

Multiline Blockquotes #

> Line 1
>
> Line 2
> 
> Line 3

Line 1

Line 2

Line 3

Nested Blockquotes #

> A
>> A.1
>>
>> A.2  
>
> B  
>> B1

A

A.1

A.2

B

B1

Tables #

Syntax #

| Col1 | Col2 | Col3 |
|------|------|------|
| Val  | Val  | Val  |
| Val  | Val  | Val  |
| Val  | Val  | Val  |

Output #

Col1 Col2 Col3
Val Val Val
Val Val Val
Val Val Val

Images #

![Title](/path-to/image.png)

Guides #

Online markup editors #