What is MarkDown

You might have come across repositories on Github with well documented readme file like this

This is just the basic example of a markdown file. In this article I will be sharing all the basics of Markdown Syntax and help you become a Markdown Ninja 🐱‍👤! Markdown is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber and Aaron Swartz created Markdown in 2004 as a markup language that is appealing to human readers in its source code form

Why use markdown

If you want to create a well documented project and share it with the world via Open source Platforms. Markdown will help your code communicate better with the masses and can also invite contributors to your project!

Lets Start

• Headings

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

will give

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

• Text Formatting

The following **word** is important while this *word* is italic

will give

The following word is important while this word is italic

• Blockquute

> This is a good quote! 

will give

This is a good quote!

• Lists

- Apples
- Mangoes 
- Oranges 

will give

• Apples
• Mangoes
• Oranges

1. Apples
2. Mangoes 
3. Oranges 

will give

1. Apples
2. Mangoes
3. Oranges

1. Apples
2. Mangoes 
    - Oranges
    - Berries
3. Oranges 

will give

1. Apples

2. Mangoes

   • Oranges
   • Berries

3. Oranges

• Code

```

let foo = () =>{
  console.log('fooo!')
}

````

will give

let foo = () =>{
  console.log('fooo!')
}

• Images

 Adding Image 
 ![website logo](/img/icon.png)

 Adding Image with URL
 [ ![website logo](/img/icon.png)](https://singhkunal2050v2.netlify.app/)]

will give

• Horizontal Lines

---

will give this very horizontal line 👇

• Hyper Links

I want to share a [url](https://www.google.com)

will give I want to share a url

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

<https://www.google.com>
<demo@demo.com>

https://www.google.com demo@demo.com

And with that I hope you can now write a basic documentation for your projects and spread joy in the open source community!! 🧚‍♀️🧚‍♀️ If you wish to go deeper you can check this Crash Course by the GOAT himself 🐐 Brad Traversy from Traversy Media

I hope you learned something new today if you did then please share this post with your friends who might find this useful aswell. Have any questions? Feel free to connect with me on LinkedIn Twitter @singhkunal2050. You can also write me here.

Happy Coding 👩‍💻!