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 !
  目录
分类导航
随笔2 AI27 算法1 计算机基础13 博客搭建7 ChatGPT2 集群63 计算机通信1 数据库34 数据库深入80 DPDK26 Docker11 Elasticsearch4 编辑工具4 FAQ1 Go Web1 hometown2 编程语言16 网络9 OPC1 Linux38 openGauss4 页面12 PostgreSQL54 程序员自我修养1 协议11 成长之路1 stock1 存储5 工具20 VPP18 视频作品1 Vue13 Web1 代码示例11 数据库15 BenchmarkSQL1 PostgreSQL 源码修炼之路14
最热文章
1
13 逻辑复制深入
数据库深入🔥 1570
2
0 Postgresql存储、索引及系统优化、主备切换
PostgreSQL🔥 1495
3
一文读懂openguass dcf网络模块
集群🔥 1420
4
逻辑复制源码分析
数据库深入🔥 1327
5
PostgreSQL 分区表:从一行 `PARTITION BY` 到路由热路径的全链路拆解
数据库🔥 1094
6
applyparallelworker.c 之 LA 端源码深度解析:Leader Apply Worker 的指挥中枢
数据库深入🔥 1082
7
PostgreSQL Background Worker 全解:从 `RegisterBackgroundWorker` 到逻辑复制 4 类 worker 的全生命周期
数据库🔥 1078
8
PostgreSQL的后台进程walsender分析 - 关系型数据库 - 亿速云
PostgreSQL🔥 1033
9
PostgreSQL 逻辑复制的监控:六张视图 + 一组可执行 SQL,把 publisher/subscriber 的速率与健康度彻底看透
数据库🔥 1032
10
PostgreSQL 逻辑复制支持 DDL 之后:DDL 与 DML 的时序难题(重点:分区表)
数据库🔥 999
11
reorderbuffer.c 源码深度解析:PostgreSQL 逻辑复制的"事务重组引擎
数据库深入🔥 953
12
PostgreSQL 内核开发:读取一张表的 9 步标准流程与缓存全景
数据库🔥 938
13
从 `postgres` 二进制到生产级守护 —— PostgreSQL 最外层模块与启动全流程拆解
数据库🔥 936
14
支持逻辑复制同步 DDL 适配 SQL Server 方案
数据库深入🔥 934
15
PostgreSQL 逻辑复制的 ReorderBuffer 与事务机制:从一行 WAL 到一致性变更流的全链路绑定
数据库🔥 913
16
DDL同步架构(美化版)
数据库深入🔥 908
17
PostgreSQL Latch 机制详解:从一行 SetLatch 到 epoll 的内核之旅
数据库🔥 871
18
pgbench 源码全解:一个 C 文件如何撑起 PostgreSQL 官方压测工具
数据库🔥 860
19
PostgreSQL libpq 机制与缓冲区详解
数据库🔥 850
20
PostgreSQL 逻辑复制 spill 文件深度剖析:从 `xid-*.spill` 到 TPC-C 的增长方程
数据库🔥 845