GitBook

2015-05-29 | 更新: 2015-08-22

GitBook 是一个用起来非常简单的写书工具，界面简洁。用于整理主题内容也非常好用，因为目录会自动生成，也能很方便地转换成网页和电子书

项目主页：https://github.com/GitbookIO/gitbook
官方文档：https://www.gitbook.com/book/gitbookio/documentation/details

安装

首先安装 Node.js
```
brew install node
```
然后安装 Gitbook
```
npm install gitbook-cli -g
```
以后需要更新使用如下命令
```
npm update gitbook-cli -g
```
列出可用的版本
```
gitbook ls-remote
```
安装指定的版本
```
gitbook fetch 2.6.7
```

基本的使用

首先新建一个书籍目录，其中必须要有两个文件

README.md, 用于介绍书籍

SUMMARY.md, 定义了书籍的目录结构
例如：

# Summary

This is the summary of my book.

* [section 1](section1/README.md)
    * [example 1](section1/example1.md)
    * [example 2](section1/example2.md)
* [section 2](section2/README.md)
    * [example 1](section2/example1.md)

使用以下命令来创建书籍的目录和文件（通过 SUMMARY.md 文件的描述）
```
gitbook init
```
打开自动创建的文件进行写作，若需要预览可使用如下命令，我一般会指定端口
```
gitbook serve --port 4006
```
可能需要将书籍转换成静态网页，我一般指定输出目录
```
gitbook build book_path output_path
```

可能需要将书籍转换成 ebook 格式

gitbook pdf ./myrepo ./mybook.pdf
gitbook epub ./myrepo ./mybook.epub
gitbook mobi ./myrepo ./mybook.mobi

要使用以上命令，必须安装（除了 pdf 格式之外）Calibre 然后在 ~/.zshrc 中加入如下配置

export PATH=$PATH:/Applications/calibre.app/Contents/MacOS

插件

Google Analytics

让 GitBook 支持 Google Analytics, 可使用工具 plugin-ga

让 GitBook 支持 Disqus 评论

使用的工具是：plugin-disqus

安装方法一：

直接使用 npm 来安装插件，或者参数 -g 在全局安装
```
npm install gitbook-plugin-disqus
```

在书籍主目录新建 book.json 文件，写入如下内容：

{
    "plugins": ["disqus"],
    "pluginsConfig": {
        "disqus": {
            "shortName": "XXXXXXX"
        }
    }
}

安装方法二：

在 book.json 文件中写入如下内容，或者不加版本号

{
    "plugins": ["[email protected]"],
    "pluginsConfig": {
        "disqus": {
            "shortName": "mwum"
        }
    }
}

在书籍主目录下执行如下命令：
```
gitbook install
```

明无梦的软件使用记录

GitBook

安装

基本的使用

插件

Google Analytics

让 GitBook 支持 Disqus 评论