Mastering Markdown Examples

Showing some basic markdown syntax, based on Mastering Markdown on gitbook.

Useful links:

• GitHub official document of Mastering Markdown guides
• Online markdown cheatsheet (PDF version) https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf

Table of Content

1. Anchors
2. Block Elements
3. Blockquotes
4. Code Blocks
5. Horizontal Rules
6. Images
7. Links
8. Lists
9. Special Character
10. Tables
11. Titles
12. GFM
13. Writing on GitHub

1. Anchors

See Table of Content above.

2. Block Elements

2.1 Paragraph

A paragraph is simple one or more consecutive lines of text, separated by one or more blank lines.

2.2 Line Breaks

End a line with 2 spaces, rather than a <br/>.

3. Blockquotes

This is a blockquote with two paragraphs.

This is the second paragraph, under one blank line.

4. Code Blocks

To produce a code block in Markdown, simply indent every line of the block by at least 4 spaces or 1 tab.

This is a code block.

4.1 Inline code blocks

This is a inline code block

4.2 Syntax highlighting

By specify a language.

import tensorflow as tf

5. Horizontal Rules

By three *, namely ***.

---

6. Images

7. Links

I'm an inline-style link.

I'm an inline-style link with title.

I'm a reference-style link.

I'm a relative reference to a repository file.

8. Lists

8.1 Unordered lists

asterisks recommended

• Asterisk

8.2 Ordered lists

numbers followed by period and a space

1. Bird
2. McHale
3. Parish

9. Special Character

Inside Markdown code spans and blocks, angle brackets(<>) and ampersands(&) are always encoded automatically.

10. Tables

Tables aren't part of the core Markdown spec, but they are part of GFM (GitHub Flavored Markdown).

Tables	Are	Cool
col 3 is	right-aligned	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

11. Titles

This is an H2

This is an H3

This is an H4

12. GFM

GitHub Flavored Markdown.
Some differences from the standard Markdown:

12.1 Automatic linking for URLs

Any URL (like http://www.github.com/) will be automatically converted into a clickable link.

12.2 Strikethrough text

GFM adds syntax to create strikethrough text

• Mistaken text.

12.3 Fenced code blocks

Just wrap your code in ``` some code ``` and specify a language

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

12.4 Tables

See Tables section.

13. Writing on GitHub

13.1 Task lists

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

13.2 References

Certain references are auto-inked:

• SHA: a5c3785ed8d6a35868bc169f07e40e889087fd2e
• User@SHA: perphyyoung@a5c3785ed8d6a35868bc169f07e40e889087fd2e
• User/Repository@SHA: perphyyoung/sample.js@a5c3785ed8d6a35868bc169f07e40e889087fd2e
• #Num: #26
• GH-Num: GH-26
• User#Num: perphyyoung#26
• User/Repository#Num: perphyyoung/sample.js#26

13.3 Features

1. Name and Team @mentions autocomplete
2. Emoji autocomplete, check out http://www.emoji-cheat-sheet.com
3. Issue autocomplete (Typing # will bring up)
4. Zen Mode (full-screen) writing

13.4 Emoji

1. 😄 :smile:
2. ✨ :sparkles:
3. 👎 :-1:
4. 👍 :+1:
5. 👏 :clap: