Skip to content

Instantly share code, notes, and snippets.

@Serrin
Last active March 9, 2022 11:14
Show Gist options
  • Save Serrin/b454b628e20dd0edc4145d207fdbc7b9 to your computer and use it in GitHub Desktop.
Save Serrin/b454b628e20dd0edc4145d207fdbc7b9 to your computer and use it in GitHub Desktop.

Source

Basic Markdown tags

Headers

This is a H1

This is a H2

This is a H3

This is a H4

This is a H5
This is a H6
# This is a H1
## This is a H2
### This is a H3
#### This is a H4
##### This is a H5
###### This is a H6

Paragraph

Paragraphs are separated by a blank line.


Paragraphs are separated
by a blank line.

Break line

Two spaces at the end of a line leave a
line break.

Two spaces at the end of a line leave a  
line break.

You can use the
tag too.

You can use the <br> tag too.

Text styles

italic
italic
bold
bold
bold and italic
bold and italic
strikethrough
monospace

_italic_
*italic*
__bold__
**bold**
___bold and italic___
***bold and italic***
~~strikethrough~~
`monospace`

Horizontal rule


---

Lists

Unordered

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

Ordered

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

Images

GitHub Logo

![GitHub Logo](/images/logo.png)

Format: ![Alt Text](url)

Links

http://github.com - automatic!

http://github.com - automatic!

Format: 'GitHub`

Blockquotes

As Kanye West said:

We're living the future so the present is our past.

> We're living the future so
> the present is our past.

Inline code

I think you should use an <addr> element here instead.

I think you should use an
`<addr>` element here instead.

GitHub Flavored Markdown

Syntax highlighting:

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

You can also simply indent your code by four spaces:

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

Task Lists

  • @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
- [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

Tables

First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column
First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

SHA references

Any reference to a commit’s SHA-1 hash will be automatically converted into a link to that commit on GitHub.

16c999e8c71134401a78d4d46435517b2271d6ac mojombo@16c999e8c71134401a78d4d46435517b2271d6ac mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

Issue references within a repository

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

#206

Celestra#206

Serrin/Celestra#206

#206

Celestra#206

Serrin/Celestra#206

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. Automatic linking for URLs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment