Master Markdown in 5minutes ⌚

Kunal Singh

Aug 1, 2021

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

website logo




  • 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 👩‍💻!

Recommendations

Are You Still Using Basic CSS? Here Are 7 Tricks to Get Ahead of the Curve

#css

Bored of the same old CSS? Unleash 7 hidden gems to take your designs to the...

Dec 27, 2023

Easiest way to store your logs in a file WITHOUT chaging the source file(node)

#productivity

Often, developers face challenges when dealing with a flood of logs in the...

Dec 21, 2023

Build Your Own Pinterest-Style Masonry Grid: A Step-by-Step Guide

#css

,

#web

,

#layout

Create a masonary grid layout with left to right content flow, supporting...

Dec 10, 2023

Using git diff and git apply to Share Local Changes with Peers

#git

,

#productivity

,

#software_engeneering

,

#dev

git diff and git apply are two powerful Git commands that can be used to share...

Nov 12, 2023

React Portals: Render Components Outside the current DOM Hierarchy

#react

,

#web

The createPortal API in React allows you to render child elements into a...

Jul 27, 2023

Cloning Made Easy: Try degit and Clone Directories within Repos.

#git

,

#productivit

Have you ever faced the dilemma of wanting just a small portion of a repository,...

Jul 19, 2023

Debugging Web Apps with Browser Dev Tools: 6 Amazing Tricks

#browser

,

#debugging

,

#web

Debugging web applications can be a challenging task, with errors like...

Jul 13, 2023

Controlled Versus Uncontrolled Components in React

#react

,

#forms

Understanding State Management Within Forms Comparing controlled and...

Nov 5, 2022

Format Numbers, Dates and Currencies with the Intl Object in Javascript

#javascript

,

#html

,

#web

Intl object can be used to format data into commonly used formats of dates,...

Sep 13, 2022

Image Masking on Hover Using CSS Clip Path and Javascript

#javscript

,

#css

,

#html

Image Masking can be used to add fancy hover highlight effects to images for...

Jul 23, 2022

Recreating CSS Tricks Fancy Grid Hover Effect

#html

,

#css

,

#UI

,

#recreation

CSS Trick had a simple yet cool grid layout which I found dope. So lets try to...

May 21, 2022

File Explorer Recursive React Component

#react

,

#javascript

,

#web

How to create a recursive folder Component using react.

Apr 16, 2022

Add Google Fonts to Your React & NextJS + TailwindCSS Project (Next 14)

#css

,

#tailwindcss

,

#react

,

#nextjs

,

#tailwind

,

#design

Use Google Fonts in Your TailwindCSS Projects

Apr 6, 2022

Event Delegation in Javascript

#javscript

,

#css

,

#html

,

#web

,

#performance

Handling multiple Events in Javascript with minimal CPU Usage

Mar 6, 2022

A Simple Web Accessibility Trick that you most probably missed!

#html

,

#css

,

#web-accessibility

,

#user-experience

Imagine that you cannot use the mouse and have to Navigate a Website with the...

Dec 23, 2021

Top Terminal Commands I Use For Productivity

#linux

,

#cli

,

#terminal

The whole point of development is solving problems. But very often we Developers...

Nov 3, 2021

CSS Logical Properties

#css

,

#html

CSS logical properties are properties which are used to design element on the...

Oct 5, 2021

Fluid Typography in CSS 💧

#css

,

#html

,

#typography

CSS Best Practices in Fluid Typography

Aug 15, 2021

CSS Units in a Nutshell 🐚

#css

,

#html

Are you still writing your css units in pixels and percentages? if you are then...

Aug 8, 2021

What is JAMStack ✨

#jamstack

Jamstack stands for Javascript APIS and Markup and it is based on this idea of...

Jul 31, 2021

+

Check my latest Blog Post

Are You Still Using Basic CSS? Here Are 7 Tricks to Get Ahead of the Curve

Read Now
Oh My Gawwdd!!!!!!!

Wow you have been viewing my site since 20 seconds!

+
+