GitBook 的使用笔记

194 阅读2分钟

基本操作步骤

  1. 安装: npm install -g gitbook-cli
  2. 查看已安装 gitbook 的版本:gitbook -V
  3. 新建文件夹,然后 通过 gitbook init 初始化
  4. gitbook install 安装相关依赖
  5. gitbook serve 启动, 然后在浏览器地址栏中输入 http://localhost:4000 便可预览书籍。
  6. gitbook build

执行 gitbook 命令如: gitbook serve 时报错

错误如下:

D:\dataGitChangLiang\mone-test-doc>gitbook serve
Live reload server started on port: 35729
Press CTRL+C to quit ...

D:\tools\NVM\nvm\v14.18.1\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 D:\tools\NVM\nvm\v14.18.1\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js:287:18
    at FSReqCallback.oncomplete (fs.js:192:5)

【解决方案1】: 降低node版本,我讲版本降为 10.24.1,再重新安装gitbook,执行 gitbook install,在执行 gitbook serve 即可启动项目。

    8.11.0
    14.18.1
    12.22.7
  * 10.24.1 (Currently using 64-bit executable)

关于node版本的管理可参考:# nvm node的版本管理工具

【解决方案2】: 找到报错所说的polyfills.js文件,找到287行,发现是一个名为statFix的函数声明。使用查找命令找到该函数的调用地方,注释掉即可。

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

book.json的配置说明

变量描述
root包含所有图书文件的根文件夹的路径,除了 book.json
structure指定自述文件,摘要,词汇表等的路径
title您的书名,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
description您的书籍的描述,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
author作者名。在GitBook.com上,这个字段是预填的。
isbn国际标准书号 ISBN
language本书的语言类型,默认值是 en,
可选值:en, ar, bn, cs, de, en, es, fa, fi, fr, he, it, ja, ko, no, pl, pt, ro, ru, sv, uk, vi, zh-hans, zh-tw
direction文本阅读顺序。可以是 rtl (从右向左)或 ltr (从左向右),默认值依赖于 language 的值。
gitbook应该使用的GitBook版本,并接受类似于 >=3.0.0 的条件。
links在左侧导航栏添加链接信息
plugins要加载的插件列表
pluginsConfig插件的配置
styles自定义页面样式, 默认情况下各generator对应的css文件
"styles": { "website": "styles/website.css", }

gitbook 默认自带5个插件如下:

  1. highlight - 语法高亮插件
  2. search - 搜索插件
  3. sharing - 分享插件
  4. font-settings - 字体设置插件 5 livereload - 热加载插件

【注意】 去除默认插件,可以在插件名称前面加 -