14. VS Code & Markdown Workflow
Tier: All Tiers | Part: Tools & Technology
Essential VS Code Extensions
| Extension | Purpose |
|---|---|
| Markdown All in One | Preview, shortcuts, formatting |
| markdownlint | Catches markdown errors |
| Prettier | Auto-formats files |
| GitLens | Enhanced Git integration |
| YAML | OpenAPI spec editing |
Core Markdown Syntax
# Heading 1
## Heading 2
### Heading 3
**Bold text**
*Italic text*
`inline code`
[Link text](https://url.com)
| Column 1 | Column 2 |
|---|---|
| Cell | Cell |
- Bullet item
- Bullet item
1. Numbered item
2. Numbered item
> Blockquote / callout text
File Naming Conventions
docs/
├── getting-started.md ✅ lowercase-with-hyphens
├── api-reference.md ✅ descriptive names
├── POST_messages.md ❌ avoid uppercase
└── doc1.md ❌ avoid non-descriptive names
Checklist
- VS Code installed with essential extensions
- Markdown preview working
- File naming conventions established
- Linting configured