Skip to main content

Markdown

Markdown is a popular format now a days, it started with writing documentation for github and now extensively used for documenting, blogging.

Document: Mastering Markdown · GitHub Guides PDF: markdown-cheatsheet-online (github.com)

Sr noNameSyntaxDescription
1Main heading# Main headingUse single # with space to create main heading
2Sub heading## Sub headingUse ## with space to create sub heading
3Least heading### Least headingUse ### with space to create leap heading
4ParagraphWrite simple text in a new line to write paragraph, there should be new line between paragraphs
5Bold text**Bold text here**Enclose text between ** to make the text bold
6Italic text*Italic text here*Enclose text between * to make the text italic
7Underline_Underline text here_Enclose text between _ to make the text underline
8Strike through~~Strike through text here~~Enclose text between ~~ to make the strike through
9Hyperlink[link text](http://yourlink.com/the/url\)Enclose link text between [] and the target link in ()
10Code``` language\n code here \n ```The code text should be between 3 back quotes start line and 3 back quotes end line.
11Inline code`Your inline code here`The code text should be between back quotes
12Block quote text> The block quote text will come hereThe block quote text will start with > and space
13Un order list* The bullet pointThe * or - symbols followed by space represents bullet points of un order list
14Order list\1. The bullet pointThe 1. represents orders list, you can use multiple 1s or other numbers for each point
15Task list[x] list syntax required (any unordered or ordered list supported)[x] represents selected item, [] represents not selected item
16TableThe heading represented with First Header | Second Header and a und er line with ------, then more rows

Examples

As it was difficult to show samples in table, i decided to create them below with serial numbers

1 Main heading

2 Sub heading

3 Least heading

4 This is a paragraph line, if you put more lines without a new line in between it will still considered as single paragraph.

5 Bold text

6 Italic text

7 Underline text here : -- For some reason not showing underline?

8 Strike through text

9 Hyperlink

// 10 the sample code

if (isAwesome){
return true
}

11 Inline code The inline code looks like this

12 Block quote text looks like this All the text before new line will be considered part of block quote.

  • 13 The first un order list item The bullet points will start with *
    • Sub un order list first item
    • Sub un order list second item
  • The second un order list item
  • The first un order list item
    • Sub un order list first item
    • Sub un order list second item
  • The second un order list item
  1. 14 The first order list item
    1. First sub order list item
    2. Second sub order list item
  2. The second order list item
  • 15 @mentions, #refs, links, formatting, and tags supported
  • list syntax required (any unordered or ordered list supported)
  • this is a complete item
  • this is an incomplete item
16 First HeaderSecond Header
Content from cell 1Content from cell 2
Content in the first columnContent in the second column