Show Menu
Cheatography

Markdown (.md) Cheat Sheet (DRAFT) by

Cheatsheet for Markdown (.md) format used in Python readme files.

This is a draft cheat sheet. It is a work in progress and is not finished yet.

Headings

Syntax
Format
# Heading1
<h1>
## Heading2
<h2>
### Heading3
<h3>
#### Heading4
<h4>
##### Heading5
<h5>
###### Heading6
<h6>

Links

Format (title: optional)
Descri­ption
Inline Link
Section Link
[text][reference]
[reference]: url title
Reference Link
Reference

Images

Format (title: optional)
Descri­ption
Inline Remote Image
Inline Local Image
![text][reference]
[reference]: /path/­to/­img.ext title
Reference Image
Reference

Unordered List

Syntax
* Item1
  - Item1.1
    + Item1.1.1
* Item2
  - Item2.1
    + Item2.1.1

Ordered List

Syntax
1. Item1
  1.1 Item1.1
    1.1.1 Item1.1.1
2. Item2
  2.1 Item2.1
    2.1.1 Item2.1.1

Task List

Syntax
Required
- [x­] Co­mpleted Task Item
True
- [  ]­ ­Inc­omplete Task Item
True
- [  ]­ ­Opt­ional Task Item, \
False

Font Effects (Emphasis)

Syntax
Descri­ption
*text*
Italic
_text_
Italic
**text**
Bold
__text__
Bold
~~text~~
Strikethrough
**_text1_ *text2* **
Combo

Tables

Syntax
Descri­ption
| Header1 | Header2 | Header3 |
Header
| ------- | ------- | ------- |
Divider
| Content1 | Content2 | Content3 |
Cell
| :-------: |
Center
| -------- |
Align Left
| -------: |
Align Left
| :------- |
Align Right

Horizontal Rules (Three or More)

Syntax
Descri­ption
***
Asterix
---
Hypen
___
Underscore

Backslash Escapes

Syntax
Descri­ption
\
Backslash
`
Backtick
*
Asterix
_
Underscore
{}
Curly Braces
[]
Square Brackets
()
Parentheses
#
Hashtag
+
Plus
-
Minus (Hypen)
.
Comma (Dot)
!
Exclamation Mark

Codes

Syntax
Descri­ption
Output
```
line1
line2
```

Multiline Block
Multiline Block
`
line1
line2
`
`line`
Inline Block
line

Blockq­uotes

Syntax
Descri­ption
>
Normal
> #
Header
> *
List
>>
Nested

Miscel­laneous

Syntax
Descri­ption
Example
@users
User Mentions
@emrecoltu
@teams
Team Mentions
@behrends
:emojis:
Emojis
:metal:
\
Ignore Format­tings
**!bold**