由于GitBook 是一个基于 Node.js 的命令行工具,因此在安装gitbook之前必须安装node.js。
1、安装node.js
安装后执行node -v命令,显示类似“v8.12.0”内容,即安装成功。
2、安装gitbook
安装node.js后,就可以使用npm命令安装gitbook了,按一下顺序执行命令。
npm install gitbook -g
npm install gitbook-cli -g
安装成功后,执行
gitbook -V
显示内容如下:
CLI version: 2.3.2
Installing GitBook 3.2.3
说明已经安装成功。
3、下载安装gitbook编辑器
下载网址:https://legacy.gitbook.com/editor
下载安装包后安装即可。
4、gitbook init
从cmd命令窗口进入你的目录,执行
gitbook init
执行后,会在你的目录中创建两个文件,README.md和SUMMARY.md。
SUMMARY.md:gitbook的目录
5、gitbook serve
gitbook serve
//生成静态网页并运行服务器
执行后内容如下:
info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 1.0s !
Starting server ...
Serving book on http://localhost:4000
用浏览器打开http://localhost:4000,如下
6、gitbook build
运行该命令后会在文件夹中生成一个 _book 文件夹, 里面的内容即为生成的 html 文件,可以使用下面命令来生成网页而不开启服务器。