TheLazy.Dev
Portfolio GitHub

Blog

cheatsheet |markdown

Cheatsheet for Markdown

ssmak

Steve Mak

Posted on February 21, 2020

Cheatsheet for Markdown

HEADERS 

# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag
Enter fullscreen mode Exit fullscreen mode

LISTS (Unordered) 

* Item 1
* Item 2
 * Item 2a
 * Item 2b
Enter fullscreen mode Exit fullscreen mode

LISTS (Ordered) 

1. Item 1
2. Item 2
3. Item 3
 * Item 3a
 * Item 3b
Enter fullscreen mode Exit fullscreen mode

IMAGES 

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

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*
Enter fullscreen mode Exit fullscreen mode

LINKS 

http://github.com - automatic!
[GitHub](http://github.com)
Enter fullscreen mode Exit fullscreen mode

BLOCKQUOTES 

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

As Grace Hopper said:

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

BACKSLASH ESCAPES 

\*literal asterisks\*
Enter fullscreen mode Exit fullscreen mode

*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");
}
Enter fullscreen mode Exit fullscreen mode

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
Enter fullscreen mode Exit fullscreen mode

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)
Enter fullscreen mode Exit fullscreen mode
  • [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
Enter fullscreen mode Exit fullscreen mode
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:
Enter fullscreen mode Exit fullscreen mode

GitHub supports emoji!
👍 ✨ 🐫 🎉
🚀 🤘

💖 💪 🙅 🚩
ssmak
Steve Mak

Posted on February 21, 2020

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related

Introdução ao markdown e aos READMEs
learning Introdução ao markdown e aos READMEs

March 18, 2024

Markdown Cheatsheet
markdown Markdown Cheatsheet

November 5, 2021

Markdown cheatsheet
markdown Markdown cheatsheet

February 9, 2021

Quick Portfolio with GitHub Readme
github Quick Portfolio with GitHub Readme

August 30, 2020

Cheatsheet for Markdown
cheatsheet Cheatsheet for Markdown

February 21, 2020