Markdown Toolbox Logo Markdown Toolbox
블로그

치트 시트 - 깃허브 스타일 마크다운

2023-12-12

GitHub Flavored Markdown (GFM)은 표준 Markdown 구문에 GitHub에 특정한 몇 가지 추가 기능을 포함합니다. 이 치트 시트는 GFM의 주요 측면을 다루어 GitHub에서 README, 문제 및 기타 문서를 쉽게 만들 수 있도록 합니다.

확장 구문

작업 목록

  • 완료되지 않은 작업을 위해 - [ ]를 사용하고 완료된 작업을 위해 - [x]를 사용하여 작업 목록을 만드세요.

    -   [x] 완료된 작업
    -   [ ] 미완료 작업
    

취소선

  • 텍스트를 취소선 처리하려면 이중 틸다 ~~를 사용하세요.

    ~~취소선~~
    

  • 하이픈 -과 파이프 |를 사용하여 표를 만드세요.

    | 헤더 1 | 헤더 2 |
    | -------- | -------- |
    | 행 1    | 데이터 1   |
    | 행 2    | 데이터 2   |
    

코드 블록 감싸기

  • 삼중 백틱 (```)을 사용하고 구문 강조를 위해 언어를 지정하세요.

    ```javascript console.log("안녕, 세계!"); ```

사용자 및 팀 언급하기

  • @username을 사용하여 사용자 또는 팀을 언급하세요.

문제 및 풀 요청 참조

  • #를 사용하여 문제 및 풀 요청을 참조하세요.

표준 Markdown 구문

헤더

  • #로 헤더를 만드세요. 더 많은 #는 더 작은 헤더를 의미합니다.

텍스트 형식화

  • 굵게: **굵게**
  • 이탤릭: *이탤릭*
  • 굵고 이탤릭: ***굵고 & 이탤릭***

목록

  • 순서 없는 목록: -, + 또는 *로 시작하세요.
  • 순서 있는 목록: 숫자로 시작하고 .가 뒤따릅니다.

링크 및 이미지

  • 링크: [제목](URL)
  • 이미지: ![대체 텍스트](URL)

블록 인용

  • 블록 인용을 위해 >를 사용하세요.

GitHub의 Markdown은 협업 프로젝트의 맥락에서 특히 유용한 보다 상호작용적이고 동적인 문서를 허용합니다.