使用 Gitbook Cli (honkit) 生成 PDF

我们希望有一种在线文档可以方便地导出 PDF 文档，并且导出的 PDF 排版最好与在线文档一致。最终我们选择了已经多年未更新的 Gitbook Cli （的替代品: honkit）。

起因

Gitbook 导出 PDF 的文章很多，按照各种教程尝试发现遍地是坑：首先，使用 大于 v10 的 NodeJS 版本 安装依赖会出现各种错误情况，毕竟 Gitbook Cli 最后一版更新已是 2018 年；其次，依赖安装完成后运行起来又会发现各种问题：编辑文档无法热更新、导出 PDF 各种报错。

等各种坑踩完了才知道有 HonKit 这个项目。

HonKit is building beautiful books using Markdown - Fork of GitBook

Gitbook 替代品

不知道为什么介绍 HonKit 的文章很少。按照文档可以轻松地使用 v16 版本的 NodeJS 构建、预览在线文档。如果之前用的 Gitbook 也可以无缝迁移。HonKit 自带导出 PDF 的功能

$ honkit pdf ./ ./mybook.pdf

但是，即使解决各种依赖问题生成了 PDF，效果还是不尽人意。

导出 PDF

最终推荐的方式是使用 Docker 配合 HonKit 在线文档生成 PDF：soulteary/docker-gitbook-pdf-generator。

可能上面提到这个项目导出的 PDF 会存在图片不显示的问题，又有人进行了优化：robertzhangwenjie/gitbook2pdf

现在可以比较完美地导出 Gitbook PDF 了

docker run --rm -it \
    -v `pwd`/fonts:/usr/share/fonts \
    -v `pwd`/output:/app/output \
    zhangwenjie/gitbook2pdf "http://host.docker.internal:4000" output.pdf

如果自定义程度比较高，推荐使用 robertzhangwenjie/gitbook2pdf 项目的 Python 运行方式。