숏컷 코드
# 제목 1
## 제목 2
### 제목 3
- bullet 항목
- bullet 항목
1. 번호 목록
2. 번호 목록문법
제목 수준은 문서 계층을 설계하는 도구이지 글씨 크기 조절 수단이 아니다
# 개수로 정해지는 제목 수준(H1–H6)은 문서의 논리 구조를 나타낸다. 많은 렌더러와 접근성 도구(스크린 리더, 목차 생성기)가 이 계층을 기반으로 동작하기 때문에, 단순히 글자를 크게 보이게 하려고 상위 수준 제목을 남용하면 문서 구조가 무너진다. 일반적으로 H1은 문서 전체의 제목으로 한 번만 쓰고, H2부터 본문 섹션을 시작하는 패턴이 기술 문서에서 가장 흔하다.
# 프로젝트 이름 (H1: 문서 전체 제목, 한 번만)
## 설치 (H2: 주요 섹션)
### macOS (H3: 하위 섹션)제목 수준을 건너뛰면 자동화 도구와 접근성이 깨진다
H2 다음에 H4를 쓰는 것처럼 수준을 건너뛰어도 대부분의 렌더러는 시각적으로 표현은 해 준다. 그러나 GitHub의 자동 목차, 정적 사이트 빌더의 사이드바, 스크린 리더는 계층 순서를 기대하기 때문에 수준을 건너뛰면 의도하지 않은 목차 구조나 탐색 오류가 발생할 수 있다. 긴 문서에서는 제목 계층을 안정적으로 유지하는 습관이 특히 중요하다.
<!-- 잘못된 예: H2에서 H4로 건너뜀 -->
## 설치
#### macOS 설정
<!-- 올바른 예: H2 → H3 순서 유지 -->
## 설치
### macOS 설정순서 없는 목록과 번호 목록은 의미가 다르다
-(또는 *, +)로 시작하는 bullet 목록은 항목 간 순서나 우선순위가 없는 나열에 쓴다. 1.로 시작하는 번호 목록은 순서가 중요한 단계적 절차에 적합하다. 설치 단계처럼 순서를 따라야 하는 내용을 bullet 목록으로 쓰면 독자가 임의 순서로 읽을 수 있다고 오해할 수 있다. 문법 기준으로는 번호 목록의 숫자가 실제 렌더링에서는 자동으로 재정렬되므로, 소스에서 모두 1.로 써도 렌더링에는 문제가 없다.
<!-- 순서 없음: 기능 목록 -->
- 로그인 화면
- 대시보드
- 설정 페이지
<!-- 순서 있음: 설치 절차 -->
1. 저장소를 클론합니다.
2. 의존성을 설치합니다.
3. 서버를 시작합니다.목록 마커(-, *, +)는 한 문서 안에서 통일하는 것이 협업에 유리하다
CommonMark는 -, *, + 세 가지를 모두 bullet 마커로 허용하지만, 같은 목록 안에서 마커를 섞으면 다른 목록으로 분리될 수 있다. 프로젝트 전체에서 -를 기본으로 통일하면 diff 리뷰에서 변경 의도가 더 명확해지고, linting 도구(markdownlint 등)와도 잘 맞는다.
실무에서는 제목을 시각 크기용으로 쓰거나, 단계 절차를 bullet로 적는 두 실수가 가장 자주 나온다. "이 문장이 섹션 이름인가, 단계인가, 그냥 강조인가"를 먼저 구분하면 대부분의 구조 오류를 초반에 막을 수 있다.
<!-- 같은 목록 안에서 마커 혼용: 렌더러에 따라 분리될 수 있음 -->
- 항목 A
* 항목 B
<!-- 통일된 마커: 안전 -->
- 항목 A
- 항목 B선택 기준
| 상황 | 적합한 선택 |
|---|---|
| 문서 전체 제목 | # H1 (한 번만) |
| 주요 섹션 구분 | ## H2 |
| 하위 주제 | ### H3 (수준 순서 유지) |
| 순서 없는 항목 나열 | - item (마커 통일) |
| 순서 있는 단계적 절차 | 1. item |
| 자동 재정렬을 고려한 번호 목록 | 소스에서 전부 1.로 써도 무방 |
| "이 순서를 바꾸면 안 되나?"가 중요할 때 | bullet 대신 번호 목록 |
주의할 점
제목 수준을 건너뛰면 렌더링은 되지만 자동 목차 생성과 스크린 리더 탐색이 깨질 수 있습니다. 제목은 글씨 크기 조절 도구가 아니라 문서 계층 설계 도구입니다. 긴 문서에서는 H1 → H2 → H3 순서를 지키는 습관이 가독성과 접근성 모두에 영향을 줍니다.
- 저장소를 클론합니다.
- 의존성을 설치합니다.
- 서버를 시작합니다.이렇게 쓰면 읽는 사람은 세 항목을 "순서 없는 목록"으로 해석할 수 있습니다. 절차 문서는 번호 목록이 더 안전합니다.
참고 링크
2 sources