Cheatography
https://cheatography.com
Welcome to the Markdown Cheat Sheet
This is a draft cheat sheet. It is a work in progress and is not finished yet.
Example
# Cheatography "Markdown"
## Content
- History
- Introduction
## History
|Date( YY-MM-DD)|Description|
|:-:|:-|
|23-07-22|Init|
## Introduction
Welcome to the Cheatography dedicated to Markdown file.<br>
---
Made by abarrier. |
Notes
The content is already in the Markdown format.
Then you can copy-paste it into a .md
file and/or use a preview of your choice:
- GitHub
- VSCode by using the command CTRL + SHIFT + V
.
- Markdown Live Preview
- Etc.
|
Headings
Description |
Markdown |
HTML |
Heading level 1 |
# Heading |
<h1>Heading</h1> |
Heading level 2 |
## Heading |
<h2>Heading</h2> |
Heading level 3 |
### Heading |
<h3>Heading</h3> |
Best practice:
- Place a space character between the last '#' and the heading name.
- There are 6 maximum level.
Paragraph
Description |
Markdown |
HTML |
One line paragraph |
Line |
<p>Line</p> |
Two lines paragraph |
First line Second line |
<p>First line<br> Second line</p> |
Best practice:
- Add two space characters at the end of the paragraph to get a line break. Or mix it with HTML syntax
Example:
The line break is represented by '~~' but must be two space characters.
Paragraph with line break~~
Otherwise it will be written as one line paragraph
Or use the break balise of HTML<br>
To get a line break
|
|
Text style
Description |
Markdown |
HTML |
Italic |
_text_ |
<em>text</em> |
*text* |
Bold |
__text__ |
<strong>text</strong> |
**text** |
Bold Italic |
***text*** |
<strong><em>text</em></strong> |
___text___ |
**_text_** |
__*text*__ |
Best practice:
- Use '*' instead of '_'
Lists
Description |
Markdown |
HTML |
Ordered list |
1. Item |
|
1) Item |
Unordered list |
- Item |
|
* Item |
Best practices:
- Use '1.' instead of '1)'
- Use '-' instead of '*'
|