创建如下目录结构:
tree book/
book/
├── README.md
└── SUMMARY.md
README.md 和 SUMMARY.md 是两个必须文件。
README.md
README.md是对书籍的简单介绍。
cat book/README.md
README
This is a book powered by [GitBook](https://github.com/GitbookIO/gitbook).
SUMMARY.md
SUMMARY.md 是书籍的目录结构。
SUMMARY.md文件中定义书籍的目录结构,格式为链接列表,链接的标题将被作为章节的标题,链接所指向的目标是该章节所对应的文件的路径;如果向父章节添加嵌套列表,则会创建子章节。
$ cat book/SUMMARY.md
# SUMMARY
* [Chapter1](chapter1/README.md)
* [Section1.1](chapter1/section1.1.md)
* [Section1.2](chapter1/section1.2.md)
* [Chapter2](chapter2/README.md)
章节可以使用标题或水平线进行分隔,如下:
$ cat book/SUMMARY.md
# SUMMARY
## 第一部分
* [Chapter1](chapter1/README.md)
* [Section1.1](chapter1/section1.1.md)
* [Section1.2](chapter1/section1.2.md)
## 第二部分
* [Chapter2](chapter2/README.md)
---
* [Chapter3](chapter3/README.md)
如果想要显示目录中章节的层级序号,需要在 book.json
中开启 showLevel
。