loading...

Cheatsheet for Markdown*

ssmak profile image Steve Mak Updated on ・2 min read

HEADERS

# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag

LISTS (Unordered)

* Item 1
* Item 2
 * Item 2a
 * Item 2b

LISTS (Ordered)

1. Item 1
2. Item 2
3. Item 3
 * Item 3a
 * Item 3b

IMAGES

![GitHub Logo](/images/logo.png)
Format: ![Alt Text](url)

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*

LINKS

http://github.com - automatic!
[GitHub](http://github.com)

BLOCKQUOTES

As Grace Hopper said:
> I’ve always been more interested
> in the future than in the past.

As Grace Hopper said:

I’ve always been more interested
in the future than in the past.

BACKSLASH ESCAPES

\*literal asterisks\*

*literal asterisks*

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.

FENCED CODE BLOCKS

Start with three backtick and follow by the language name.

function test() {
 console.log("look ma’, no spaces");
}

ISSUE REFERENCES

Any number that refers to an Issue or Pull Request will be automatically converted into a link.

#1
github-flavored-markdown#1
defunkt/github-flavored-markdown#1

TASK LISTS

- [x] this is a complete item
- [ ] this is an incomplete item
- [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
  • [x] @mentions, #refs, links, formatting, and tags supported
  • [x] list syntax required (any unordered or ordered list supported)

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

EMOJI

To see a list of support emoji, check out www.emoji-cheat-sheet.com

GitHub supports emoji!
:+1: :sparkles: :camel: :tada:
:rocket: :metal: :octocat: 

GitHub supports emoji!
👍 ✨ 🐫 🎉
🚀 🤘

Discussion

pic
Editor guide