gitbook的使用
使用gitbook之前先推荐一款Markdown编辑工具:Typora
一、gitbook安装
npm install -g gitbook-cli
二、gitbook的基本使用
- 新建并切换到项目文件夹
- 执行
gitbook init
,然后会生成两个文件README.md
和SUMMARY.md
README.md
是整个gitbook的首页,类似于封面;SUMMARY.md
是gitbook目录结构- 主要编写
SUMMARY.md
就可以了,然后生成对应的文件
- - 编辑完目录结构之后重新执行
gitbook init
,会在项目文件夹中自动生成对应的目录和.md
文件 - 然后往对应的
.md
文件里添加内容就可以了 - 最后执行
gitbook serve
可以预览初步完成的gitbook - 当你写得差不多,你可以执行
gitbook build
命令构建书籍,默认将生成的静态网站输出到_book
目录。实际上,gitbook serve
也会生成_book
三、gitbook转pdf
使用gitbook的导出功能,需要第三方插件ebook
的支持
Liunx系统
ps :下载过程有点慢,不知道开VPN有没有用,没试过
sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.sh | sudo sh /dev/stdin
安装完成之后,在SUMMARY.md
文件的同级目录执行gitbook pdf .
命令导出PDF文件
四、gitbook相关插件
直接在book.json中配置即可
- 导航目录折叠
chapter-fold
"plugins": [
"chapter-fold"
]
- 回到顶部按钮
back-to-top-button
"plugins":[
"back-to-top-button"
]
- 给代码块添加行号与复制按钮
code
"plugins": [
"code"
]
- 点击图片进行查看
lightbox
"plugins": [
"lightbox"
]
- 给页面添加页脚
tbfed-pagefooter
"plugins": [
"tbfed-pagefooter"
]
"pluginsConfig": {
"tbfed-pagefooter": {
"copyright": "Copyright © MoCha",
"modify_label": "该文件修订时间:",
"modify_format": "YYYY-MM-DD"
}
}
五、装gitbook遇到的问题
cb.apply is not a function
user@ % gitbook init
Installing GitBook 3.2.3
...
/opt/homebrew/lib/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 /opt/homebrew/lib/node_modules/gitbook-cli/node_modules/npm/node_modules/graceful-fs/polyfills.js:287:18
解决方法:
打开报错的这个文件,注意目录和我的可能不一样,是你报错的目录
/opt/homebrew/lib/node_modules/gitbook-cli/node_modules/npm/node_modules/graceful-fs/polyfills.js
然后注释掉这三行
fs.stat = statFix(fs.stat)
fs.fstat = statFix(fs.fstat)
fs.lstat = statFix(fs.lstat)
未完待续。。。