Reference

mastering-markdown

kramdown syntax

http://spec.commonmark.org

Syntax guide

Headers

# This is an <h1> tag

This is an <h2> tag

This is an <h6> tag

Emphasis

This text will be italic

This will also be italic

This text will be bold

This will also be bold

You can combine them

Lists

Unordered

• Item 1
• Item 2
  • Item 2a
  • Item 2b

Ordered

1. Item 1
2. Item 2
3. Item 3
   • Item 3a
   • Item 3b

Images

Format:

Links

Information can be found on the http://example.com homepage. You can also mail me: me.example@example.com

GitHub

Blockquotes

Hello World, This is block quotes

This is a blockquote.

on multiple lines that may be lazy.

A nested blockquote.

Inline code

I think you should use an <addr> element here instead.

Code Blocks

common usage (indent your code by four spaces)

function test() {
  console.log("notice the blank line before this function?");
}

for kramdown (without syntax highlight)

function test() {
  console.log("notice the blank line before this function?");
}

for kramdown (with syntax highlight)

function test() {
  console.log("notice the blank line before this function?");
}

Nested code blocks

~~~~~~~
code with tildes
~~~~~~~~

Task Lists

• [x] @mentions, #refs, links, formatting, and tags supported
• [x] list syntax required (any unordered or ordered list supported)
• [x] this is a complete item
• [ ] this is an incomplete item

Tables