Skip to content

Latest commit

 

History

History
187 lines (123 loc) · 3.34 KB

README.md

File metadata and controls

187 lines (123 loc) · 3.34 KB

Table of Contents

Type this:

* [Table of Contents](#table-of-contents)
* [Headers](#Headers)
* [Formatting](#Formatting)
* [Lists](#Lists)
* [Code](#Code)
* [Links](#Links)
* [Images](#Images)
* [YouTube](#YouTube)
* [Tables](#Tables)

Get this:

Headers

Type this:

# Main Heading
## Sub Heading
### Sub Sub Heading
#### Sub Sub Sub Heading
##### Sub Sub Sub Sub Heading
###### Sub Sub Sub Sub Sub Heading

Get this:

Main Heading

Sub Heading

Sub Sub Heading

Sub Sub Sub Heading

Sub Sub Sub Sub Heading
Sub Sub Sub Sub Sub Heading

Formatting

Type this:

Emphasis, aka italics, with *asterisks* or _underscores_.

Strong emphasis, aka bold, with **asterisks** or __underscores__.

Combined emphasis with **asterisks and _underscores_**.

Strikethrough uses two tildes. ~~Scratch this.~~

Get this:

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.

Lists

Type this:

* Item 1
* Item 2
* Item 3

Get this:

  • Item 1
  • Item 2
  • Item 3

Code

Type this:

Inline `code` has `back-ticks around` it.

Get this:

Inline code has back-ticks around it.

For blocks of code, type this:

```python
s = "Python syntax highlighting"
print(s)
```

Get this:

s = "Python syntax highlighting"
print(s)

Links

Type this:

[The text I want you to click](http://www.google.com)

Get this:

The text I want you to click

Images

If you don't need to resize, type this:

![GitHub Octocat](media/octocat.jpg)

Get this:

GitHub Octocat

If you need to resize, type this:

<img src="media/octocat.jpg" width="75">

Get this:

If you care, the above can be done with hover text:

![GitHub Octocat](media/octocat.jpg "Big Octocat")

Get this:

GitHub Octocat

If you need to resize, type this:

<img src="media/octocat.jpg" width="75" title="Aw... cute little Octocat">

Get this:

Youtube

You can't embed videos in GitHub, but this is neat workaround. Grab the video thumbnail and make a link. Type this:

[![My favorite video](https://img.youtube.com/vi/wZZ7oFKsKzY/0.jpg)](https://www.youtube.com/watch?v=wZZ7oFKsKzY)

Get this:

My favorite video

Tables

Type this:

Colons can be used to align columns.

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

Get this:

Colons can be used to align columns.

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1