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
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
See Table of Content above.
A paragraph is simple one or more consecutive lines of text, separated by one or more blank lines.
End a line with 2 spaces, rather than a <br/>
.
This is a blockquote with two paragraphs.
This is the second paragraph, under one blank line.
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.
This is a inline code block
By specify a language.
import tensorflow as tf
By three *
, namely ***
.
I'm an inline-style link with title.
I'm a relative reference to a repository file.
asterisks recommended
- Asterisk
numbers followed by period and a space
- Bird
- McHale
- Parish
Inside Markdown code spans and blocks, angle brackets(<>) and ampersands(&) are always encoded automatically.
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 |
GitHub Flavored Markdown.
Some differences from the standard Markdown:
Any URL (like http://www.github.com/) will be automatically converted into a clickable link.
GFM adds syntax to create strikethrough text
Mistaken text.
Just wrap your code in ``` some code
``` and specify a language
function test() {
console.log("Notice the blank line before this function?");
}
See Tables section.
- @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
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
- Name and Team @mentions autocomplete
- Emoji autocomplete, check out http://www.emoji-cheat-sheet.com
- Issue autocomplete (Typing # will bring up)
- Zen Mode (full-screen) writing
- π
:smile:
- β¨
:sparkles:
- π
:-1:
- π
:+1:
- π
:clap: