Just in case you always wanted a Markdown Guide#
A quick reference for learning Markdown, the lightweight markup language used for formatting text on the web (e.g., GitHub, Reddit, and many docs).
Basics#
Headings#
Use # for headings (1–6 levels).
# H1
## H2
### H3
#### H4
##### H5
###### H6Paragraphs & Line Breaks#
Just write normally for a paragraph. Use two spaces at the end of a line for a line break. Or insert a blank line between paragraphs.
This is a paragraph.
This is another paragraph.Emphasis#
| Style | Markdown | Output |
|---|---|---|
| Italic | *text* or _text_ | Italic |
| Bold | **text** or __text__ | Bold |
| Bold & Italic | ***text*** | Bold & Italic |
~~text~~ |
Links & Images#
Links#
[OpenAI](https://www.openai.com)Images#
Lists#
Unordered List#
- Item 1
- Item 2
- Subitem 2a
- Subitem 2b- Item 1
- Item 2
- Subitem 2a
- Subitem 2b
Ordered List#
1. First
2. Second
3. Third- First
- Second
- Third
Code#
Inline Code#
Use `print("Hello, world!")` inside text.Use print("Hello, world!") inside text.
Code Blocks (Triple Backticks)#
Produces:
def greet(name):
return f"Hello, {name}!"Blockquotes#
> This is a blockquote.
> It can span multiple lines.This is a blockquote. It can span multiple lines.
Tables#
| Column A | Column B | Column C |
|-----------|-----------|-----------|
| Data 1 | Data 2 | Data 3 |
| Data 4 | Data 5 | Data 6 || Column A | Column B | Column C |
|---|---|---|
| Data 1 | Data 2 | Data 3 |
| Data 4 | Data 5 | Data 6 |
Task Lists#
- [x] Learn Markdown basics
- [ ] Practice writing docs
- [ ] Build a README.md- Learn Markdown basics
- Practice writing docs
- Build a README.md
Horizontal Rules#
---
***
___All three produce a horizontal rule.
Tips#
- You can mix bold, italic, and
codefreely. - Most Markdown renderers (like GitHub) also support:
- Syntax highlighting for code
- Tables and task lists
- Emoji shortcodes (e.g.,
:rocket:)
- Save files as
.mdextension (e.g.,README.md)
Now you know the essentials! Experiment by editing and previewing Markdown in VS Code, Typora, or GitHub.

