GitHub Flavored Markdown Spec

Markdown is a plain text format for writing structured documents, based on conventions for indicating formatting in email and usenet posts.¹

toc#

• Emphasis
• Lists
• Task lists
• Code
• Blockquotes
• Videos

Emphasis#

italic: use * or _

bold: use ** or __

Strikethrough: use ~~

Lists#

1. First item
2. Second item
3. Third item

• starting with +

• starting with -

• starting with *

Task lists#

• Build a dream
• Work hard and persevere
• Make the dream come true

Code#

function life() {
  try {
    while (true) {
      this.eat();
      this.work();
      this.sleep();
    }
  } catch (e) {
    this.go("hell");
  }
}

Blockquotes#

Endure hardships and work hard

The sages said we should endure hardships and work hard

Nonsense, why don’t the sages endure hardships themselves

Videos#

You can copy the embed code from YouTube or other platforms, and paste it in the markdown file. We also provide a convenient method in markdown-extended#video-embed