GitBook使用心得
前言
最近想系统性的写些东西,但愁没有合适的编辑工具,直到认识了gitbook这个工具,使用gitbook工具写文档格式清晰且很容易对文档进行规范性编写,所以可以提高编辑效率。下面是我把在使用过程中的一些关键流程、使用方法和遇到的问题写下来供大家参考。
部署环境
1、安装Nodejs
这里采用nodejs二进制文件方式安装,不需要编译直接解压即可使用。
# 创建nodejs目录
mkdir -p /usl/local/nodejs && cd $
# 从官方网站下载二进制压缩包
wget https://nodejs.org/dist/v8.9.0/node-v8.9.0-linux-x64.tar.xz
# 解压部署
tar -xvf node-v8.9.0-linux-x64.tar.xz
# 配置环境变量
编辑/etc/profile文件在最后面加上这两句:
export NODE=/usl/local/nodejs/node-v8.9.0-linux-x64
export PATH=$PATH:$NODOE/bin
接着执行:source /etc/profile,是配置环境生效
# 查看版本信息
node -v
npm -v
如果上面nodejs安装成功的话,查看版本信息会有如下效果:
2、安装GitBook命令行工具
# 需要先安装gitbook然后安装gitbook-cli才能使用命令行
npm install gitbook -g
# 安装命令行工具
npm install gitbook-cli
# 查看gitbook版本,注意: V 是要大写的,小写不生效
gitbook -V
如果上面gitbook安装成功的话,查看版本信息会有如下效果:
3、安装Typora编辑器
# 官网下载&安装,下载下来的是exe文件,直接执行安装即可
https://www.typora.io/
####编写文档
1、认识Markdown语法
对于Markdown语法不熟悉的可以学习Markdown入门参考
2、启动gitbook文档服务
编写完文档后需要在浏览器上面看效果,所以需要启动一个文档服务。
# 开启端口,后面一个.表示的是当前文件夹,可以在文档根目录也可以另外指定目录
gitbook serve -p 8080 .
小结
到此,关于GitBook的一些使用方法已经写完。总体来说这个工具的使用还是比较简单的,只需要懂得命令行和markdown语法即可。前期部署环境工作相对麻烦一点,只要懂得markdown语法写出来的文档排版都会比较清晰&整齐,无需另外再纠结于文档的排版,可回归专注于写作内容。
参考
Centos之GitBook文档工具安装与使用-yellowcong