← Back to Mission Control

Communication Protocols

5 min read

Markdown Cheat Sheet

Mission Phase 31 • Difficulty: Beginner

The Language of Documentation

Markdown is a lightweight markup language GitHub uses for README files, issues, pull requests, and documentation.

Headers

# H1 Header
## H2 Header
### H3 Header
#### H4 Header

Emphasis

*italic* or _italic_
**bold** or __bold__
***bold italic***
~~strikethrough~~

Lists

Unordered:
* Item 1
* Item 2
  * Nested item

Ordered:
1. First
2. Second
3. Third

Links

[Link text](https://example.com)
[Link with title](https://example.com "Tooltip text")

Images

![Alt text](image-url.png)
![Logo](https://example.com/logo.png "Optional title")

Code

Inline: `code here`

Block:
```javascript
function hello() {
    console.log("Hello!");
}
```

Blockquotes

> This is a quote
> 
> Multiple paragraphs

Tables

| Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |
| Cell 3   | Cell 4   |

Task Lists

- [x] Completed task
- [ ] Pending task
- [ ] Another task

Horizontal Rule

---
or
***

GitHub-Specific Features

Mention Users

@username

Reference Issues

#123 (issue number)

Emoji

:rocket: :star: :tada:

Alerts (New!)

> [!NOTE]
> Useful information

> [!WARNING]
> Critical warning

README Best Practices

Next: Your Astronaut Profile

You've learned Markdown formatting. Next, create your GitHub profile README—your professional introduction to the developer community!