BLOCKQUOTES
As Kanye West said:
> We're living the future so
> the present is our past.
As Kanye West said:
We're living the future so
the present is our past.
LISTS
Unordered
Ordered
* Item 1
* Item 2
* Item 2a
* Item 2b
1. Item 1
2. Item 2
3. Item 3
* Item 3a
* Item 3b
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 formatting
syntax.
Markdown provides backslash escapes for the
following characters:
\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark
MARKDOWN
SYNTAX
Markdownis a way to style text on
the web. You control the display of
the document; formatting words as
bold or italic, adding images, and
creating lists are just a few of the
things we can do with Markdown.
Mostly, Markdown is just regular text
with a few non-alphabetic characters
thrown in, like # or *.
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*
IMAGES
Format: 
LINKS
http://github.com - automatic!
[GitHub](http://github.com)
TASK LISTS
- [x] @mentions, #refs, [links](),
**formatting**, and <del>tags</del>
supported
- [x] list syntax required (any
unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
@mentions, #refs, links,
formatting,
and tags supported
list syntax required (any unordered
or ordered list supported)
this is a complete item
this is an incomplete item
USERNAME @MENTIONS
TABLES
First Header | Second Header
------------ | -------------
Content cell 1 | Content cell 2
Content column 1 | Content column 2
First Header
Second Header
Content cell 1
Content cell 2
Content column 1
Content column 2
GITHUB
FLAVORED
MARKDOWN
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.
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 | :
FENCED CODE BLOCKS
```javascript
function test() {
console.log("look ma`, no spaces");
}
```
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.
EMOJI
To see a list of every image we support, check out
www.emoji-cheat-sheet.com
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
GitHub supports emoji!
:+1: :sparkles: :camel: :tada:
:rocket: :metal: :octocat:
GitHub supports emoji!
GitHub.com uses its own version of
the Markdown syntax that provides
an additional set of useful features,
many of which make it easier to work
with content on GitHub.com.
function test() {
console.log("look ma`, no spaces");
}
