Markdown을 목차 있는 HTML로 만드는 방법
긴 Markdown 문서는 그대로 보내면 받는 사람이 읽기 어렵습니다. 제목 구조만 잘 잡아 두면 왼쪽 목차가 달린 HTML 문서로 바로 바꿀 수 있습니다.
왜 HTML 파일로 보내나요?
Markdown 파일(.md)은 전용 프로그램이 없으면 ##이나 ** 같은 기호가 그대로 보입니다. HTML 파일은 컴퓨터든 휴대폰이든 브라우저만 있으면 열립니다. PDF와 비교하면 화면 크기에 맞춰 글줄이 다시 배치되고, 목차를 눌러 바로 이동할 수 있으며, 코드를 복사하기도 쉽습니다. 인쇄가 목적인 문서는 PDF가, 화면에서 읽고 코드를 따라 치는 문서는 HTML이 더 잘 맞습니다.
목차는 제목에서 만들어집니다
변환기는 문서의 제목을 읽어 목차를 만듭니다. 따라서 글자를 굵게 해서 제목처럼 보이게 쓴 줄은 목차에 나오지 않습니다. 샵 기호로 시작하는 진짜 제목을 써야 합니다.
# 문서 전체의 제목
제목 바로 아래의 짧은 문단은 소개문이 됩니다.
## 1. 첫 번째 장
### 1.1 세부 내용
## 2. 두 번째 장구조를 잡을 때는 다음을 기억하면 됩니다.
- #은 문서에 하나만 씁니다. 맨 앞의 # 제목이 문서의 큰 제목으로 올라갑니다. #이 여러 개면 파일 이름을 큰 제목으로 쓰고, # 제목들은 목차의 최상위 항목이 됩니다.
- 단계를 건너뛰지 않습니다. ## 다음에 바로 ####을 쓰면 목차의 들여쓰기가 어색해집니다.
- 제목은 짧게 씁니다. 목차 폭은 좁습니다. 한 줄 안팎이 읽기 좋습니다.
- 한 장이 너무 길면 나눕니다. 스크롤해도 목차의 표시가 한참 바뀌지 않으면 소제목을 넣을 때입니다.
제목 번호 쓰는 법
제목 앞에 1.이나 1.3처럼 숫자를 적으면 번호만 따로 강조합니다. 큰 제목의 번호는 본문에서 01처럼 두 자리로, 목차에서는 1.처럼 표시됩니다. 번호를 일일이 쓰기 어려우면 문서 설정의 자동 번호를 켜세요. 제목을 추가하거나 순서를 바꿔도 번호가 알아서 맞춰집니다. 이미 번호가 있는 문서에서는 번호가 두 번 붙지 않도록 자동 번호를 적용하지 않습니다.
목차 깊이 정하기
기본값은 소제목(###)까지입니다. 장이 많은 책 같은 문서는 큰 제목만 남겨야 목차가 한눈에 들어오고, 항목이 적은 짧은 문서는 그 아래 제목까지 보여도 괜찮습니다. 항목이 많아 목차가 화면을 넘어가면 목차만 따로 스크롤되고, 읽는 위치에 맞춰 함께 움직입니다.
손으로 쓴 목차는 지우지 않아도 됩니다
GitHub용으로 쓴 문서에는 맨 앞에 링크 목록으로 된 목차가 있는 경우가 많습니다. '목차'나 'Contents' 제목 바로 뒤에 문서 안 링크 목록이 있으면 왼쪽 목차와 겹치므로 자동으로 뺍니다. [TOC] 표시도 같습니다.
문서 안 링크
제목에는 GitHub과 같은 규칙으로 주소가 붙습니다. 소문자로 바꾸고 문장 부호를 없앤 뒤 띄어쓰기를 하이픈으로 바꿉니다. 그래서 [설치로 이동](#설치-방법)처럼 쓴 링크가 그대로 동작합니다. 같은 제목이 두 번 나오면 두 번째는 설치-방법-1이 됩니다.
보내기 전에 확인할 점
- 변환 화면의 확인할 점을 읽습니다. 찾지 못한 이미지와 읽지 못한 수식을 알려 줍니다.
- 받은 파일을 더블클릭해서 직접 엽니다. 미리보기와 같아야 합니다.
- 브라우저 창을 좁혀 휴대폰 화면을 확인합니다. 좁은 화면에서는 목차가 본문 위에 접힙니다.
- 메신저에 따라 HTML 첨부를 막거나 미리보기가 안 될 수 있습니다. 그럴 때는 압축해서 보내면 됩니다.