Markdown문서화

코드 블록과 fence

삼중 backtick과 언어 지정으로 코드 예시를 깔끔하게 보여 주는 Markdown 코드 블록 기본 카드입니다.

마지막 수정 2026년 3월 19일

기본 패턴

text
```js
console.log("hello");
```

설명

  • fenced code block은 코드 예시를 문장과 구분해 보여 줄 때 가장 많이 쓰입니다.
  • 보통 삼중 backtick으로 시작하고 끝냅니다.
  • 시작 줄 뒤에 언어 이름을 쓰면 많은 렌더러에서 문법 강조가 적용됩니다.
  • 코드 예시가 있는 문서는 설명만 있는 문서보다 복습과 복사가 쉬워집니다.

짧은 예제

text
```python
for value in numbers:
    print(value)
```

```bash
git status
```

빠른 정리

요소역할
```코드 블록 시작/종료
언어 이름문법 강조 힌트
빈 줄코드 구간 구분을 더 명확하게 만듦

공식 참고: Creating and highlighting code blocks

주의할 점

코드 안에 backtick이 들어가는 경우 fence 길이를 더 길게 잡거나, 문서 구조를 다시 나누는 편이 좋습니다. 예시가 깨지면 문서 신뢰도가 빠르게 떨어집니다.