_config.yml의 chapterurl옵션을 docs/로 지정했을 경우를 기준으로 설명합니다.
목차 파일 수정하기
_data/toc.yml에 아래와 같이 YAML 형식으로 목차를 작성합니다.
1
2
3
4
5
6
7
8
9
- chapter: 제목 1|chapter-1
sub:
- 소제목 1-1|section-1
- 소제목 1-2|section-2
- chapter: 제목 2|chapter-2
sub:
- 소제목 2-1|section-1
- 소제목 2-2|section-2
YAML 양식은 들여쓰기가 중요합니다. 들여쓰기에 주의해주세요.
-문자로 개별항목임을 표시합니다. chapter와 sub는 테마가 변수명으로 사용합니다. 각 제목요소의 표시될 이름과 파일이름을 바(|)로 구분합니다. (표시할 이름)|(파일 이름)으로 표현합니다.
표시할 이름은 각 문서의 최상단에 자동으로 표시되므로 각 문서에 일일히 기입할 필요가 없습니다. 파일 이름은 해당 문서의 URL이기도 합니다. 영어만 사용할 수 있으며, 공백이 없어야 하고 특수문자는 하이픈(-)만 사용할 수 있습니다.
문서 파일 구성
목차 파일 수정을 완료한 뒤에는 디렉토리와 파일을 만든 목차에 맞춰 만듭니다. 예시는 앞서 만든 목차 파일을 기준으로 한 것입니다.
1
2
3
4
5
6
7
8
9
docs/
├── chapter-1/
│ ├ index.md (제목 1)
│ ├ section-1.md (제목 1-1)
│ └ section-2.md (제목 2-1)
└── chapter-2/
├ index.md (제목 2)
├ section-1.md (제목 2-1)
└ section-2.md (제목 2-2)
각 제목의 파일 이름이 디렉토리로 쓰입니다. 해당 제목을 클릭했을 때 보일 내용은 index.md에 작성합니다. 소제목을 클릭했을 때 보일 내용은 제목 아래 소제목의 파일 이름으로 파일을 만들어 내용을 작성합니다.