Markdown Formatting Guide
Markdown is a lightweight markup language that allows you to format plain text using simple syntax. It's widely used for documentation, README files, comments, and more.
Quick Reference
| # Heading 1 | Largest heading |
| ## Heading 2 | Second-level heading |
| **bold text** | Bold text |
| *italic text* | Italic text |
| [link text](url) | Hyperlink |
|  | Image |
| `code` | Inline code |
| - item | Unordered list |
| 1. item | Ordered list |
| > quote | Blockquote |
Headings
Use hashtags (#) to create headings. More hashtags = smaller heading.
Markdown
Output
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Emphasis (Bold & Italic)
Use asterisks (*) or underscores (_) for emphasis.
Markdown
Output
italic text or italic text
bold text or bold text
bold and italic or bold and italic
strikethrough
Lists
Create ordered or unordered lists.
Markdown
Output
Unordered list:
- Item 1
- Item 2
- Nested item 2.1
- Nested item 2.2
- Item 3
Ordered list:
- First item
- Second item
- Third item
- Nested item 3.1
- Nested item 3.2
Links
Create hyperlinks to other pages or websites.
Markdown
Images
Embed images using similar syntax to links, with a leading exclamation mark.
Markdown
Output
Image syntax: The image would appear here
Format: 
The alt text is shown if the image can't load
Code
Display code inline or in blocks.
Markdown
Output
Inline code has backticks
Code block with multiple lines
# Code block with syntax highlighting
def hello():
print("Hello, World!")
Blockquotes
Use greater-than symbol (>) to create blockquotes.
Markdown
Output
This is a blockquote
It can span multiple lines
Nested blockquotesUse multiple > symbols
Horizontal Rules
Create horizontal lines to separate content.
Markdown
Output
A horizontal line appears above
Tables
Create tables using pipes (|) and hyphens (-).
Markdown
Output
| Header 1 | Header 2 | Header 3 |
|---|---|---|
| Row 1 | Data | Data |
| Row 2 | Data | Data |
Task Lists
Create checkable task lists (GitHub-flavored Markdown).
Markdown
Output
- ☑ Completed task
- ☐ Uncompleted task
- ☐ Another task
- ☑ Nested completed
- ☐ Nested uncompleted
Escaping Characters
Use backslash (\) to display literal Markdown characters.
Markdown
Output
*Not italic*
# Not a heading
[Not a link](url)
Characters you can escape: \ ` * _ { } [ ] ( ) # + - . ! |
Best Practices
- Blank lines: Use blank lines to separate paragraphs and sections
- Consistency: Pick one style for emphasis (either * or _) and stick with it
- Readability: Markdown should be readable even in plain text
- Preview: Always preview your Markdown before publishing
- Line breaks: End a line with two spaces for a line break, or use a blank line for a paragraph
Common Use Cases
- README files: Document your projects on GitHub, GitLab, etc.
- Documentation: Write technical documentation and guides
- Comments: Many platforms support Markdown in comments (GitHub, Stack Overflow, Reddit)
- Note-taking: Use apps like Obsidian, Notion, or Joplin
- Blogs: Many static site generators use Markdown (Jekyll, Hugo, Gatsby)
- Emails: Some email clients support Markdown formatting
Discussion
Sign in to join the discussion.