GitBook 入门

作者:刘专,日期:2018 年 01 月 02 日

GitBook 是一种文档格式,也是一条工具链。它利用 Git 和 Markdown,产生各种格式文档。另外,gitbook.com 还可以托管文档。

GitBook 生成的电子书籍版式美观,比如 Learn JavaScript。更多的例子参见列表

使用 GitBook.com 在线发布是最简单的方法,此处不表。本文主要讲述如何在本地搭建 GitBook 开发环境。

安装

使用 npm 全局安装,推荐使用 v4.0+ npm 。

npm install gitbook-cli -g

创建一本书

# 在当前目录创建新书
gitbook init
# 在新目录中创建新书
gitbook init ./directory

预览新书

gitbook serve

编译静态站点:

gitbook build

安装 beta 版本

gitbook fetch beta

# 列举远端可用的版本
gitbook ls-remote

调试

# 可使用 `--log=debug` 和 `--debug` 获得更详细的日志输出
gitbook build ./ --log=debug --debug

配置

配置可以使用 book.json。比如:

{
    "root": "./docs"
}

使用数学公式

为了在 GitBook 中使用数学公式,可以使用 KaTex 插件。首先在 book.json 添加如下:

{
    "plugins": ["katex"]
}

然后运行:gitbook install

嵌入方法包括行内公式和块级公式,如下:

Inline math: $$\int_{-\infty}^\intfy g(x) dx$$

Block math:

$$
\int_{-\infty}^\intfy g(x) dx
$$

REF