语雀文档一键下载至本地教程
# 语雀文档一键下载至本地教程
# 前言
最近在看副业教程,很多都是在语雀上的,作为一个数据仓鼠,我习惯于保存它们到我自己的笔记软件中。
一开始我用的是笨方法——手动复制粘贴,但效率实在太慢了 😶。
于是我想,网上应该有类似的工具,因此发现了 yuque-dl,能一键下载所有语雀文档(包含非公开文档)。
接下来将讲解入门使用,本文结构:
- 安装 Node
- 安装 yuque-dl
- 下载文档
- 本地预览
- Markdown 介绍
# 安装 Node
首先,这个工具是基于 Node 的(前端开发工具),需要先官网下载:https://nodejs.org/zh-cn
下载 .msi 安装包,然后一路 next 即可。
然后 Win + R,输入 cmd 回车,打开命令行,输入:
npm config set registry https://registry.npmmirror.com
此刻,Node 就完成安装和配置了。
PS:语雀下载工具要求 Node 版本 ≥ 18.4,如果你要用旧版本的 Node,可以先用 Volta 这个版本管理工具切换版本。
# 安装 yuque-dl
安装也很简单,在命令行输入:
npm i -g yuque-dl
这个工具是开源的:https://github.com/gxr404/yuque-dl ,可以放心使用。
# 下载文档
然后就可以下载文档了,格式为:
yuque-dl <url>
示例(下载官方文档):yuque-dl "https://www.yuque.com/yuque/thyzgp"
然后就会开始下载了(下载过程会使宽带跑满,请注意与别的任务是否冲突):
静待其下载完:
然后就可以看到相关文档了:
如果你要下载的是私有知识库,则需要加上参数 token(你可以理解是登录密码,表示你有权限)。
注意,前提是你要知道别人设置的密码,然后才能获取参数下载,无法做到破解密码。
命令格式:
yuque-dl <url> -t "token 值"
将 URL 和 token 值替换为你自己的。
那如何获取 token 值呢?以 Chrome 为例(其他浏览器也类似):
- 登录语雀,浏览器右击菜单"检查"或点击快捷键 F12,打开控制台
- 点击应用(Application)
- 点击左侧
Cookies
下的https://www.yuque.com
- 右侧列表中找到
Name
为_yuque_session
的行,双击Value
列复制 Value 的值(也就是下面图片中绿色部分)
然后再替换参数,执行命令即可。
# 本地预览
下载完后,可以在本地预览,输入命令 yuque-dl server ./download/知识库/
然后打开浏览器,输入网址 http://localhost:5173:
# Markdown 介绍
下载后的文件,默认是 Markdown 格式。
这是一种很通用的格式,可以很方便地转为其他格式(Word、PDF、HTML 等)
如果你还不知道什么是 Markdown,可以看看我写的一系列 Markdown 教程
# 最后
yuque-dl 的功能还有很多:
- 显示帮助信息:
-h, --help
,可以看到大部分参数设置 - 设置下载目录
-d, --distDir <dir>
- 忽略图片(不下载):
-i, --ignoreImg
- 忽略附件(不下载):
--ignoreAttachments [fileExtension]
- ...
更多功能,可以去 GitHub 上看。
除了 yuque-dl,还有 yuque-exporter:https://github.com/atian25/yuque-exporter
类似的工具有很多,就不一一介绍了。