Velog·GitHub에서 마크다운 활용 가이드

개발자 필수 플랫폼인 GitHub과 Velog는 표준 마크다운(CommonMark/ GFM)을 기반으로 하지만, 각 플랫폼마다 고유한 렌더링 특징과 추가 팁이 존재합니다.

1. GitHub Flavored Markdown (GFM) 전용 팁

GitHub에서는 저장소의 README.md, Issue, Pull Request 작성 시 다음과 같은 특수 기능을 지원합니다.

A. 경고 / 콜아웃 박스 (Alerts)

> [!NOTE]
> 참고할 유용한 모범 사례입니다.

> [!IMPORTANT]
> 프로젝트 실행 전 반드시 확인해야 할 중요한 내용입니다.

> [!WARNING]
> 호환성 문제나 주의가 필요한 항목입니다.

B. 사용자 언급 및 이슈 링크

• 사용자 언급: @username
• 이슈 / PR 참조: #12 (자동으로 12번 이슈/PR에 링크 생성)

2. Velog(벨로그) 마크다운 작성 팁

Velog는 개발자 전용 블로그 플랫폼으로 깔끔한 WYSIWYG/마크다운 스플릿 에디터를 지원합니다.

• 자동 목차(TOC) 생서: # 또는 ## 헤더를 지정해 두면 글 우측에 목차가 자동으로 렌더링됩니다.
• 코드 하이라이팅: 백틱 3개 지정 시 대소문자 구분 없이 대부분의 현대 개발 언어를 지원합니다.

직접 실습해보세요! 편집기에서 직접 실습하기 →