之前看到看云制作文档就想着也找个类似这种的自己制作开发文档方便同事间配合,今天终于找到了,gitbook.
GitBook 是一款基于 Node.js 开发的开源的工具
除此之外,还可以利用 Git 命令管理电子书版本。如果你是 GitHub 的重度使用者,还可以把你的 GitBook 帐户和 GitHub 帐户关联起来,这样不论在任何一方修改了内容,都可以互相同步。
一、安装 Node.js
由于 GitBook 是基于 Node.js 开发的,所以依赖 Node.js 环境。如果您的系统中还未安装 Node.js,请点击下面的链接,根据你所使用的系统下载对应的版本。如果已安装则略过本步骤。
Node.js 下载页面:https://nodejs.org/en/download/stable/
Windows 版和 Mac 版的 Node.js 都是常规的安装包,连续下一步安装即可。Lunix 版可以参照官方文档通过 yum、apt-get 之类的工具安装,也可以通过源码包安装,如下所示:
$ wget https://nodejs.org/dist/v5.4.1/node-v5.4.1.tar.gz
$ tar zxvf node-v5.4.1.tar.gz
$ cd node-v5.4.1
$ ./configure
$ make$ make install
二、安装 GitBook
打开“命令提示符”(Mac 系统打开“终端”)输入以下命令安装 GitBook:
$ npm install gitbook-cli -g
由于网络的原因,安装的时间可能会较长一些,请耐心等待直到安装完成。安装完成后可以输入以下命令,以查看 GitBook 版本的方式检查是否安装成功:
$ gitbook -V
三、创建电子书项目
新建一个目录,并进入该目录使用 gitbook 命令初始化电子书项目。举个例子,现在要创建一个名为“MyFirstBook”的空白电子书项目,如下所示:
$ mkdir MyFirstBook
$ cd MyFirstBook
$ gitbook init
然后是编辑
电子书内容编写完毕后可以使用浏览器预览一下。先输入下面的命令据 .md 文件生成 HTML 文档:
$ gitbook build 创建的文件路径 要生成的路径
生成完毕后,会在电子书项目目录中出现一个名为“_book”的文件夹。进入该文件夹,直接用浏览器打开“index.html”,或先输入下面的命令:
$ gitbook serve