Markdown Syntax

09 Jan 2017

Use # to indicate header
Example in Markdown:

# header1  
#### header4 ####  
header2
-------  

Output:

header1

header4

header2 ——-

Example in HTML:

<h2>header2</h2>

Output:

header2


Line Break

To add line break, use two consequtive blanks at the end of the line.
Example in Markdown:

Same 
line  

Following paragraphs  
starts here.  

Output:
Same line

Following paragraphs
starts here.

Example in HTML:

<p>Following paragraphs</p> <p>starts here.</p>

Output:

Following paragraphs

starts here.


Emphasis

Use single asterisk * or single underscore _ for italic.
Use double asterisks ** or double underscores __ for bold.
Use two tildes ~~ for strikethrough.

Example in Markdown:

*italic* _italic_ **bold** __bold__ ~~strike~~

Output:
italic italic bold bold strike

Example in HTML:

<em> italic </em>
<strong> bold </strong>

Output:
italic bold

But if you surround an * or _ with spaces, it’ll be treated as a literal asterisk or underscore. To place an asterisk or underscore without the space, use the escape backslash character \.

Example in Markdown:

This is an asterisk * and this is an underscore _
These are \*asterisks\* using backslash and these are \_underscores\_ using backslash and may contain **bold** and _italic_

Output:
This is an asterisk * and this is an underscore _
These are *asterisks* using backslash and these are _underscores_ using backslash and may contain bold and italic


Table

Use pipe | to indicate column in table.
Use minimum 3 dashes --- to indicate header.
Use colon : to indicate alignment.

Example in Markdown:

|No|Name|Team|
|---:|:---|:---:|
|1|John|A|
|2|Jane|B|
|3|Jake|F|

Output:
|No|Name|Team| |—:|:—|:—:| |1|John|A| |2|Jane|B| |3|Jake|F|


List

Use multiple rows of * + -to indicate a bullet list.
Example in Markdown:

To do list:  
 + learn markdown  
 * write a post with markdown  
     + write the first paragraph
     * write the last paragragh
 - write a blog with markdown  

Output:
To do list:

  • learn markdown
  • write a post with markdown
    • write the first paragraph
    • write the last paragragh
  • write a blog with markdown

Example in HTML:

<ul>
<li>learn markdown</li>
<li>write a post with markdown</li>
<li>write a blog with markdown</li>
</ul>

Output:

  • learn markdown
  • write a post with markdown
  • write a blog with markdown

Use multiple rows of numbers (in or our of sequence) to indicate a numbered list.
Example in Markdown:

To do list:  
 1. learn markdown  
 5. write a post with markdown  
 3. write a blog with markdown  

Output:
To do list:

  1. learn markdown
  2. write a post with markdown
  3. write a blog with markdown

Example in HTML:

<ol>
<li>learn markdown</li>
<li>write a post with markdown</li>
<li>write a blog with markdown</li>
</ol>

Output:

  1. learn markdown
  2. write a post with markdown
  3. write a blog with markdown

Code

To indicate codes, use backtick `.

Example in Markdown:

This is a `main()` function.  

Output:
This is a main() function.

Example in HTML:

This is a <code>main()</code> function.

Output:
This is a main() function.

Use double backticks to indicate a real a backtick `.
Any backtick within the double backticks will be treated as an actual backtick.

Example in Markdown:

This is a `` ` `` backtick.
`` These are `a bunch` of `b`a`c`k`t`i`c`k`s`. ``

Output:
This is a ` backtick.
These are `a bunch` of `b`a`c`k`t`i`c`k`s`.

Example in HTML:

This is a &#96; backtick. <br/>
These are &#96;a bunch&#96; of &#96;b&#96;a&#96;c&#96;k&#96;t&#96;i&#96;c&#96;k&#96;s&#96;.

Output:
This is a ` backtick.
These are `a bunch` of `b`a`c`k`t`i`c`k`s`.


Code snippet

To enable code snippet use tripple backticks ``` or or tripple tidles ~~~. Indicating the language after tripple backticks will enable syntax highlight.

Example in Markdown:

&#96;&#96;&#96;HTML
<a href=http:www.google.com>google.com </a>
<ol>
<li>learn markdown</li>
<li>write a post with markdown</li>
<li>write a blog with markdown</li>
</ol>
&#96;&#96;&#96;
<a href=http:www.google.com>google.com </a>
<ol>
<li>learn markdown</li>
<li>write a post with markdown</li>
<li>write a blog with markdown</li>
</ol>

Output:

<a href=http:www.google.com>google.com </a>
<ol>
<li>learn markdown</li>
<li>write a post with markdown</li>
<li>write a blog with markdown</li>
</ol>
<a href=http:www.google.com>google.com </a>
<ol>
<li>learn markdown</li>
<li>write a post with markdown</li>
<li>write a blog with markdown</li>
</ol>

Quotes or citations

Use > to indicate quotes / citations / indent.

Example in Markdown:

> Quote of the day

Output:

Quote of the day

Example in HTML:

<blockquote>
Quote of the day
</blockquote>

Output:

Quote of the day

URL itself will automatically be converted into link, alternatively, we can create link using []().

Example in Markdown:

http://www.google.com  
www.google.com  
[Google](www.google.com) inline link  
[Google](www.google.com "Search Engine") inline link with title  
Google link within number reference[1]  

[1]: http://www.google.com

[Google] link within itself  

[Google]: www.google.com

[Anylink] as reference is case insensitive  

[AnYLink]: www.google.com

Output:
http://www.google.com
www.google.com
Google inline link
Google inline link with title
Google link within number reference1

Google link within itself

Anylink as reference is case insensitive

Example in HTML:

<a href="http://www.google.com/">Google</a> inline link <br />
<a href="http://www.google.com/" title="Search Engine">Google</a> inline link with title <br />

Output:
Google inline link
Google inline link with title


Footnote

Create footnote using [^].
Example in Markdown:

Terms and Conditions[^1] apply.  

[^1]: Just kidding.

Output:
Terms and Conditions1 apply.

Abbreviations

Mouse over abbreaviation to show the full form.
Example in Markdown:

T&C apply.

[T&C]: Terms and Conditions

Output:
T&C apply.


Email

Create email address using angle brackets < >.

Example in Markdown:

email me at <email@address.com>

Output:
email me at email@address.com


Emoji :smile:

https://www.emoji.codes/


Image

Example in Markdown:

[![Image Alt Text](/path/to/image)](path/to/linked/page)

Backslash Escape

Use a backslash \ before these special character to actually indicate that you are typing these characters.

Example in Markdown:

\\ backslash  
\` backtick  
\* asterisk  
\_ underscore  
\{\} curly braces  
\[\] square brackets  
\(\) parentheses  
\# hash mark  
\+ plus sign  
\- minus sign (hyphen)  
\. dot  
\! exclamation mark  

Output:
\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark


  1. Just kidding. 

Published on 09 Jan 2017 Find me on Twitter GitHub LinkedIn !

comments powered by Disqus