빠른 비교

1. 첫 번째
2. 두 번째
3. 세 번째

3. 세 번째부터 시작
4. 다음 항목

번호 규칙

ordered list marker는 숫자와 구분자로 만든다

CommonMark에서 ordered list marker는 1~9자리 숫자 뒤에 . 또는 )가 붙는 형태입니다. 대부분의 문서에서는 1.을 쓰지만, renderer에 따라 1)도 ordered list로 처리될 수 있습니다.

1. 기본 형태
2. 다음 항목

1) 괄호 marker
2) 다음 항목

협업 문서에서는 한 가지 marker 스타일을 고정하는 편이 좋습니다. .와 )를 섞으면 Markdown source를 읽을 때 같은 목록인지 다른 목록인지 판단이 어려워집니다.

시작 번호는 첫 항목의 숫자로 결정된다

ordered list의 실제 시작 번호는 첫 list item의 숫자를 기준으로 정해집니다. 그래서 3.으로 시작하면 HTML 렌더링에서는 start="3"에 가까운 의미가 됩니다.

3. 설치 확인
4. 로그 확인
5. 배포 진행

중간 단계부터 설명하는 문서, 긴 절차 중 일부만 발췌한 문서에서는 시작 번호를 유지하는 방식이 읽기 좋습니다. 반대로 일반 절차 문서는 1.부터 시작하는 편이 안전합니다.

문단을 끊고 시작할 때는 1번이 가장 안전하다

문단 바로 다음 줄에서 ordered list가 시작되면 renderer가 그 줄을 문단의 연속으로 볼 수 있습니다. CommonMark는 문단을 interrupt하는 ordered list의 첫 번호가 1이어야 한다는 예외를 둡니다.

설치 순서는 다음과 같습니다.
1. 패키지를 설치합니다.
2. 설정을 확인합니다.

더 안전한 문서는 문단과 목록 사이에 빈 줄을 넣습니다.

설치 순서는 다음과 같습니다.

1. 패키지를 설치합니다.
2. 설정을 확인합니다.

빈 줄은 renderer 차이를 줄이고, source를 읽는 사람에게도 목록 시작을 명확히 보여 줍니다.

선택 기준

주의할 점

문서 formatter가 모든 ordered list marker를 1.로 바꾸는 경우도 있습니다. 절차의 실제 번호가 중요한 문서라면 formatter 규칙과 렌더링 결과를 같이 확인해야 합니다.