aryankargwal / markdown

A collection of various Markdown commands at hand and other links that can be helpful while doing Repository Documentation.

markdown

Some important links:

• My PPT
• Markdown Practices
• Documentation Badges
• Sample Documentations
• Sample Contribution
• Licensing Guide

Following is a list of handy markdown commands:

Heading and Font Sizes:

There are 6 pre-defined text sizes which are in form of "Headings".

#Heading1
##Heading2
###Heading3
####Heading4
#####Heading5
######Heading6

Heading1

Heading2

Heading3

Heading4

Heading5

Heading6

Formatting Text

Italics

*This is a text*
_This is a text_

This is a text
This is a text

Strong

**This is a text**
__This is a text__

This is a text
This is a text

Strikethrough

~~This is a text~~

This is a text

Links and Images

Inline Links

[I'm an inline-style link](!www.google.com)

I'm an inline-style link

Inline Image

![alt text](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)

Code Blocks

Inline Code

`a = b + c`

a = b + c

Code Blocks

    a = 1
    b = 2
    c = a + b

Language Specific Blocks

s = "Python syntax highlighting"
print s

Lists and Checkboxes

Ordered List

1. Tea
2. Coffee
3. Oreo

1. Tea
2. Coffee
3. Oreo

Unordered List

- Tea
+ Coffee
* Oreo

• Tea

• Coffee

• Oreo

Checkboxes

• Task1
• Task2