Markdown is a way of writing rich-text (formatted text) content using plain text formatting syntax. In this post I’ll go through markdown’s syntax that you need to create README.md files of your project in GitHub.

Contents

1. Headings
2. Text Styles
3. Blockquotes
4. Strike-through
5. Subscript and Superscript
6. Tables
7. Links
8. Images
9. Lists
10. Horizontal Rule

Headings

# h1
## h2
### h3
#### h4
##### h5

h1

h2

h3

h4

h5

Text Styles

*italics* or _italics_
**bold**
**_boldAndItalic_**

italics bold boldAndItalic

Blockquotes

> I do like a Shiba Inus

I do like a Shiba Inus

Strike-through

~~I do like Shiba Inus~~

I do like Shiba Inus

Sub and Superscript

H<sub>2</sub>O
Squared<sup>2</sup>

H₂O Squared²

Tables

| Default    | Column 2   | Column 3     | Last Column |
| ---------- | ---------- | ------------ | ----------- |
|Shiba Inu   | Shiba Inu  | Shiba Inu    | Shiba Inu   |
|Coffee      | Coffee     | Coffee       | Coffee      |
|Shiba Inu   | Shiba Inu  | Shiba Inu    | Shiba Inu   |

Links

[A-wonderful-blog-with-Shiba-Inus][reference text]
[reference text]: http://5pence.net

A-wonderful-blog-with-Shiba-Inus

Images

You can add images to markdown too, very handy indeed, they are implimented a little bit like links…

![Shiba Inu](https://images.unsplash.com/photo-1575535468632-345892291673?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=987&q=80)

Lists

Ordered (1, 2, 3) and Unordered lists (-) can be obtained

1. list item one
2. list item two

1. list item one
2. list item two

Horizontal Rule

---