Skip to content

Instantly share code, notes, and snippets.

@Robert-96
Last active May 13, 2025 14:52
Show Gist options
  • Select an option

  • Save Robert-96/048fddefc20e6860aeca6949a2443adf to your computer and use it in GitHub Desktop.

Select an option

Save Robert-96/048fddefc20e6860aeca6949a2443adf to your computer and use it in GitHub Desktop.
Github Markdown Cheat Sheet

Github Markdown Cheat Sheet

Headers

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

### This is an <h3> tag   
  
#### This is an <h4> tag 
  
##### This is an <h5> tag
  
###### This is an <h6> tag

This is an <h1> tag

This is an <h2> tag

This is an <h3> tag

This is an <h4> tag

This is an <h5> tag
This is an <h6> tag

Emphasis

*This text will be italic*
_This will also be italic_

**This text will be bold**
__This will also be bold__

~~This text will be crossed out (strikethrough)~~ 

_You **can** combine them_

This text will be italic This will also be italic

This text will be bold This will also be bold

This text will be crossed out (strikethrough)

You can combine them

Lists

Unordered

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

Ordered

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

Images

Format:  ![Alt Text](url)
Example: ![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)

Image of Yaktocat

Links

http://github.com - automatic!

http://github.com - automatic!

Format:  [Test](url)
Example: [GitHub](http://github.com)

GitHub

Blockquotes

As Kanye West said:

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

As Kanye West said:

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.

Fenced Code Blocks

No highlighting

\`\`\`
if (isAwesome){
  return true
}
\`\`\`
if (isAwesome) {
  return true
}

Highlighting

\`\`\`javascript 
if (isAwesome){
  return true
}
\`\`\`
if (isAwesome) {
  return true
}

Tabels

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |
First Header Second Header
Content Cell Content Cell
Content Cell Content Cell
| Left-aligned | Center-aligned | Right-aligned |
| :---         |     :---:      |          ---: |
| git status   | git status     | git status    |
| git diff     | git diff       | git diff      |
Left-aligned Center-aligned Right-aligned
git status git status git status
git diff git diff git diff

Blackslash escape

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

Name Markdown Result
backslash \\ \
backtick \` `
asterisk \* *
underscore \_ _
curly braces \{\} {}
square brackets \[\] [ ]
parentheses \(\) ()
hash mark \# #
plus sign \+ +
minus sign (hyphen) \- -
dot \. .
exclamation mark \! !

Task Lists

- [x] this is a complete item 
- [ ] this is an incomplete it
  • this is a complete item
  • this is an incomplete it

Emoji

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

👍 ✨ 🐫 🎉 🚀 🤘

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