MARKDOWN
S Y N TA X
Markdown is 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
LISTS
Unordered
* Item 1
* Item 2
IMAGES
B LO CKQ U OT E S
As Kanye West said:
Format: 
> We're living the future so
BACK SL ASH ESCAPES
Markdown allows you to use backslash escapes to
generate literal characters which would otherwise
have special meaning in Markdowns formatting
syntax.
> the present is our past.
* Item 2a
* Item 2b
\*literal asterisks\*
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*
Ordered
1. Item 1
2. Item 2
3. Item 3
* Item 3a
* Item 3b
LINKS
As Kanye West said:
*literal asterisks*
[Link] - automatic!
We're living the future so
the present is our past.
[GitHub]([Link]
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
GITHUB
F L AV O R E D
MARKDOWN
[Link] 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 [Link].
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 youre
mentioning the individual. You can also @mention
teams within an organization.
TA S K L I S T S
- [x] @mentions, #refs, [links](),
**formatting**, and <del>tags</del>
supported
- [x] list syntax required (any
FENCED CODE BLOCKS
TA B L E S
EMOJI
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.
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 | :
To see a list of every image we support, check out
[Link]
unordered or ordered list supported)
ISSUE REFERENCES
Any number that refers to an Issue or Pull Request
will be automatically converted into a link.
- [ ] this is an incomplete item
@mentions, #refs, links, formatting,
and tags supported
#1
list syntax required (any unordered
or ordered list supported)
defunkt#1
this is a complete item
defunkt/github-flavored-markdown#1
this is an incomplete item
:+1: :sparkles: :camel: :tada:
First Header | Second Header
- [x] this is a complete item
GitHub supports emoji!
:rocket: :metal: :octocat:
------------ | ------------```javascript
Content cell 1 | Content cell 2
function test() {
Content column 1 | Content column 2
[Link]("look ma`, no spaces");
}
```
First Header
function test() {
[Link]("look ma`, no spaces");
}
Second Header
Content cell 1
Content cell 2
Content column 1
Content column 2
GitHub supports emoji!
