[开发工具]GitBook安装与使用

GitBook安装与使用

环境准备

1. 安装Node.js

在 https://nodejs.org/ 中下载相应版本，建议版本不要过高，否则后面会很麻烦，会报错。

我这里使用的是node-v12.0.0版本

[root@Server-a41b9a18-0813-4425-a676-344348114a6f ~]# ls | grep node
node-v12.0.0-linux-x64.tar.gz

解压并软连接到/usr/local/bin目录下

tar -xf node-v12.0.0-linux-x64.tar.gz
mv node-v12.0.0-linux-x64 /usr/local/nodejs
ln -s /usr/local/nodejs/bin/node /usr/local/bin/node
ln -s /usr/local/nodejs/bin/npm /usr/local/bin/npm
node -v  # 查看版本

2.安装gitbook-cli

npm install gitbook-cli -g
 ln -s /usr/local/nodejs/bin/gitbook /usr/local/bin/gitbook  

到这里所有的准备工作就完成了。

基本使用

目前我只遇到以下两种场景：

场景1：如果有项目源码，可以先试用git命令将代码pull下来

yum install git -y   #  如果已经下载了git，可忽略该步骤。
git clone [url]
cd 到项目中编写gitbook的目录下
gitbook init     #  初始化  
gitbook server   #  运行

通过运行后的地址进行访问，就可以看到文档内容。

场景2：自己创建gitbook

创建目录并进入该目录中

git init    #  初始化

初始化后gitbook会自动创建文件SUMMARY.md、README.md，分别表示书籍的目录结构和介绍
编辑好这两个文件之后执行

gitbook init
gitbook serve  # 编译运行