Gitbook使用

格式

GitBook约定了下面这些文件的作用：

README：书本的介绍

SUMMARY：章节结构

LANGS：多语言书籍

GLOSSARY：术语描述的清单

至少需要一个 README 和 SUMMARY 文件来构建一本书。

章节和子章节

GitBook使用文件 SUMMARY.md 来定义书本的章节和子章节的结构。文件 SUMMARY.md 被用来生成书本内容的预览表。

SUMMARY.md 的格式是一个简单的链接列表，链接的名字是章节的名字，链接的指向是章节文件的路径。

子章节被简单的定义为一个内嵌于父章节的列表。

书写语法

Gitbook默认使用Markdown语法。

封面

为了让我们的书本再Gitbook上现实的更加好看，我们可以指定一个封面。

封面由cover.jpg文件指定，cover_small.jpg同样可以作为小版本封面存在。封面应该是JPEG格式文件。

一个好的封面

一个好的封面应该满足下面的条件：

没有边框

清晰可见的书本标题

任何重要的文字再小版本中应该可见

术语表

允许你指定术语并且在术语表中显示它们各自的定义。基于这些术语，GitBook会自动建立索引并高亮这些在文中的术语。

GLOSSORY.md 的格式非常简单：

# 术语

这个术语的定义

​

# 另外一个术语

它的定义可以包含粗体和其他所有类型的内嵌式标记...

忽略文件和文件夹

GitBook会读取 .gitignore，.bookignore，.ignore 文件来获取忽略的文件和目录的列表。

参考资料

Gitbook文档:http://caibaojian.com/gitbook/