Markdown#
Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
Documentation: Markdown Docs RFC: RFC 7763 GitHub Documentation: Writing Markdown on GitHub
Cheat-Sheet#
Headings#
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Here is a heading: # Heading, don’t do this: #Heading
Emphasis#
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.~~
Line Breaks#
First line with two spaces after.
And the next line.
Lists#
Ordered Lists#
1. First item
2. Second item
3. Third item
Unordered Lists#
- First item
- Second item
- Third item
Links#
Link with text: [link-text](https://www.google.com)
Images#
Image with alt text: 
Image without alt text: 
Code Blocks#
Inline Code Block#
Inline `code` has `back-ticks around` it.
Blocks of Code#
```javascript var s = "JavaScript syntax highlighting"; alert(s); ``` ```python s = "Python syntax highlighting" print s ``` ``` No language indicated, so no syntax highlighting. But let's throw in a tag. ```
Tables#
There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don’t need to make the raw Markdown line up prettily.
| Heading 1 | Heading 2 | Heading 3 |
|---|---|---|
| col1 | col2 | col3 |
| col1 | col2 | col3 |