gitbook教程


难度 中等

下载gitbook

npm install gitbook-cli -g

初始化项目

gitbook init

初始化时报错,

E:\node_globalnode_modulesgitbook-clinode_modulesnpmnode_modulesgraceful-fspolyfills.js:287
      if (cb) cb.apply(this, arguments)
                 ^

TypeError: cb.apply is not a function
    at E:\node_globalnode_modulesgitbook-clinode_modulesnpmnode_modulesgraceful-fspolyfills.js:287:18
    at FSReqCallback.oncomplete (node:fs:199:5)

解决方案为:

cd node_global/node_modules/gitbook-cli/node_modules/npm/node_modules/
npm install graceful-fs@latest --save

即将graceful-fs更新到最新。请参考Stack Overflow.

修改后gitbook init 无任何报错,但未生成README.md和SUMMARY.md,手动生成也无法构建。

解决方案为:

npm install gitbook-cli@2.1.2 --global

此时在执行gitbook init,发现只生成了README.md,手动创建SUMMARY.md。

构建

gitbook serve
gitbook build

结合github 部署gitbook

创建另一个page分支,用于发布构建的gitbook。

PS F:\codedb021> git branch
* master
  page

然后构建gitbook,

growd@DESKTOP-0ED5P84 MINGW64 /f/code/db021 (master)
$ gitbook build
info: 7 plugins are installed
info: 6 explicitly listed
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 9 pages
info: found 29 asset files
info: >> generation finished with success in 2.4s !

growd@DESKTOP-0ED5P84 MINGW64 /f/code/db021 (master)
$ ls
_book/  img/      part2.md  part4.md  part6.md  part8.md   SUMMARY.md
code/   part1.md  part3.md  part5.md  part7.md  README.md

构建成功后可以看到目录下多了一个_book目录,将这个目录重命名为docs然后提交到github上(github只能识别/docs或者/),然后开启page功能,选定分支为page。

growd@DESKTOP-0ED5P84 MINGW64 /f/code/db021 (master)
$ mv _book/ docs
$ git checkout page
Switched to branch 'page'
$ git add docs
$ git commit -m "update docs"
$ git push origin master

文章作者: growdu
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 growdu !
  目录
分类导航
随笔3 AI29 计算机基础13 算法1 博客搭建7 ChatGPT2 集群63 计算机通信1 数据库59 数据库深入93 数据库93 Docker11 DPDK26 编辑工具4 Elasticsearch4 FAQ1 Go Web1 hometown2 编程语言16 人生11 网络9 Linux38 OPC1 openGauss4 页面12 PostgreSQL54 程序员自我修养1 协议11 stock1 存储5 成长之路1 工具20 视频作品1 VPP18 Vue13 Web1 代码示例11 BenchmarkSQL1 PostgreSQL 源码修炼之路14
最热文章
1
PostgreSQL 逻辑复制全链路:以一个真实事务为例,从 `INSERT` 到 `apply` 的源码级旅程
数据库🔥 2162
2
PostgreSQL 逻辑复制 Stream 执行逻辑源码级拆解:从 reorderbuffer 触发到订阅端落盘回放
数据库🔥 1765
3
PostgreSQL 行锁机制源码级深度拆解:4 种锁模式 + xmax + MultiXact 的完整链路
数据库🔥 1656
4
PostgreSQL reorderbuffer.c 函数级源码全集:5615 行 / 95 个函数的逐函数解析
数据库深入🔥 1650
5
PostgreSQL 目录快照源码级深度拆解:系统表读取的 MVCC 真相与失效机制
数据库🔥 1604
6
13 逻辑复制深入
数据库深入🔥 1570
7
0 Postgresql存储、索引及系统优化、主备切换
PostgreSQL🔥 1495
8
PostgreSQL 读一行数据源码级深度拆解:MVCC 在每个环节的落点
数据库🔥 1464
9
PostgreSQL WAL 记录类型完全指南:21 个 RMGR × 80+ 种记录的源码级拆解
数据库🔥 1431
10
一文读懂openguass dcf网络模块
集群🔥 1420
11
PostgreSQL 元数据存储机制:从磁盘文件到内存缓存,`pg_class` 撑起的整个系统表体系
数据库🔥 1411
12
openGauss 并行解码设计原理深度拆解:reader + 多 worker + CSN 三层架构的源码级剖析
数据库深入🔥 1344
13
逻辑复制源码分析
数据库深入🔥 1327
14
PostgreSQL 逻辑复制:catalog 改动、可见性判定与 xmin/xmax 推进全景
数据库深入🔥 1317
15
自托管服务全家桶:从原文方案到可复制实操手册
人生🔥 1278
16
PostgreSQL CREATE_REPLICATION_SLOT 端到端源码分析:从 SQL 到 snapbuild 状态机的完整链路(每个函数每个参数)
数据库深入🔥 1277
17
PostgreSQL syscache 模块源码深度拆解:CatCache 数据结构、LRU 哈希表、cache invalidation 全链路
数据库深入🔥 1216
18
PostgreSQL 18 内核数据结构全景:RangeVar 与 20+ 个核心数据结构源码级拆解
数据库🔥 1158
19
PostgreSQL 逻辑复制里 `RUNNING_XACTS` 写入机制与快照 `xmin / xmax / xip` 的演化:源码级深度拆解
数据库🔥 1119
20
PostgreSQL 分区表:从一行 `PARTITION BY` 到路由热路径的全链路拆解
数据库🔥 1094