Markdown Cheat Sheet
By AMO
Basic Syntax
Headings
Level 1: # H1
Level 2: ## H2
Level 3: ### H3
Formatting
**Text to be bold**
Text to be bold
*Text to be italicized*
Text to be italicized
~~Strikethrough text~~
Strikethrough text
Blockquote
> “Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.”
“Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.”
Ordered List
1. First item
2. Second item
3. Third item
- First item
- Second item
- Third item
Unordered List
- First item
- Second item
- Third item
- First item
- Second item
- Third item
Horizontal Rule
---
Hyperlink
[title](https://www.example.com)
Image
![alt text](image.jpg)
Advanced Syntax
Table
| Code | Description |
|-------|----------------|
| C1 | Label 1 |
| C2 | Label 2 |
Code | Description |
---|---|
C1 | Label 1 |
C2 | Label 2 |
And tool to help: Markdown Table generator
Task List
- [x] Write a post on Markdown
- [ ] Write a post on Git commands
- [ ] Check the monthly social security ceiling
- Write a post on Markdown
- Write a post on Git commands
- Check the monthly social security ceiling
Footnote
Here is a sentence with a footnote. [^1]
[^1]: This is the footnote.
Here is a sentence with a footnote. 1
Definitions
term
: definition
- term
- definition
For the IT Specialist, Mathematician, Engineer
Inline Code
Example: `print(a + " " + b)`
Example: print(a + " " + b)
Code Block
The language used can be specified after the 3 back-quotes.
```Python
import pandas as pd
data = pd.DataFrame({
‘Column1’: [1, 2, 3],
‘Column2’: [4, 5, 6],
‘Column3’: [7, 8, 9]
})
headers = list(data.columns)
print(headers)
```
import pandas as pd
data = pd.DataFrame({
'Column1': [1, 2, 3],
'Column2': [4, 5, 6],
'Column3': [7, 8, 9]
})
headers = list(data.columns)
print(headers)
Note: There are style libraries available to make code look better.
Mathematical Formulas
It depends on the Markdown rendering engine. With Hugo, I find I don’t have that.
Github announced on their blog that mathematical formulas are now rendered correctly (as of 19/05/2022). Link to article
Links to Markdown References
-
This is the footnote. ↩︎