Gitbook配置
Gitbook 配置踩坑记
基于在线笔记平台****的现状,我们需要配置一套自己的笔记管理系统。
比较通用的一套方案即为:
- Typora,撰写md文档
- git,管理md文件
- gitbook,生成html文件
- github,上传并托管笔记文档
比较复杂的配置为gitbook,本文主要记录一些配置过程中的注意点。
1. 安装node
gitbook基于node.js开发,因此需要先安装node;
1.1 下载node安装包并双击安装
gitbook并不支持最新版本的node,建议安装node12,可以通过如下链接下载:
https://nodejs.org/dist/latest-v12.x/
下载对应系统编译好的文件即可。
特别注意: 如果安装最新版本的node,将会在下一步报错。
1.2 确认node安装完毕
终端中执行命令,得到正确结果即为安装完毕
dewei@MacBook ~ % node -v
// v12.22.12
dewei@MacBook ~ % npm -v
// 8.19.2
2. 安装gitbook
2.1 安装gitbook-cli
执行命令
npm install -g gitbook-cli
执行完毕后只是完成了gitbook安装的第一步。
2.2 继续安装gitbook
执行命令
gitbook -V
// V是大写
如果不出意外,应该会看到如下报错
if (cb) cb.apply(this, arguments)
^
TypeError: cb.apply is not a function
这是因为node版本更新带来的遗留问题,报错最后应当有一个错误所在的js文件路径,
比如我的电脑路径为/opt/homebrew/lib/node_modules/gitbook-cli/node_modules/npm/node_modules/graceful-fs/polyfills.js
在Finder中找到路径并打开,注释掉第62行开始的3行:
// fs.stat = statFix(fs.stat)
// fs.fstat = statFix(fs.fstat)
// fs.lstat = statFix(fs.lstat)
重新执行gitbook -V
命令
2.3 替换国内源
此时如果不出意外,看到的是 Installing GitBook 3.2.3 .......
不停转圈圈。
此时有两种方案:
- 等,前提是你的网络访问外网虽慢但通;
- 替换国内npm源,Control+C结束掉当前任务,并执行
npm config set registry=http://registry.npm.taobao.org -g
gitbook -V
然后继续等,因为还是很慢...
2.4 安装完成
等待若干时间后(约10分钟) ,进度条走完,重新执行查看版本号命令,能看到版本号即为完成。
dewei@MacBook ~ % gitbook -V
// CLI version: 2.3.2
// GitBook version: 3.2.3
3. just enjoy
现在你可以使用gitbook呈现你的markdown文档啦
gitbook init