Markdown GUIDE

Headings

Markdown

> # This is a h1


> ## This is a h2


> ### This is a h3


> #### This is a h4


> ##### This is a h5


> ###### This is a h6


"Note": Use empty line before and after each heading for compatibility reason.

New line

Markdown

> Use two or more spaces an press enter for create a new line


Bold text

Markdown

> This is a **bold text**


> This is a __bold text__


"Note": Use doble asterisks for compatibility reason.

Italic text

Markdown

> This is a *italic text*


> This is a _italic text_


"Note": Use one asterisk for compatibility reason.

Bold and italic text

Markdown

> This is a ***bold and italic text***


> This is a ___bold and italic text___


> This is a __*bold and italic text*__


> This is a **_bold and italic text_**


"Note": Use three asterisks for compatibility reason.

Blockquotes

Markdown

> Use ">" symbol to make text blockquote



Example:



> This is a blockquote paragraph


Blockquote with multiple paragraphs

Markdown

> Add ">" on the blank lines between the paragraphs



Example:



> This is a blockquote paragraph


>


> This is a other blockquote paragraph


Nested blockquotes

Markdown

> Add ">>" in front of the paragraph you want to nest



Example:



> This is a blockquote paragraph


>


>> This is a nested blockquote paragraph


Ordered list

Markdown

> Add line items with numbers followed by periods



Example:



1. First item


2. Second item


3. Third item


Unordered list

Markdown

> add dashes (-), asterisks (*), or plus signs (+) in front of line items. Indent one or more items to create a nested list



Example:



- First item    * First item    + First item


- Second item   * Second item   + Second item


- Third item    * Third item    + Third item



> To start an unordered list item with a number, use backslash (\) to escape the period



Example:



- 1968\. A great year!


Code blocks

Markdown

> Use two tabs or eight spaces



Example:


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

Images

Markdown

> ![Text for not found image](url to image)



Example:



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



Horizontal rules

Markdown

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



Example:



***


---


___



Adding titles

Markdown

> [Text for link](url-for-link "Text for title")


> ![Text for not found image](url to image "Text for title")



Example:



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


[Cute Cat Image](public/cat-image.png "A cute cat")



URLs and email addresses

Markdown

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



Example:



<https://www.markdownguide.org>


<fake@example.com>