GitBook介绍
GitBook可以看作个人的一本电子书。它用MarkDown编写,可以自动生成网页或者PDF等,生成网页可以通过插件配置目录和搜索功能等,可以直接部署到个人站点上,非常适合管理个人的知识库。
安装方法
1. 安装nodejs、npm
Linux主机首先安装npm。
sudo apt update
sudo apt install npm
2. 修改npm国内源
sudo npm config set registry https://registry.npm.taobao.org --global
sudo npm config set disturl https://npm.taobao.org/dist --global
3. 安装gitbook
sudo npm install -g gitbook-cli
4. 查看gitbook版本
# 执行这句话后还会继续安装,直到完成。
gitbook --version
使用方法
1. 初始化笔记本
# 在需要创建笔记本的路径下
gitbook init
2. 配置插件
cd到图书文件夹,编辑book.json文件。其中配置中plugins便是插件,如-lunr代表移除lunr插件,其他为增加。pluginsConfig是插件的配置。
{
"plugins": [
"-lunr", "-search","-livereload", "search-pro","-sharing",
"back-to-top-button","chapter-fold","lightbox",
"page-toc-button","hide-element","code","splitter",
"sharing-plus"
],
"pluginsConfig":{
"hide-element": {
"elements":[".gitbook-link"]
},
"sharing": {
"qq": true,
"qzone": true,
"weibo": true,
"all": [
"douban",
"facebook",
"google",
"pocket",
"instapaper",
"linkedin",
"twitter",
"weibo",
"messenger",
"qq",
"qzone",
"viber",
"whatsapp"
]
}
}
}
3. 下载插件
gitbook install
4. 配置笔记Gitee同步
在gitee新建一个项目,然后同步,可参考git使用教程。
5. 另外创建Gitee仓库上传笔记图片
5.1 创建仓库
5.2 生成令牌
进入gitee个人设置,安全设置 --> 私人令牌生成,注意:令牌只显示一次,务必保存好。
6. 配置PicGo同步笔记图片
6.1 下载PicGo
PicGo下载链接
6.2 安装github-plus插件
需要提前安装nodejs,插件设置 --> github-plus --> 安装,可以在软件中PicGo设置 --> 设置代理和镜像地址中设置npm镜像源为
https://registry.npm.taobao.org/,安装成功后,图传设置 --> githubPlus设置,填写仓库地址和gitee令牌。设置为默认图床并确认。仓库地址是用户名/仓库名,例如我的仓库地址是:percyc/mybook-pic。
7. 配置Typora通过PicGo上传图片
文件 --> 偏好设置 --> 图片,设置如下:
8. 编写笔记本目录
编辑笔记本目录下的SUMMARY.md文件,每次新增目录后都要执行以下命令自动创建相关文档文件。
gitbook init
9. 生成网页文件
gitbook build
10. 同步笔记到Gitee
cd到笔记本根目录,执行以下指令:
git add .
git commit -m "更新的内容"
git push
常见错误
错误1
Error: ENOENT: no such file or directory, stat...
解决方法:找到文件并编辑,
vim ~/.gitbook/versions/3.2.3/lib/output/website/copyPluginAssets.js
找到2个地方包含confirm: true,修改为false即可。