Basic Markdown

markdown.md

Headings

Create headings by adding #'s before the line.

# Heading 1
## Heading 2
### Heading 3

Heading 1

Heading 2

Heading 3

etc...

Tables

1. Separate columns with | signs.
2. Second line must have at least 3 dashes (-) in each column.
3. Must be a space between each two | columns, even if no text is needed.

|First|Second|Third|
|---|---|---|
|The width doesn't matter| | As long as it's not empty and ends with a \||

First	Second	Third
The width doesn't matter		As long as it's not empty and ends with a |

Styling

Style	Syntax	Example	Output
Bold	** ** or __ __	**Shalom** yafyuf	Shalom yafyuf
Italic	* * or _ _	*Shalom* yafyuf	Shalom yafyuf
Strikethrough	~ ~	~Shalom~ yafyuf	Shalom yafyuf
Combine		**_Shalom_** yafyuf	Shalom yafyuf

Note/Quote

Add a > on the first line. Use 2 spaces to wrap a line

> This is some quote.
This is not wrapped.

> This is another quote.[space][space]
This is wrapped.

This is some quote. This is not wrapped.

This is another quote.
This is wrapped.

C0de

Just like in Slack - a single ` (tick) for inline code.

Normal text `alongside` code.

Normal text alongside code.

Three ` (ticks) for blocks of code (with an optional language).

```python
def hello(name):
  print name
```

def hello(name):
  print name

Links

Links use the format of [visible text](some_url).

External links

This is a [link](https://gist.github.com/mcouthon/cf5feb696fecc85552196b45556773ce).

This is a link.

Internal links

Links to internal sections of the document start with a # followed by the (lowercase) words of the heading separated by dashes (-).

This is an internal [link](#external-links).

This is an internal link.

Relative links

Links to documents/images relative to the current document contain the path + name of the file.

This is a relative [link](0ebc4c94b5e9be32d6f7399433aa7831).

This is a relative link.

Lists

Regular lists

Lists start with * or -.

- Item
- Other item

• Item
• Other item

Nested lists

Add spaces on the lines to indent the list and make it nested.

- First section
  - Inner section
    - Innest section
- Back to first

• First section
  • Inner section
    • Innest section
• Back to first

Numbered lists

Numbered lists start with... numbers (duh).

1. First
2. Second
8. Third?
1. Order doesn't matter.

1. First
2. Second
3. Third?
4. Order doesn't matter.

Task lists

Task lists start with - [ ] (note the space between the brackets) for todos and - [x] for completed tasks.

- [ ] Still need to be done
- [ ] This as well
- [x] Already finished this one

• Still need to be done
• This as well
• Already finished this one

Emojis!

Add emojis with their codes!

This :shit: is dope! :+1:

This 💩 is dope! 👍

Autolinked references

• Commit SHA's will be automatically linked.
• Issues and pull requests can be addressed with a # in front.
• Users can be mentioned with a @ in front.
• Not going to work in this gist :sad:

Dan's latest commit SHA is 83c4dd9.
Dan's username is @dankilman.
This will be a link to the PR: floragunncom/search-guard#687

Dan's latest commit SHA is 83c4dd9.
Dan's username is @dankilman.
This will be a link to the PR: floragunncom/search-guard#687

Further reading

• Basics of GitHub markdown.
• Autolinked references and URLs.