Back to Home
Markdown Cheat Sheet
A comprehensive guide to Markdown syntax for creating beautiful GitHub profile READMEs.
What is Markdown?
Markdown is a lightweight markup language with plain text formatting syntax. It's designed to be easy to write and easy to read, and can be converted to HTML and many other formats. GitHub uses a version of Markdown called GitHub Flavored Markdown (GFM) which includes additional features like tables, task lists, and syntax highlighting for code blocks.
This cheat sheet covers the most common Markdown syntax used in GitHub READMEs, including GitHub-specific features.
Headers
Markdown Syntax
# Heading 1
Rendered Result
Heading 1
Markdown Syntax
## Heading 2
Rendered Result
Heading 2
Markdown Syntax
### Heading 3
Rendered Result
Heading 3
Markdown Syntax
#### Heading 4
Rendered Result
Heading 4
Markdown Syntax
##### Heading 5
Rendered Result
Heading 5
Markdown Syntax
###### Heading 6
Rendered Result
Heading 6
Emphasis
Markdown Syntax
*Italic text*
Rendered Result
Italic text
Markdown Syntax
_Italic text_
Rendered Result
Italic text
Markdown Syntax
**Bold text**
Rendered Result
Bold text
Markdown Syntax
__Bold text__
Rendered Result
Bold text
Markdown Syntax
~~Strikethrough~~
Rendered Result
Lists
Markdown Syntax
1. First item
2. Second item
3. Third item
Rendered Result
- First item
- Second item
- Third item
Markdown Syntax
- First item
- Second item
- Third item
Rendered Result
- First item
- Second item
- Third item
Markdown Syntax
* First item
* Second item
* Third item
Rendered Result
- First item
- Second item
- Third item
Markdown Syntax
- First item
- Nested item
- Deeply nested
Rendered Result
- First item
- Nested item
- Deeply nested
- Nested item
Links
Images
Markdown Syntax
Rendered Result
Markdown Syntax
Rendered Result
Markdown Syntax
[](https://example.com)
Rendered Result
Code
Markdown Syntax
`inline code`
Rendered Result
inline codeMarkdown Syntax
```
code block
with multiple
lines
```
Rendered Result
code block
with multiple
linesMarkdown Syntax
```javascript
const greeting = "Hello, world!"
console.log(greeting);
```
Rendered Result
const greeting = "Hello, world!"
console.log(greeting);Tables
Markdown Syntax
| Header 1 | Header 2 |
| -------- | -------- |
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |
Rendered Result
| Header 1 | Header 2 |
|---|---|
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |
Markdown Syntax
| Left | Center | Right |
|:-----|:------:|------:|
| Left | Center | Right |
Rendered Result
| Left | Center | Right |
|---|---|---|
| Left | Center | Right |
Blockquotes
Markdown Syntax
> This is a blockquote
> It can span multiple lines
Rendered Result
This is a blockquote It can span multiple lines
Markdown Syntax
> Blockquote
>> Nested blockquote
Rendered Result
Blockquote
Nested blockquote
Horizontal Rules
Markdown Syntax
---
Rendered Result
Markdown Syntax
***
Rendered Result
Markdown Syntax
___
Rendered Result
GitHub Specific
Markdown Syntax
- [x] Completed task
- [ ] Incomplete task
Rendered Result
- Completed task
- Incomplete task
Markdown Syntax
:smile: :heart: :rocket:
Rendered Result
😄 ❤️ 🚀
Markdown Syntax
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
Rendered Result
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
Badges
Markdown Syntax
Rendered Result
Markdown Syntax
Rendered Result
Markdown Tips for GitHub READMEs
- •Use headers to organize your README into clear sections
- •Add badges to showcase project stats, build status, or version information
- •Include screenshots or GIFs to demonstrate your project visually
- •Use code blocks with language specification for proper syntax highlighting
- •Create a table of contents for longer READMEs using anchor links
- •Use emojis strategically to add visual interest and highlight important points
Ready to Create Your GitHub Profile README?
Use our GitHub Profile README Generator to create a stunning profile with perfect markdown formatting, without having to write the markdown yourself.
Create Your README Now