一篇文章搞定gitbook

gitbook的使用

使用gitbook之前先推荐一款Markdown编辑工具:Typora

一、gitbook安装

npm install -g gitbook-cli

二、gitbook的基本使用

  • 新建并切换到项目文件夹
  • 执行gitbook init,然后会生成两个文件README.mdSUMMARY.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 &copy 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)

未完待续。。。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值