Markdown확장 문법과 GitHub

알림 블록과 admonition

GitHub에서 메모, 경고, 팁을 구분해 보여 주는 alert block 문법을 정리합니다.

마지막 수정 2026년 3월 19일

기본 패턴

text
> [!NOTE]
> 이 문단은 참고 메모입니다.

> [!WARNING]
> 주의가 필요한 설정입니다.

설명

  • GitHub는 blockquote 확장 문법으로 note, tip, important, warning, caution 같은 alert 블록을 지원합니다.
  • 일반 인용문보다 목적이 더 분명해서, 독자가 "참고", "경고", "중요"를 빠르게 구분할 수 있습니다.
  • 문서 전체가 알림 상자로 가득 차면 효과가 떨어지므로, 정말 강조가 필요한 지점에만 쓰는 편이 좋습니다.
  • 이 문법은 GitHub 특화 확장이라 일반 Markdown 렌더러에서는 같은 모양으로 보장되지 않을 수 있습니다.

짧은 예제

text
> [!TIP]
> 명령 실행 전에 `.env.example`을 먼저 복사해 두면 설정 실수를 줄일 수 있습니다.

빠른 정리

항목설명
[!NOTE]참고 정보
[!TIP]사용 팁
[!IMPORTANT]꼭 기억해야 하는 정보
[!WARNING]주의가 필요한 내용
[!CAUTION]위험도가 더 큰 경고

주의할 점

alert 블록을 너무 많이 쓰면 모든 문단이 똑같이 중요해 보이게 됩니다. 정말 놓치면 안 되는 정보에만 제한적으로 사용하는 편이 더 효과적입니다.

참고 링크

1 sources