gitbook的使用

GitBook的安装使用

所需组件node.js

安装

安装node.js，查看版本

C:\Users\22958>npm ls -g
C:\Users\22958\AppData\Roaming\npm
`-- (empty)


C:\Users\22958>node -v
v14.16.0

C:\Users\22958>npm -v
6.14.11

全局安装gitbook组件

npm install gitbook -g

npm install gitbook-cli -g

npm install -g gitbook-summary

若出现这个问题

C:\Users\22958>npm install gitbook-cli -g
npm ERR! code EEXIST
npm ERR! path C:\Users\22958\AppData\Roaming\npm\node_modules\gitbook-cli\bin\gitbook.js
npm ERR! dest C:\Users\22958\AppData\Roaming\npm\gitbook
npm ERR! EEXIST: file already exists, cmd shim 'C:\Users\22958\AppData\Roaming\npm\node_modules\gitbook-cli\bin\gitbook.js' -> 'C:\Users\22958\AppData\Roaming\npm\gitbook'
npm ERR! File exists: C:\Users\22958\AppData\Roaming\npm\gitbook
npm ERR! Remove the existing file and try again, or run npm
npm ERR! with --force to overwrite files recklessly.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\22958\AppData\Roaming\npm-cache\_logs\2021-10-13T06_10_23_115Z-debug.log

使用–force覆盖

npm install gitbook -g

npm install gitbook-cli -g --force

npm install -g gitbook-summary --force

使用gitbook -V查看版本，并安装GitBook

样例

C:\Users\22958>gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

若出现这个问题

C:\Users\22958>gitbook -V
CLI version: 2.3.2
Installing GitBook 3.2.3
C:\Users\22958\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js:287
      if (cb) cb.apply(this, arguments)
                 ^

TypeError: cb.apply is not a function
    at C:\Users\22958\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js:287:18
    at FSReqCallback.oncomplete (fs.js:184:5)

修改polyfills.js中的代码

代码位置C:\Users\22958\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js

64-66行将其注释

// fs.stat = statFix(fs.stat)
// fs.fstat = statFix(fs.fstat)
// fs.lstat = statFix(fs.lstat)

使用

1. book sm 生成目录

2. gitbook init 到对应的工程进行初始化

3. gitbook build 构件

4. gitbook serve 发布，默认端口4000

   gitbook serve
   Live reload server started on port: 35729
   Press CTRL+C to quit ...
   
   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 3 pages
   info: found 3 asset files
   info: >> generation finished with success in 0.8s !
   
   Starting server ...
   Serving book on http://localhost:4000
   

成功样例：

成功样例：