基于 Gitbook 制作电子书
安装gitbook 命令行工具
1 | sudo npm install -g gitbook-cli |
安装完之后,你可以检验下是否安装成功。
1 | gitbook -V |
常用命令
gitbook help 可以查看所有指令:
1 | gitbook build #build a book |
编辑书籍
首先,进入一个目录,例如之前我们创建好的 gitbook,执行初始化命令
1 | gitbook init |
然后我们的 gitbook 空目录会多出两个文件:
1 | gitbook/ |
README.md 和 SUMMARY.md 是两个必须文件,README.md 是对书籍的简单介绍。SUMMARY.md 是书籍的目录结构。
1 | # Summary |
书籍目录结构创建完成以后,就可以使用 gitbook serve 来编译和预览书籍了:
1 | gitbook serve |
gitbook serve 命令实际上会首先调用 gitbook build 编译书籍,完成以后会打开一个 web 服务器,监听在本地的 4000 端口
导出电子书
安装Calibre
gitbook 可以直接生成电子书,比如pdf、mobi、epub格式的,但是需要额外的组件支持
1 | info: 7 plugins are installed |
到 https://calibre-ebook.com/download 网站下载calibre安装。
安装完成后,如果是mac电脑,需要将ebook-convert
链接到 /usr/local/bin
1 | sudo ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin |
导出电子书
1 |
|
最后就可以导入到电子书进行阅读了~~
高级特性
GitBook 配置
GitBook 允许您使用灵活的配置自定义您的电子书。
这些选项在
book.json
文件中指定。对于不熟悉 JSON 语法的作者,您可以使用 JSONlint 等工具验证语法。
变量 | 描述 |
---|---|
root |
包含所有图书文件的根文件夹的路径,除了 book.json |
structure |
指定自述文件,摘要,词汇表等的路径,参考 Structure paragraph. |
title |
您的书名,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。 |
description |
您的书籍的描述,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。 |
author |
作者名。在GitBook.com上,这个字段是预填的。 |
isbn |
国际标准书号 ISBN |
language |
本书的语言类型 —— ISO code 。默认值是 en |
direction |
文本阅读顺序。可以是 rtl (从右向左)或 ltr (从左向右),默认值依赖于 language 的值。 |
gitbook |
应该使用的GitBook版本。使用 SemVer 规范,并接受类似于 “> = 3.0.0” 的条件。 |
plugins |
要加载的插件列表。默认带有 5 个插件:highlight,search,sharing,font-settings,livereload |
封面
封面用于所有电子书格式。您可以自己提供一个,也可以使用 autocover plugin 生成一个。
要提供封面,请将 cover.jpg
文件放在书本的根目录下。添加一个 cover_small.jpg
将指定一个较小版本的封面。封面应为 JPEG
文件。
好的封面应该遵守以下准则:
cover.jpg
的尺寸为 1800x2360 像素,cover_small.jpg
为 200x262- 没有边界
- 清晰可见的书名
- 任何重要的文字应该在小版本中可见
更多配置见参考
GitBook.com 是使用 GitBook 格式创建和托管图书的在线平台。它提供托管,协作功能和易于使用的编辑器。
如果你不希望使用 Gitbook 的仓库,而是想直接使用 Github 的仓库,也是可以的。
首先,你需要绑定你的 Github 账号。最简单的方式当然就是登录 Gitbook.com 时使用 Github 账号登录方式了。否则,你也可以在 Account Settings 中的 Github 设置选项中去进行绑定。
托管到GitHub pages