语雀知识库下载工具yuque-dl
语雀知识库下载工具yuque-dl
- 前言
- 一、主要特点
- 二、安装前置
- 三、安装 yuque-dl
- 四、使用 yuque-dl 下载 公开文章
- 五、使用 yuque-dl 下载 私有文章
- 六、本地预览
- 最后
前言
yuque-dl 是一个将语雀知识库下载为本地 Markdown 文件的 Node.js 工具,支持保留目录结构、图片下载等功能。
一、主要特点
- 完整下载:将语雀知识库完整下载为本地 Markdown 文件
- 图片下载:可选择将图片也下载到本地
- 私有支持:支持下载私有知识库内容
- 断点续传:支持下载中断后继续
- Web预览:内置 Web 服务可快速预览下载内容
二、安装前置
首先,这个工具是基于 Node 的(前端开发工具),
同时满足 Node 版本 ≥ 18.4
需要先官网下载:https://nodejs.org/zh-cn
然后 Win + R,输入 cmd 回车,打开命令行,设置一下镜像地址:
npm config set registry https://registry.npmmirror.com
三、安装 yuque-dl
npm i -g yuque-dl
这个工具是开源的:https://github.com/gxr404/yuque-dl ,可以放心使用。
四、使用 yuque-dl 下载 公开文章
下载指令为
yuque-dl "语雀文档路径"
下面我举例如何下载 语雀官方文档
记住,你在什么路径执行语句,就会下载到这个路径下
举例:我在"D:\yuquePachong"
执行了
yuque-dl "https://www.yuque.com/yuque/thyzgp"
然后就可以看到相关文档了:
五、使用 yuque-dl 下载 私有文章
需要提供 token:
yuque-dl "https://www.yuque.com/yuque/thyzgp" -t "your_token_value"
获取 Token 的方法
1.登录语雀网页版
2.打开开发者工具(F12)
3.进入 Application > Cookies
4.查找 _yuque_session 或其他相关 cookie 的值
注意事项
- 如果 token 包含特殊字符,使用 -t=“value” 形式
- 下载附件需要登录 token
- 网络中断后可重新运行命令继续下载
六、本地预览
下载完后,可以在本地预览,执行以下命令
yuque-dl server "刚刚你下载文件位置"
比如我上面下载好的那个文章要先预览就应该为
yuque-dl server "D:\yuquePachong\download\知识库"
执行以后,就会输出一个地址出来
然后打开浏览器,输入网址 http://localhost:5173
最后
yuque-dl 的功能还有很多:
- 显示帮助信息:-h, --help,可以看到大部分参数设置
- 设置下载目录 -d, --distDir
- 忽略图片(不下载):-i, --ignoreImg
- 忽略附件(不下载):–ignoreAttachments [fileExtension]
更多功能,可以去 GitHub 上看。
除了 yuque-dl,还有 yuque-exporter:https://github.com/atian25/yuque-exporter
类似的工具有很多,就不一一介绍了。
参考文章
【1】语雀知识库下载工具 —— yuque-dl
【2】语雀文档一键下载至本地教程