search

结构

GitBook 基本的目录结构如下所示

.
├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1/
|   ├── README.md
|   └── something.md
└── chapter-2/
    ├── README.md
    └── something.md

> README：一本书的介绍文字。 SUMMARY：定义章节的架构与顺序。 LANGS：多种翻译版本的设定。 GLOSSARY：词汇表与定义描述。 除了内容档案外，一本书至少需要添加 README 与 SUMMARY 这两个档案。

hashtag
book.json

book.json存放了书籍的配置信息，在下一章中所讲的配置信息都是在这个文件里定义的，关于该文件的配置可以看 配置arrow-up-right 这个章节。

hashtag
Summary

Summary.md文件定义书籍的目录架构，gitbook init命令会根据SUMMARY.md生成书籍各个章节的文件目录。

SUMMARY.md的格式是一个链接列表。链接的标题将作为章节的标题，链接的目标是该章节文件的路径。

hashtag
向父章节添加嵌套列表将创建子章节。

简单示例：

每章都有一个专用页面（part#/README.md），并分为子章节。

hashtag
锚点

目录中的章节可以使用锚点指向文件的特定部分。

hashtag
部分

目录可以分为以标题或水平线 ---- 分隔的部分：

Parts 只是章节组，没有专用页面，但根据主题，它将在导航中显示。

没有在 SUMMARY.md 文件里指定的档案，GitBook 在转制书籍时都不会使用，所以你可以自由撰写草稿、参考文件等。

hashtag
Glossary

词汇表文件，默认对应的文件是 GLOSSARY.md。该文件主要存储词汇信息，如果在其他页面中出现了该文件中的词汇，鼠标放到词汇上会给出词汇示意，可以将鼠标移到下面两个词汇上看下效果。

Git    Markdown

Glossary 文件的格式如下所示：

封面 无需废言，一个清晰漂亮的书籍封面是必要的。

在 GitBook 书籍专案根目录下摆一个 cover.jpg （大书封）以及一个 cover_small.jpg （小书封），只接受 JPEG 图片格式。

最佳尺寸 Big Small File cover.jpg cover_small.jpg Size(in pixels) 1800x2360 200x262 封面设计指引 一个在 GitBook 看起来很棒的书封通常遵循着下面的指引：

没有设定图片的边线（no border） 书名清晰可辨（书名小到看不见，是差劲的设计） 任何你觉得重要的文字，都应该在小尺寸时依旧能看得清楚 Autocover GitBook 有一个外挂（autocover）可以用来制作封面图档，或替你从大书封自动制作小书封，预设是有启动的，因此你可以只上传大书封就好。

autocover 的详细说明.

Previous命令Next页面

Last updated