atian25 / yuque-exporter

export yuque to local markdown
MIT License
321 stars 36 forks source link

yuque-exporter

用于批量导出语雀文档。

为什么?

语雀的定位改变为创作工具,而不在是内容社区,相应的新的付费策略,也会造成了免费用户无法继续用语雀作为自己的个人博客。(相关讨论传送门

因此我们需要有一个把创作完的文档发布到其他平台的工具,故抽空写了该项目,可以方便的把语雀的内容批量导出为本地 Markdown,从而可以进一步发布到 GitHub 等平台。

本项目开发过程中,也收到了语雀同学的不少指导和建议。

如何使用

需提前申请语雀 TOKEN,请参考文档

$ npx yuque-exporter --token=<your token>

更详细的命令行说明参见:Help

技术内幕

调用语雀 API -> 存储所有元数据 -> 根据 TOC 构建本地目录 -> 文件内容处理(下载图片、替换链接等)

https://www.yuque.com/yuque/developer/api

$ npm i

$ YUQUE_TOKEN=<your token> npm start

$ ls output

TODO List