Gitbook 初上手体验

Gitbook

使用Git和Markdown的现代书籍格式和工具链

Modern book format and toolchain using Git and Markdown

这是官方介绍和机翻译文

安装

1
2
3
$ npm install -g gitbook-cli
# 或者 (如果安装了cnpm)
$ cnpm install -g gitbook-cli

然后输入gitbook验证安装, 如果安装成功但找不到命令。 需要手动软连接一下。

1
$ sudo ln -s {nodejs目录}/bin/gitbook /usr/local/bin/gitbook

编辑器

  • Typora
  • VSCode

我个人推荐这两种md编辑器,后者是代码编辑器,附带markdown编辑功能

使用

1
2
3
4
$ mkdir mybook
$ cd !$
# 初始化书籍
$ gitbook init

执行完你可以看见两个文件,分别是

其中 SUMMARY.md格式如下

1
2
3
4
5
6
7
8
9
# 目录

* [前言](README.md)
* [增删改查](doc/README.md)
* [](doc/insert.md)
* [](doc/delete.md)
* [](doc/update.md)
* [](doc/select.md)
* [缓存](doc/cache.md)

保存后,再执行gitbook init构建目录结构。

多次gitbook init 不会覆盖已存在文件, 放心使用

其他命令

1
2
3
4
5
6
7
8
# 预览书籍, 可以指定端口
$ gitbook serve [--port 8080]

# 构建,生成HTML文件
$ gitbook build [书籍路径] [输出路径]

# 生成PDF格式
$ gitbook pdf [书籍路径] [PDF文件保存路径]

更多

  • 配合git多人合作编辑
  • 使用git pages 托管书籍静态网页

更多用法请访问 GITBOOK官方文档