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
1
2
3
4
5
6
| # Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
|
Here is a heading: # Heading, don’t do this: #Heading
Emphasis
1
2
3
4
5
6
7
| 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
1
2
3
| ---
First line with two spaces after.
And the next line.
|
Lists
Ordered Lists
1
2
3
| 1. First item
2. Second item
3. Third item
|
Unordered Lists
1
2
3
| - First item
- Second item
- Third item
|
Links
1
| Link with text: [link-text](https://www.google.com)
|
Images
1
2
3
| Image with alt text: 
Image without alt text: 
|
Code Blocks
Inline Code Block
1
| Inline `code` has `back-ticks around` it.
|
```Shell
```
```Bash
```
```JSON
```
```YAML
```
```ini
```
```Dockerfile
```
```conf
```
```env
```
```
```
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.
1
2
3
4
| | Heading 1 | Heading 2 | Heading 3 |
|---|---|---|
| col1 | col2 | col3 |
| col1 | col2 | col3 |
|
Task list
To create a task list the start line with square brackets with an empty space. Ex: [ ] and add text for the task. To check the task replace the space between the bracket with "x".
1
2
3
| [x] Write the post
[ ] Update the website
[ ] Contact the user
|
Comments powered by Disqus.