Markdown Cheatsheet

Markdown Cheatsheet

Learn Markdown syntax which makes your readme. md file beautiful to showcase your projects.

ยท

3 min read

Overview

This cheat sheet will guide you to understand the syntax of markdown along with the examples. I have tried to make it as simple and easy to understand.


Heading

The syntax used for heading starts with a hash symbol. Watch the below example for more clarity. Syntax of these headings are as follows:

    # Heading1
    ## Heading2
    ### Heading3
    #### Heading4
    ##### Heading5
    ###### Heading6

Output:

Heading1

Heading2

Heading3

Heading4

Heading5
Heading6

Bold

To make your text bold, the syntax is :

**bold text ***  -- Recommended
       or
__bold text__

Output: This is bold.


Italic

To make your text Italic, the syntax is :

  *italic text *

Output: This is italic.


Blockquote

To create a blockquote just add '>' this symbol next to the text.
Syntax:

  > This is an example of blockquote.

  > This is an example of nested blockquote.
  >
  >> Hey, I am the nested one.

Output of blockquote:

This is an example of blockquote.

Output of nessted blockquote:

>This is an example of nested blockquote.
>
>> Hey, I am the nested one.

Lists

We can create ordered and unordered list with markdown.

Unordered List:

Using (-), (*) and (+) sign, we can create the unordered list. Syntax:

  - Item1
  - Item2
  - Item3
    * Item a
    * Item b
      + Item I
      + Item II

  - Item4

Output:

  • Item1
  • Item2
  • Item3

    • Item a
    • Item b
      • Item I
      • Item II
  • Item4

Ordered List:

To create an ordered list, add line items with numbers followed by periods. Syntax:

  1. Item1
  2. Item2
  3. Item3
  5. Order of number is not mandatory.
  10. It just needs to start with 1.

Output:

  1. Item1
  2. Item2
  3. Item3
  4. Order of number is not mandatory.
  5. It just needs to start with 1.

Syntax:

  [Click here to search](https://www.google.com/)

Output: Click here to search


Images:

Syntax:

  ![Image](https://unsplash.com/photos/MhTYLEO0-Ug)

Output: Image


URLs and Email Addresses:

Just add your URL or email address inside <> and it will become a link.
Syntax: <Your URL>

Ouput: https://unsplash.com/photos/MhTYLEO0-Ug


Horizontal line:

To create a horizontal line, use *** or ___ or ---

Sytnax:

  _______________________________________
  **********************************
  ---------------------------------------

Output:




Code: To write the code using markdown, use backtics 3 times.

Syntax:

```I can write code here ```
Output:

  I can write code here.
  Also to switch to a new line, use <br> tag as same like in HTML.
ย