DEV Community

Sanamdeep Singh
Sanamdeep Singh

Posted on

MarkDown for beginners

What is markdown?

  • Lightweight markup language
  • Can be converted into HTML/XHTML and other formats
  • It's main purpose is readability and ease of use

What is it used for?

  • Readme Files(GitHub, etc)
  • Forums and Blogs
  • Used in may static site generators

Some basic things you can format

Headings   Blocks of Code

Lists            Images

Emphasis    Blockquotes

Links           Horizontal Rules

Headings

# H1 Heading ## H2 Heading ### H3 Heading #### H4 Heading ##### H5 Heading ###### H6 Heading 

H1 Heading

H2 Heading

H3 Heading

H4 Heading

H5 Heading
H6 Heading

Italics

*This text is in italics* _This text_ is in italics 

This text is in italics

This text is in


Strong

 **This text is in strong** __This text__ is in strong 

This text is in italics

This text is in italics


Strikethrough

~~This text~~ is strikethough 

This text is strikethough


Horizontal Rule

--- 

show speacial character

\*This text is in italics\* 

*This text is in italics*


Blockquotes

> This is a Quote 

This is a Quote

[https://www.sanamdeep.dev](https://www.sanamdeep.dev) 

https://www.sanamdeep.dev


show title on hover

[https://www.sanamdeep.dev](https://www.sanamdeep.dev "sanamdeep.dev") 

[https://www.sanamdeep.dev](https://www.sanamdeep.dev "sanamdeep.


Unordered Lists

* Item 1 * Item 1.1 * Item 1.1.1 * Item 2 * Item 2.1 * Item 2.1.1 
  • Item 1
    • Item 1.1
    • Item 1.1.1
  • Item 2
    • Item 2.1
    • Item 2.1.1

Ordered List

1. Item 1. Item1.1 1. Item 1.2 2. Item 2 1. Item 2.1 1. Item 2.1.1 
  1. Item
    1. Item1.1
      1. Item 1.2
  2. Item 2
    1. Item 2.1
      1. Item 2.1.1

Blockquotes

`<p>This is a paragraph</p>` 

<p>This is a paragraph</p>


Images

![Markdown Logo](https://markdown-here.com/img/icon256.png) 

Markdown Logo


GitHub markdown

Code Blocks

```bash
npm install
```
npm install 
```javascript
function add(num1, num2) {
return num1 + num2;
}
```
 function add(num1, num2) { return num1 + num2; } 
```python
def add(num1, num2):
return num1 + num2
```
 def add(num1, num2): return num1 + num2 

Tables

| Name | Email | | ---- | ------ | | John Doe | john@gmail.com | | Jane Doe | john@gmail.com | 
Name Email
John Doe john@gmail.com
Jane Doe john@gmail.com

Task Lists

* [x] Task 1 completed * [x] Task 2 completed * [ ] Task 3 not completed 
  • [x] Task 1 completed
  • [x] Task 2 completed
  • [ ] Task 3 not completed

Top comments (0)