마크다운 미리보기로 README와 릴리즈 노트 깨짐 확인하기

개발

마크다운은 작성 화면에서는 괜찮아 보여도 실제 렌더링에서 목록, 코드블록, 링크가 깨질 수 있습니다. 특히 릴리즈 노트는 배포 직전 급하게 쓰는 경우가 많습니다.

이럴 때는 브라우저에서 바로 쓸 수 있는 Dante Tools를 열어 먼저 손으로 검증해보는 것이 좋습니다. 작은 확인 과정을 거치면 배포 후 되돌리는 시간을 줄일 수 있습니다.

마크다운 미리보기 사용 화면
마크다운 미리보기 사용 화면

언제 쓰면 좋은가

GitHub README, 배포 노트, 문서 초안을 올리기 전에 마크다운 렌더링을 빠르게 확인하는 방법입니다.

릴리즈 노트 초안

## Changed
- 로그인 만료 처리 개선
- 결제 실패 메시지 정리

```bash
npm run build
```

실무 루틴

  1. 초안 마크다운을 입력 칸에 붙여 넣습니다.
  2. 미리보기에서 제목 계층, 목록, 코드블록을 확인합니다.
  3. 링크가 자동으로 의도한 위치에 걸렸는지 봅니다.
  4. 최종본을 GitHub, Notion, 블로그 에디터에 옮기기 전에 한 번 더 읽습니다.

배포 전 체크

  • 코드블록 언어 표기가 맞는가
  • 목록 안의 줄바꿈이 깨지지 않았는가
  • 상대 링크가 배포되는 위치에서도 유효한가

마크다운은 가벼운 형식이지만 공개 문서에서는 품질이 바로 드러납니다. 미리보기 한 번이 수정 커밋을 줄입니다.

다른 글