Gitbook小白教程 - 安装说明

2023-12-09 18:52:45

Gitbook小白教程 - 安装说明

参考 GIthub：Gitbook安装说明

本地环境要求

NodeJS (v4.0.0 and above is recommended)
- 安装网址：https://nodejs.org/en/
- 我安装的node是v17.0.1版本，npm是8.1.0，通过node -v或npm -v可查询版本
Windows, Linux, Unix, or Mac OS X

安装Gitbook

Node.js都会默认安装npm（node包管理工具），所以不需要单独安装npm，打开命令行：“Win + R”(运行) - “cmd”，执行以下命令安装GitBook:
$ npm install gitbook-cli -g

创建笔记本

如果想在指定文件路径下创建笔记本，可以先cd 指定路径，再执行以下命令：
$ gitbook init
或者，可以直接gitbook init ./directory

1. 报错 cb.apply is not a function

TypeError: cb.apply is not a function
    at /Users/.../AppData/Roaming/npm/node_modules/gitbook-cli/node_modules/npm/node_modules/graceful-fs/polyfills.js:287:20

网上搜索到两种解决方案，第一种方法看起来普适大部分人的情况，但是没有解决我的问题，在此均做个记录。
【方法一】
手动删除了C:\Users\yourname\AppData\Roaming\下的npm 和npm-cache（删除时关闭占用，如cmd），再执行npm clean cache —force。
但是我删除了两个文件之后，已经无法运行npm命令了，不知道我的操作哪里出现了问题，如果后续有什么发现我会再更新。

参考 Github issues:2874

【方法二】
./npm/node_modules/graceful-fs/polyfills.js 查看源码：

function statFix (orig) {
  if (!orig) return orig
  // Older versions of Node erroneously returned signed integers for
  // uid + gid.
  return function (target, cb) {
    return orig.call(fs, target, function (er, stats) {
      if (!stats) return cb.apply(this, arguments)
      if (stats.uid < 0) stats.uid += 0x100000000
      if (stats.gid < 0) stats.gid += 0x100000000
      if (cb) cb.apply(this, arguments)
    })
  }
}

根据代码中的注释，以及参考升级Node版本RN项目运行报错cb.apply is not a function。注释掉中间这三行代码（在60几行左右，因为版本不同，代码可能会有些许变动）后，再创建笔记就可以了。

  fs.chmodSync = chmodFixSync(fs.chmodSync)
  fs.fchmodSync = chmodFixSync(fs.fchmodSync)
  fs.lchmodSync = chmodFixSync(fs.lchmodSync)

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

  fs.statSync = statFixSync(fs.statSync)
  fs.fstatSync = statFixSync(fs.fstatSync)
  fs.lstatSync = statFixSync(fs.lstatSync)

2. 执行完后，提示信息：

“warn: no summary file in this book
info: create README.md
info: create SUMMARY.md”
虽然不知道为什么只有一个 README.md，但是感觉问题应该不大。后来在 Github:Directory Structure 上看到说明，SUMMARY.md 是可选项，所以自己创建一个 SUMMARY.md就可以啦。

File	Description
book.json	Stores configuration data (optional)
README.md	Preface / Introduction for your book (required)
SUMMARY.md	Table of Contents (See Pages) (optional)
GLOSSARY.md	Lexicon / List of terms to annotate (See Glossary) (optional)

初使用

我一直都是用Typora写markdown，这里就没有用gitbook editor了。
目录和内容都准备好之后，在命令行中运行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 2 pages
info: found 1 asset files
info: >> generation finished with success in 0.6s !

Starting server ...
Serving book on http://localhost:4000

在网页中打开 http://localhost:4000 就可以看到自己辛辛苦苦写好的笔记本啦~
其他的内容，等我再使用一段时间再来补充吧~

码农公寓