GitBook使用小结

GitBook是什么

GitBook是一个基于Node.js的命令行工具，它可以把Markdown格式的文档转换成HTML、PDF、epub等其他便于发布或阅读的电子书格式。笔者接触gitbook也是因为使用其编写用户手册。

GitBook的安装

1. 安装nodejs

Windows系统:官网下载https://nodejs.org/

Linux系统：

#for redhat/centos
yum install nodejs npm

#for debian/ubuntu
apt-get install nodejs npm

2. 安装GitBook

##设置npm上网代理
npm config set proxy=http://[user]:[password]@[proxy_host]:[proxy_port]

##安装，一定要加上-g，全局安装
npm install gitbook-cli -g

GitBook使用

1. GitBook初始化

cd path
gitbook init

在目录下执行gitbook init会生成两个初始文档：

README.md：文档说明

SUMMARY.md：文档大纲，可以根据此文件进行目录管理

2. 编写内容

可以使用sublime进行文档编写，十分方便。

3. 文档预览与生成

本地查看：执行gitbook serve可以在本地访问http://localhost:4000进行文档预览。

PDF文档：

先安装ebook-convert工具和nodejs插件

npm install ebook-convert -g

生成pdf文件

gitbook pdf ./userguide mybook.pdf

GitBook的配置

可以在SUMMARY.md所在的目录下创建一个名为book.json的文件进行配置，比如可以去掉无用链接，关闭节点展开。

{
    "links": {
        "gitbook": false,

        "sharing": {
            "google": false,
            "facebook": false,
            "twitter": false,
            "weibo": false,
            "all": false
        }
    }
}