Gitbook 安装及使用

安装

nodejs依赖，所有假设你已经安装好了node及npm(推荐cnpm)
cnpm http://npm.taobao.org/

# npm install -g gitbook-cli 安装
➜  ~ cnpm install -g gitbook-cli
/usr/local/bin/gitbook -> /usr/local/lib/node_modules/gitbook-cli/bin/gitbook.js
/usr/local/lib
└── gitbook-cli@2.3.0

# 查看安装
➜  ~ gitbook -V
CLI version: 2.3.0
GitBook version: 3.2.2

使用

gitbook 的结构生成，依赖于 SUMMARY.md 文件。
README.md 为本书的简介，会在图书构建时，自动添加到 SUMMARY.md

# SUMMARY.md 示例
* [1](c1/README.md)
* [2](c2/README.md)
 * [2.1](c2/s1.md)
 * [2.2](c2/s2.md)

# README.md 示例
# gitbook demo

# 生成的目录结构
➜  ~ tree
.
├── README.md
├── SUMMARY.md
├── c1
│   └── README.md
└── c2
    ├── README.md
    ├── s1.md
    └── s2.md

2 directories, 6 files

起 serve

# 启动之后，即可在浏览器看到该文档结构
➜  ~ gitbook serve .
Live reload server started on port: 35729
Press CTRL+C to quit ...

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 4 asset files
info: >> generation finished with success in 0.8s !

Starting server ...
Serving book on http://localhost:4000

生成 pdf

➜  gitbook_demo gitbook pdf .
info: 7 plugins are installed
info: 6 explicitly listed
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 5 pages
info: found 0 asset files

InstallRequiredError: "ebook-convert" is not installed.
Install it from Calibre: https://calibre-ebook.com

下载安装即可

# 设置一下
➜  ~ ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin

生成 pdf

➜  gitbook_demo gitbook pdf .
info: 7 plugins are installed
info: 6 explicitly listed
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 5 pages
info: found 0 asset files
info: >> generation finished with success in 3.9s !
info: >> 1 file(s) generated

epub、mobi

# 类似的
➜  gitbook_demo gitbook epub .
➜  gitbook_demo gitbook mobi .

总结

~~~