Skip to content

Latest commit

 

History

History
183 lines (130 loc) · 3.06 KB

markdown-cheatsheet.md

File metadata and controls

183 lines (130 loc) · 3.06 KB

Markdown Cheatsheet

Table of Contents

Headers

# This is an `<h1>` tag

## This is an `<h2>` 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**

_You **can** combine them_

Lists

Unordered

- Item 1
- Item 2
  - Item 2a
  - Item 2b

Ordered

1. Item 1
2. Item 2
3. Item 3
   3.1. Item 3a
   3.2. Item 3b

Links

[GitHub](http://github.com)

Images

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

Format: ![Alt Text](url)

Code and Syntax Highlighting

Inline `code`

Blocks of code are either fenced by lines with three back-ticks ```, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting.

```javascript
function fancyAlert(arg) {
  if (arg) {
    $.facebox({ div: "#foo" });
  }
}
```

Tables

| Syntax | Description |
| ------ | ----------- |
| Header | Title       |

| Paragraph | Text |

Blockquotes

As Kanye West said:

> We're living the future so

> the present is our past.

Inline HTML

<dl>
  <dt>Definition list</dt>
  <dd>Is something people use sometimes.</dd>

  <dt>Markdown in HTML</dt>
  <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>

    <dt>Markdown in Markdown</dt>
    <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>

</dl>

Horizontal Rule

Three or more...

---

Line Breaks

There's no such thing as a "line break" in Markdown. If you want a line break, you end the line with two or more spaces, then type return.

This is the first line.
This is the second line.

YouTube Videos

{% youtube %}https://www.youtube.com/watch?v=-A_WlNu6kVY{% endyoutube %}

GIFs

{% gif %}https://media.giphy.com/media/3o7TKSjRrfIPjeiVyE/giphy.gif{% endgif %}

Github Flavored Markdown

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

Emoji

This is a list of all the emojis that are supported by GitHub. For more information, see "Emoji Cheat Sheet".

```markdown
🍁🚀🙂🥵🎯⭐🤭❤️👍😊😂
```

Task Lists

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