Skip to content

Latest commit

 

History

History
149 lines (97 loc) · 6.51 KB

README.md

File metadata and controls

149 lines (97 loc) · 6.51 KB
Raw

语雀知识库批量导出和再处理工具(非TOKEN方式,非官方)

🎉可执行程序版(无需Node环境，下载即用)

样例

example.gif

支持

  • 个人知识库
  • 空间(团队)知识库
  • 协作知识库
  • 小记

自 2.1.0 版本开始，交互式列表中 👤 前缀表示个人知识库，其它则为 👥

了解实现过程-与其它工具有什么不一样

使用方式

整体步骤

pull -> 登录 -> 交互式选择知识库(命令行参数完整不会进入交互式环节) -> 等待下载完成

目前登录完成后会设置一天的帐号信息缓存，即24小时之内重复导出只有第一次需要登录。

安装

npm i yuque-tools -g 安装到全局
npm i yuque-tools 安装到局部
安装到全局以下方法使用ytool xx，安装到局部以下方法使用npx ytool xx

导出

创建目录yuque-docs并进入目录(目录名称随意)

ytool pull

初级用法(只用一次，用完即走推荐⬇️)

如果仅需导出个人知识库，可以任何参数都不传，pull之后所有所需信息均会进入交互式环节，按照步骤完成操作即可。

中级用法

参数说明
参数 说明 必填
userName password 语雀账号和密码 是/交互
tocRange 例如: test-book/测试目录 test-book2，多个知识库之间空格隔开 是/交互
all 导出所有知识库，与tocRange互斥 是/交互
skip/skipDoc 导出时是否跳过本地同名文件 否/交互
lb/linebreak 导出时是否保留语雀换行标签，即<br/>标签 否/交互
note/onlyNote 导出小记 否
host 空间域名，例如: https://xxx.yuque.com，后面不要有斜杠(/) 否
output 导出目录，例如: ./mydocs，默认为docs 否
lc/latexcode 导出Latex语法 否/交互
isUpdate 导出时是否依据文档更新选择跳过 否
time 文档是否在此时间之后更新，如：任意类型时间，最终会被new Date(time).getTime()加工 否

注意:

  • 命令行认为前两个参数为帐号和密码；
  • 对于skip、lb、 lc和note，为了命令行使用便捷，采用skip表示，而为了含义明确，在配置中采用skipDoc表示，其它两个参数同理；
  • 为降低命令行使用时的复杂度，host、onlyNote和output仅支持配置形式使用且不会进入问询环节，具体配置方式见以下高级用法⬇️;
  • 由于小记与知识库归属不同，当使用note(或配置中onlyNote为true)时，将只会进入导出小记的环节，知识库的配置将会忽略；
  • isUpdate与time仅建议采用配置方式使用见👉，且两字段需同时存在，用于导出时依据文档是否更新选择覆盖本地文档，感谢hanlin-yuan提供此应用场景支持。
应用示例

以 我的测试知识库 为例，采用一行命令可以直接导出的命令形式有如下用法：

参数生效的前提是userName和password同时存在，且在所有参数最前面，其它参数顺序均无具体要求

ytool pull 18989XXX xxxx all 表示导出所有知识库，不跳过本地同名文件，不保持语雀换行标签

ytool pull 18989XXX xxxx test-book 表示导出test-book知识库，不跳过本地同名文件，不保持语雀换行标签

ytool pull 18989XXX xxxx test-book skip 表示导出test-book知识库，跳过本地同名文件

ytool pull 18989XXX xxxx test-book/测试目录 skip 表示导出test-book知识库下测试目录下的文档，跳过本地同名文件

ytool pull 18989XXX xxxx test-book other-book skip 表示导出test-book和other-book两个知识库，跳过本地同名文件

ytool pull 18989XXX xxxx all skip lb 表示导出所有知识库，跳过本地同名文件，保持语雀换行标签

ytool pull 18989XXX xxxx note 表示只导出小记

高级用法

导出参数支持配置化形式，适合长期使用，采用yuque-docs/yuque.config.json进行配置，具体含义见上述[参数说明]

以下配置模版可通过ytool init直接生成(仅支持2.0版本及以上)

{
  "userName": "XXX",
  "password": "XXX",
  "tocRange": ["xxx知识库", "yyy知识库/zzz目录"], 
  "skipDoc": false, 
  "linebreak": false,
  "host": "",
  "output": "./docs",
  "onlyNote": false,
  "latexcode": false,
  "isUpdate": false,
  "time": ""
}

清除缓存

工具可能存在因yuque接口的不稳定性产生的无法规避的错误(概率较低)，从而导致导出操作失败/异常，此时可以clear之后再重试导出操作。

ytool clear

更新工具

考虑后期此工具(外挂)还会支持更多工具，从2.0版本开始支持便捷的升级操作，采用如下命令即可完成工具升级。

ytool upgrade

最佳实践

此工具开发的初心是将其作为一个将语雀知识库与其它平台数据共享的介质，因此也具备很多实践的可能性， 通过语雀作为文字的载体，你可以通过yuque-tools实现以下几种可能性：

  1. 你有自己的个人博客，通过定制脚本将语雀知识库的内容同步至自己的服务器；
  2. 你在多个社区有自己的内容创作，通过定制脚本将语雀知识库的内容同步至内容平台；
  3. 你有更灵活的私域/公域的文字记录，通过yuque-tools灵活的导出能力，将内容分发至不同的平台；
  4. ...

目前具体实践已应用至我个人的 knowledge-garden 中，感兴趣的朋友可以了解其具体实现。

推荐

在跨平台文档同步/博客方案方面elog有着更强大的能力，有需要的朋友可以了解一下此项目

image

Issues

反馈意见 | 更新记录及计划