기술 문서를 위한 Markdown 팁
좋은 기술 문서는 꾸준히 투자할 가치가 있는 역량입니다. 제가 매일 사용하는 Markdown 팁을 정리했습니다.
제목으로 구조 잡기
제목 단계는 건너뛰지 마세요. h2 → h3 → h4 순서대로 내려가는 것이 중요합니다. 이유는 다음과 같습니다:
- 접근성(스크린 리더)
- SEO(검색 엔진의 제목 계층 파싱)
- 목차 자동 생성
언어 태그가 있는 코드 블록
구문 강조를 위해 언어를 항상 지정하세요:
function greet(name: string): string {
return `Hello, ${name}!`;
}
구조화된 데이터를 위한 표
| 기능 | 지원 여부 |
|---|---|
| 코드 블록 | ✅ |
| 표 | ✅ |
| 이미지 | ✅ |
| 수식 | 플러그인 필요 |
강조를 위한 인용문
참고: 인용문은 독자가 놓치지 말아야 할 중요한 정보를 강조할 때 좋습니다.