gitbook install and work

Welcome read !

How to install it?

1
2
3
$ npm install -g gitbook
$ npm install -g gitbook-cli

Test installed.

1
$ gitbook help

Often use shell.

1
2
3
4
5
6
7
$ gitbook init //init book dir
$ gitbook serve //start server and view --> http://localhost:4000
$ gitbook build: 会生成相应的 HTML 文件供分发。
$ gitbook pdf: 生成 PDF 文件
$ gitbook epub: 生成 epub 文件
$ gitbook mobi: 生成 mobi 文件

Gitbook init

首先,通过终端(PC 下可使用命令提示符)进入到你想要书写内容的目录,然后执行 gitbook init 命令,之后目录中会自动生成 README.md 和 SUMMARY.md 两个文件。这两个文件在 GitBook 项目中是必须存在的,其中 README.md 是对书籍的简单介绍,SUMMARY.md 是对书籍目录的描述,并且 GitBook 会通过该文件中的目录描述自动生成对应的目录和文件。

其中,SUMMARY.md 文件中内容的格式是这样的:

1
2
3
4
* [Chapter1](chapter1/README.md)
* [Section1.1](chapter1/section1.1.md)
* [Section1.2](chapter1/section1.2.md)
* [Chapter2](chapter2/README.md)

当你修改了 SUMMARY.md 文件中的内容后,你可以再次使用 gitbook init 来自动生成对应的目录和文件。

Multi-Languages

如果你要写的书籍是多语言版,你只需要创建一个 LANGS.md 文件,然后编写配置内容即可:

1
2
3
* [English](en/)
* [French](fr/)
* [Español](es/)

Gitbook serve

书籍目录结构创建完成以后,我们就可以使用 gitbook serve 来编译和预览书籍了:

gitbook serve 命令实际上会首先调用 gitbook build 编译书籍,完成以后会打开一个 web 服务器,监听在本地的 4000 端口。

Install plus

1
2
$ gitbook install disqus
$ gitbook install multipart

参考链接