前言
GitBook是一个命令行工具,用于使用 Markdown 构建漂亮的博客网站、电子书籍,相比于 VuePress、docusaurus 等工具,它更简洁,用起来也更方便。
安装依赖
使用 gitbook , 需要先安装 Node.js ,且版本不能太高,否则后面安装过程会报错,这里推荐 10.24.1 版本
可使用 nvm 安装切换多个 Node.js 版本,可能有些nodejs版本过低,通过nvm也无法安装,这时可以通过链接 v10.24.1 找到对应的版本,下载预构建二进制包,放置到 ~/.nvm/versions/node/v10.24.1 目录下,然后通过nvm切换到 v10.24.1版本
安装 gitbook-cli
npm install gitbook-cli -g
安装 gitbook
gitbook -V
安装速度比较慢,不出意外就安装成功了,如果nodejs版本过高,可能出现报错,需降低node版本。
初始化项目
进入文档目录,执行如下命令初始化
gitbook init
会自动在目录中生成两个文件
- SUMMARY.md :所有文章的列表目录
- README.md :说明文件
本地预览
本地启动服务预览静态站点实时效果
gitbook serve
编译生成静态网页
执行下面的命令,将会在目录下生成一个_book文件夹,这就是生成的静态站点资源,可直接用于部署。
gitbook build
插件
gitbook有很多插件可以扩展文档的功能,可自行按需安装指定插件
npm install gitbook-plugin-xxx