HEADERS
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 Ordered
- Item 1
- Item 2
- Item 2a
- Item 2b
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
IMAGES Format: LINKS http://github.com - automatic! GitHub
BLOCKQUOTES As Kanye West said:
We're living the future so the present is our past.
BACKSLASH ESCAPES *literal asterisks* literal asterisks Markdown allows you to use backslash escapes to generate literal characters which would otherwise have special meaning in Markdown’s forma�ing syntax. Markdown provides backslash escapes for the following characters: \ backslash ` backtick
- asterisk _ underscore {} curly braces [] square brackets () parentheses
- plus sign
-
minus sign (hyphen) . dot ! exclamation mark
TASK LISTS
-
@mentions, #refs, links, formatting, and
tagssupported -
list syntax required (any unordered or ordered list supported)
-
this is a complete item
-
this is an incomplete item @mentions, #refs, links, forma�ing, and tags supported list syntax required (any unordered or ordered list supported) this is a complete item this is an incomplete item
USERNAME @MENTIONS Typing an @ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.
ISSUE REFERENCES Any number that refers to an Issue or Pull Request will be automatically converted into a link. #1 defunkt#1 defunkt/github-flavored-markdown#1
TABLES You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe | :
First Header | Second Header |
---|---|
Content cell 1 | Content cell 2 |
Content column 1 | Content column 2 |
FENCED CODE BLOCKS Markdown coverts text with four leading spaces into a code block; with GFM you can wrap your code with ``` to create a code block without the leading spaces. Add an optional language identifier and your code with get syntax highlighting.
function test() {
console.log("look ma`, no spaces");
}
function test() { console.log("look ma`, no spaces"); }
EMOJI To see a list of every image we support, check out www.emoji-cheat-sheet.com GitHub supports emoji! :+1: :sparkles: :camel: :tada: :rocket: :metal: :octocat: