使用 yuque-dl 下载语雀知识库

在日常工作和学习中，我们经常会使用语雀来管理和分享知识库。然而，有时我们需要将语雀知识库下载到本地，以便离线查看或备份。yuque-dl 是一个非常方便的工具，可以帮助我们轻松实现这一目标。下面将详细介绍如何使用 yuque-dl 下载语雀知识库。

前提条件

在使用 yuque-dl 之前，请确保你的系统已经安装了 Node.js 18.4 或更高版本。你可以通过在终端运行以下命令来检查 Node.js 的版本：

bash复制

node -v

如果版本低于 18.4，请前往 Node.js 官方网站 下载并安装最新版本。

安装 yuque-dl

安装完成后，你可以通过 npm 全局安装 yuque-dl：

bash复制

npm i -g yuque-dl

安装成功后，你可以通过以下命令查看版本号，确保安装成功：

bash复制

yuque-dl --version

基本使用方法

yuque-dl 的基本使用方法非常简单。以下是主要的命令和选项：

下载知识库

bash复制

yuque-dl <url>

• <url> 是你需要下载的语雀知识库的 URL。

例如：

bash复制

yuque-dl "https://www.yuque.com/yuque/thyzgp"

常用选项

• -d, --dist-dir <dir>：指定下载的目录，默认为 download。

  bash复制

  yuque-dl "https://www.yuque.com/yuque/thyzgp" -d my_download_dir

• -i, --ignore-img：忽略图片不下载。

  bash复制

  yuque-dl "https://www.yuque.com/yuque/thyzgp" -i

• -k, --key <key>：指定语雀的 cookie key，默认是 _yuque_session。

  bash复制

  yuque-dl "https://www.yuque.com/yuque/thyzgp" -k "custom_key"

• -t, --token <token>：指定语雀的 cookie token。

  bash复制

  yuque-dl "https://www.yuque.com/yuque/thyzgp" -t "abcd1234"

• --toc：是否输出文档目录，默认为 false。

  bash复制

  yuque-dl "https://www.yuque.com/yuque/thyzgp" --toc

其他场景

私有知识库

如果需要下载私有知识库，通常需要通过分享链接，并使用 -t 参数添加 token 才能下载。

bash复制

yuque-dl "https://www.yuque.com/yuque/thyzgp" -t "abcd1234"

获取 token 的方法：

1. 打开浏览器的开发者工具（通常按 F12 或 Ctrl+Shift+I）。

2. 切换到 Application 选项卡。

3. 在左侧找到 Cookies，展开后找到对应的语雀域名（如 yuque.com）。

4. 查找 _yuque_session 或其他相关的 cookie key，并复制其值作为 token。

企业私有服务

企业版的语雀通常有自己的域名（如 https://yuque.antfin.com），在这种情况下，token 的 key 可能不唯一，需要用户手动指定。

bash复制

yuque-dl "https://yuque.antfin.com/r/zone" -k "custom_key" -t "custom_token"

公开密码访问的知识库

对于需要密码访问的知识库，有以下两种情况：

1. 已登录语雀：访问需要密码的知识库后，输入密码，使用 _yuque_session 作为 cookie key。

   bash复制

   yuque-dl "https://www.yuque.com/yuque/thyzgp" -t "_yuque_session的值"

2. 未登录语雀：访问需要密码的知识库后，输入密码，使用 verified_books 或 verified_docs 作为 cookie key。

   bash复制

   yuque-dl "https://www.yuque.com/yuque/thyzgp" -k "verified_books" -t "verified_books的值"

内置启动 Web 服务

yuque-dl 内置了一个 Web 服务，可以快速预览下载的内容。你可以使用以下命令启动服务：

bash复制

yuque-dl server ./download/知识库/

启动后，你可以在本地访问：

• 本地地址：http://localhost:5173/

• 网络地址：使用 --host 参数暴露服务。

示例

以下是一个完整的示例，展示如何下载一个公开的知识库并启动 Web 服务进行预览：

bash复制

# 下载知识库
yuque-dl "https://www.yuque.com/yuque/thyzgp" -d my_download_dir

# 启动 Web 服务
yuque-dl server my_download_dir

扩展

导入语雀知识库

如果想要将导出结果导入到自己的知识库，可以参考一下步骤

1. 将下载完的知识库目录打包为zip

2. 进入到自己的知识库，在导入中选择导入markdown文件，选择zip文件类型

3.