MyBook

背景

忍受够了Gitbook动辄半小时的打包时间 VuePress无法满足要求且有许多限制

理念:

愿景:

功能

使用

1.克隆仓库

git clone --depth 1 https://github.com/0xcaffebabe/note.git # 无历史克隆

2.清空doc目录,并在这里新增或者移入你的GitBook文档

3.安装依赖

npm run install

4.启动测试

npm run dev

5.初始化仓库并推送到你自己的仓库

注意事项

全文检索

该功能需要你 http://aloglia.com/ 申请应用,并创建一个名称为note的索引库(也可以直接在src/scripts/updateSearchIndex.ts中修改成你喜欢的索引名称)

分别将设置环境变量ALGOLIA_APPID、ALGOLIA_SECRET

然后

npm run update-index

知识网络生成功能

该功能会自动将markdown文件里对本项目内其他的markdown文件链接自动绘制成一个网络图,在使用本功能时需要注意md链接要使用绝对路径如 xxx/xxx.html 或者 /xxx/xx.html

自动部署