Markdown
Markdown is a markup language similar to HTML but more simple. You can write everything in markdown. Especially documentation. My entire blog posts is written in markdown, every single documentation on github is written using markdown. What are you waiting to learn it? Here’s my notes of a course that I did to learn markdown.
Titles
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| # title 1
## title 2
### title 3
#### title 4
##### title 5
###### title 6
or
# title 1 #
## title 2 ##
### title 3 ###
#### title 4 ####
##### title 5 #####
###### title 6 ######
or
title
=====
or
title
-----
|
Paragraph
1
2
3
4
5
| text text text__ <- 2 spaces at end "break line"
text text text
<- this, really break line
text text text
|
Example with 2 spaces at end:
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry’s standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.
It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
Highlights
1
2
3
4
5
6
7
8
9
| **bold** or __bold__
*italic* or _italic_
***bold italic*** or **_bold italic_** or __*bold italic*__
~~scratched~~
> quote
|
Horizontal rule
1
2
3
4
5
6
7
8
9
| *** or * * * or ***...
or
--- or - - - or ---...
or
___ or _ _ _ or ___...
|
Unordered list
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
| * item 1
* item 2
* item 3
or
- item 1
- item 2
- item 3
or
+ item 1
+ item 2
+ item 3
or
. item 1
. item 2
. item 3
|
Ordered list
1
2
3
| 1. 1. 1.
2. or 1. result -> 2. markdown follow the sequence of the first number
3. 1. 3.
|
Link
1
2
3
| [text](link)
[text](link "text if the user stop the mouse on the link")
|
image
1
2
3
| 
[](link)
|
Table
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| |title|title|
|-----|-----|
|data |data |
can be like this (but it's not recommended):
|title|title|
|-|-|
|data|data|
Alignment:
left: |:-|
right: |-:|
center: |:-:|
Example:
table with data aligned on center:
|title|title|
|:---:|:---:|
|data |data |
|
Code
1
2
3
4
5
6
7
| code in line `code`
code block (can be a pair of 3 "~"):
```language
code
```
|
Checkbox
1
2
3
| * [ ] item 1
* [x] item 2 marked
* [ ] item 3
|
Emoji
Documentation and Utilities
Markdown offical documentation
Markdown Emojis
Markdown web preview
Free course on Udemy(in Portuguese)
