Skip to content

Instantly share code, notes, and snippets.

@brandonstephens
Created November 30, 2021 18:34
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save brandonstephens/914088a4f50b2a4ce2d1c490c93fd96b to your computer and use it in GitHub Desktop.
Save brandonstephens/914088a4f50b2a4ce2d1c490c93fd96b to your computer and use it in GitHub Desktop.
markdown-cheatsheet
# Markdown Cheatsheet
```
The purpose of markdown is to write text without extra, software specific formatting.
Be sure to leave an extra line returns between paragraphs.
```
The purpose of markdown is to write text without extra, software specific formatting.
Be sure to leave an extra line returns between paragraphs.
## Headers
You can have header levels 1-6. But always make sure they are nested properly. You should not have a 4 without a 1,2 and 3 before.
```
# h1
## h2
### h3
```
# h1
## h2
### h3
## Emphasis
```
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
```
Emphasis, aka italics, with **asterisks** or _underscores_.
Strong emphasis, aka bold, with asterisks or __underscores__.
## Lists
You can make ordered(numbered) or unordered(bullets). When making ordered lists feel free to use all `1. ` and let the computer work out the real number.
```
1. First ordered list item
2. Another item
* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
1. Ordered sub-list
4. And another item.
```
1. First ordered list item
2. Another item
* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
1. Ordered sub-list
4. And another item.
## Blockquotes
```
> Normally, both your asses would be dead as fucking fried chicken, but you happen to pull this shit while I'm in a transitional period so I don't wanna kill you, I wanna help you. But I can't give you this case, it don't belong to me. Besides, I've already been through too much shit this morning over this case to hand it over to your dumb ass.
```
> Normally, both your asses would be dead as fucking fried chicken, but you happen to pull this shit while I'm in a transitional period so I don't wanna kill you, I wanna help you. But I can't give you this case, it don't belong to me. Besides, I've already been through too much shit this morning over this case to hand it over to your dumb ass.
## Links
```
[I'm a link to google](https://www.google.com)
<https://www.google.com>
[I'm also a link to google][1]
[1]: https://www.google.com
```
[I'm a link to google](https://www.google.com)
<https://www.google.com>
[I'm also a link to google][1]
[1]: https://www.google.com
## Images
```
![placeholder image](http://placehold.it/200x100&text=fpo%20image)
```
![placeholder image](http://placehold.it/200x100&text=fpo%20image)
## Horizontal Rule
```
Three or more...
---
Hyphens
***
Asterisks
___
Underscores
```
Three or more...
- - - -
Hyphens
*
Asterisks
___
Underscores
## Line Breaks
```
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the *same paragraph*.
```
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a **separate paragraph**.
This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the **same paragraph**.
## Tables
```
| Tables | Are | Cool |
| ------------- | ------------- | ----- |
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
```
| Tables | Are | Cool |
| ------------- | ------------- | ----- |
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
## Code
Multi-line code blocks are wrapped in ` ``` ` above and below.
```
Here is an `inline code snipped` it is good for `file://path/to/file`.
```
Here is an `inline code snipped` it is good for `file://path/to/file`.
```
#!/bin/bash
# multiline code block
cd ~/
pwd
echo "hello"
```
## Meta Data
Important meta data must go at the top of the document and be wrapped with `---` above and below.
```
---
title: Markdown cheat sheet
date: 2014-06-17 09.15.11
foo: bar
key: value
---
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment