What is Markdown and how you can use it to write README.md file for your GitHub project?
Tags: github, markdown, readme
Published: 2022-03-13 18:04:18


Markdown is a lightweight markup language that allows us to write in easy-to-read text format and convert it into XHTML (or HTML) to display in a browser or another writing program.

---
## Paragraph
```
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut
labore et dolore magna aliqua.
```
###### Output:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

* * *

## Line-Break

To insert a line break into your Markdown file, finish your line with at least two spaces and press <kbd>ENTER</kbd> key. It will render a new line for your text.

```
Hey there  
I'm a coder.
```
###### Output:
Hey there
I'm a coder.

-----------------------

## Text Formatting

#### 1. Using Italics in text

To use Italics in text, surround the targeted part of text with single asterisks (*) or single underscores (_).

```
This is *Morax*.
I'm a _programmer_.
```
###### Output:
This is *Morax*.
I'm a _programmer_.

---

#### 2. Using Bold in text

Bold text is created by using two asterisks (**) or two underscores (__).

```
This is **Morax**.
I'm a __programmer__.
```
###### Output:
This is **Morax**.
I'm a __programmer__.

---

#### 3. Using Asterisk or Underscore in a Text
To use a literal asterisk or Underscore in a text, precede it with an escape character backslash (\)
e.g.,
`\_This is all \*\*plain\*\* text\_.`
###### Output:
\_This is all \*\*plain\*\* text\_.

---

#### Horizontal Line

To draw Horizontal rule, put three or more hyphens (-), asterisks (*), or underscores (_) in a new line.

```
_ _ _
* * *
_ _ _
```
###### Output:

![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/egzujvu88opuzzzvawj7.jpeg)
## Heading

```
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
```
###### Output:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

---

## Making List

#### Ordered List

```
1. Java
2. Python
3. Go
```
###### Output:
1. Java
2. Python
3. Go

#### Unordered List
```
- Java
  - Core Java
  - Advance Java
- Python
- Go
```

###### Output:
- Java
  - Core Java
  - Advance Java
- Python
- Go

---

## Tracking task lists
```
- [x] Windows
- [x] Linux
- [ ] MacOS
```
###### Output:
![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/x1ez64itgkstq7kzzkq9.jpeg)

---

## Building Table

```markdown
Language | Use 1 | Use 2
- | - | -
Java | Mobile App Development | Cloud-based Application
Python | AL & ML | Data analytics
C# | Game Development | Mobile Apps
```
###### Output:
Language | Use 1 | Use 2
- | - | -
Java | Mobile App Development | Cloud-based Application
Python | AL & ML | Data analytics
C# | Game Development | Mobile Apps

---

## Quoting Text

```
> "If you don't take risks, you can't create a future!" - Monkey D. Luffy`
```
###### Output:
> "If you don't take risks, you can't create a future!" - Monkey D. Luffy

```markdown
> I’ll leave tomorrow’s problems to tomorrow’s me.” – Saitama
> “Being weak is nothing to be ashamed of… Staying weak is !!“ – Fuegoleon Vermillion
```
###### Output:
> I’ll leave tomorrow’s problems to tomorrow’s me.” – Saitama
> “Being weak is nothing to be ashamed of… Staying weak is !!“ – Fuegoleon Vermillion

---

## Link and Image

#### Using Image
######Syntax:
`![Image_discription](image-url)`

```
![Picture](https://images.unsplash.com/photo-1496065187959-7f07b8353c55?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxzZWFyY2h8MTJ8fHRlY2hub2xvZ3l8ZW58MHx8MHx8&auto=format&fit=crop&w=500&q=60)
```

###### Output:

![Picture](https://images.unsplash.com/photo-1496065187959-7f07b8353c55?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxzZWFyY2h8MTJ8fHRlY2hub2xvZ3l8ZW58MHx8MHx8&auto=format&fit=crop&w=500&q=60)

#### Using Link
######Syntax:
`[Link-text](url)`

```
[My Linkedin](https://www.linkedin.com/in/kumarsubroto)
```

###### Output:
[My Linkedin](https://www.linkedin.com/in/kumarsubroto)

---

## Code snippets
```
This is `code`
```
#### Output:
This is `code`

---

## Code Blocks

###### Syntax:

![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/31428wtgxb7xhs3uwtdc.jpeg)

###### Output:

![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/k6j3w5mx1r7c87oqcbm6.jpeg)

---

###### Syntax:

![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/0orgbexls0win6ac59bo.jpeg)

###### Output:


![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/bij1a77oj30b00rooegb.jpeg)

---

## Extra-Resources
#### [Github Markdown Emoji](https://gist.github.com/rxaviers/7360908)


Thank you being with me and reading my article. If you like my post, follow me on Dev.to and do connect with me on [LinkedIn](https://www.linkedin.com/in/kumarsubroto) and [GitHub](https://www.github.com/subrotokumar).