Post

Markdown Cheatsheet

Markdown Syntax

Headers

1
2
3
# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag

Emphasis

1
2
3
4
5
*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

1
2
3
4
* Item 1
* Item 2
 * Item 2a
 * Item 2b

Ordered

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

Images

1
2
![Vận Già Logo](/images/logo.png)
Format: ![Alt Text](url)

Markdown Logo

1
2
http://vegetaz.github.io
[Vận Già](http://vegetaz.github.io)

Block Quotes

1
2
3
As Vận Già said:
> I’ve always been more interested
> in the future than in the past.

Backsplash Escapes

Markdown allows you to use backslash escapes to generate literal characters which would otherwise have special meaning in Markdown’s formatting syntax.

1
\*literal asterisks\*

Markdown provides backslash escapes for the following characters:

1
2
3
4
5
6
7
8
9
10
11
12
\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark

Github Flavored Markdown

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
2
3
#1
github-flavored-markdown#1
vegetaz/github-flavored-markdown#1

Emoji

To see a list of every image we support, check out emoji-cheat-sheet

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

:+1: :sparkles: :camel: :tada: :rocket: :metal: :octocat:

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 will get syntax highlighting

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

Task Lists

1
2
3
4
- [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)
  • 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)

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 | :

1
2
3
4
First Header | Second Header
------------ | -------------
Content cell 1 | Content cell 2
Content column 1 | Content column 2
First HeaderSecond Header
Content cell 1Content cell 2
Content column 1Content column 2

Còn nữa!

This post is licensed under CC BY 4.0 by the author.