创建自己的gitbook

Posted 2021-09-08 Locutus

创建自己的gitbook

# mkdir mygitbook

# git init ./mygitbook

# cd mygitbook


# ls -a

.git

推送/更新gitbook的方法，与日常的代码管理一致。

文档的组织规则

• 如果要创建一个大的主题就在最顶层创建一个目录
• 全书五大主题，每个主题一个目录，其下不再设二级目录
• 所有的图片都放在最顶层的images目录下，原则上文章中用到的图片都保存在本地
• 所有的文档的文件名使用英文命名，可以包含数字和中划线
• etc、manifests目录专门用来保存配置文件和文档中用到的其他相关文件

添加文档

• 在该文章相关主题的目录下创建文档
• 在 SUMMARY.md 中在相应的章节下添加文章链接
• 执行gitbook serve测试是否报错，访问 http://localhost:4000，查看该文档是否出现在相应主题的目录下
• 提交PR

本地查看

• 将代码克隆到本地
• 安装 gitbook
• 执行gitbook serve
• 在浏览器中访问 http://localhost:4000
• 生成的浏览器文档在 _book 目录下

生成pdf

在Mac下安装calibre后，使用该命令创建链接：

# ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin

在该项目的根目录下，执行以下命令，生成kubernetes-handbook.pdf文档。

# cd /path/to/SUMMARY.md

// gitbook pdf /path/to/resource /path/to/file.pdf
# gitbook pdf . ./kubernetes-handbook.pdf --log=debug

配置封面

所有格式的电子书都可以配置自定义封面。在项目的根目录下提供 cover.jpg和cover_small.jpg两种封面图片时，生成的电子书会自动增加封面页。

封面的基本要求:

• cover.jpg尺寸大小: 1800X2360 px；cover_small.jpg尺寸大小: 200x262 px
• 无边界
• 清晰可见的书名
• 任何重要的文字在小版本封面图片中也要清晰可见

更多封面相关规范，请参考https://toolchain.gitbook.com/ebook.html