sumantmani/markdown

A unofficial markdown reference manual

Markdown Cheatsheet

Table of Contents

• What is markdown
• Header
• List
• Horizontal Rules
• Emphasis
• Links
• Blockquotes
• Inline images
• Comments

---

What is markdown ?

Markdown definition on wiki

Markdown is a lightweight markup language with plain text formatting syntex. It is designed so that it can be converted to HTML and many other format using atool by the same name.

Header

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

H1

H2

H3

H4

H5

H6

List

Unordered

* Item 1
* Item 2
* Item 3
  * subitem a
  * subitem b

• Item 1
• Item 2
• Item 3
  • subitem a
  • subitem b

Ordered

1. Item 1
2. Item 2
3. Item 3
  1. subitem a
  2. subitem b

1. Item 1
2. Item 2
3. Item 3
   1. subitem a
   2. subitem b

Horizontal Rules

 ---
 ___
 *** 

(Three consecutive dashes)

---

(Three consecutive underscores)

---

(Three consecutive asterisks)

---

Emphasis

Bold

**A Bold Text**

A Bold Text

Italics

_This is italic_

This is italic

Strikethrough

~~This is strikethrough text~~

This is strikethrough text

Links

[I am a link](https://github.com/sumantmani/)

I am a link

Blockquotes

> I am example blockquoted
> continued blockquoted

I am example blockquoted
continued blockquoted

Inline images

![Alt text](/path/to/img.jpg)

![Alt text](/path/to/img.jpg "Optional title")

Comments

[comment]: <> (This is a comment.)