当前位置：首页 > news >正文

快速免费导出语雀文档：yuque-exporter完整指南

news 2026/6/2 9:35:58

快速免费导出语雀文档：yuque-exporter完整指南

【免费下载链接】yuque-exporterexport yuque to local markdown项目地址: https://gitcode.com/gh_mirrors/yuq/yuque-exporter

当你面对语雀平台政策调整，担心宝贵的技术文档和知识资产无法继续访问时，yuque-exporter为你提供了终极解决方案。这款免费开源工具能高效批量导出语雀文档为本地Markdown文件，让你的知识库彻底摆脱平台限制，实现真正的自主管理。

🚀 为什么你需要语雀文档导出工具？

语雀从内容社区转型为创作工具，新的付费策略让许多免费用户面临困境。你的技术笔记、项目文档、团队知识库可能随时无法访问。yuque-exporter应运而生，它通过简单的命令行工具，让你轻松将语雀文档迁移到本地，支持进一步发布到GitHub、GitLab或自建博客平台。

🔧 核心功能与工作原理

yuque-exporter采用模块化设计，整个导出过程分为三个核心阶段：

数据抓取阶段- 通过语雀API获取文档元数据和内容
数据处理阶段- 构建目录树结构，处理文档关系
文件生成阶段- 下载图片、转换链接，生成标准Markdown文件

项目的核心代码位于src/lib/目录，包含七个关键模块：

crawler.ts- 负责调用语雀API抓取数据
tree.ts- 构建文档目录树结构
doc.ts- 处理文档内容和格式转换
builder.ts- 协调整个导出流程
sdk.ts- 语雀API的封装层
utils.ts- 工具函数集合
types.ts- 类型定义文件

📦 快速开始：3分钟完成部署

环境准备

确保你的系统已安装Node.js 14+和npm。打开终端验证环境：

node --version npm --version

项目获取与安装

克隆项目并安装依赖：

git clone https://gitcode.com/gh_mirrors/yuq/yuque-exporter cd yuque-exporter npm install

获取语雀API令牌

登录语雀平台，进入"个人设置"→"API令牌"，创建一个新的令牌并复制保存。这是工具访问你文档的必要凭证。

⚡ 实战演示：批量导出语雀文档

基础导出命令

使用环境变量传递令牌开始导出：

YUQUE_TOKEN=你的令牌 npm start

或者使用npx直接运行（无需克隆项目）：

npx yuque-exporter --token=你的令牌

自定义导出配置

通过修改src/config.ts文件，你可以灵活调整导出行为：

export const config = { host: 'https://www.yuque.com', // 语雀API地址 token: process.env.YUQUE_TOKEN, // API令牌 outputDir: './storage', // 输出目录 clean: false, // 是否清理输出目录 };

指定导出范围

如果你只想导出特定知识库，可以修改主程序配置。查看src/main.ts中的示例：

const urlPaths = [ 'username/repo1', // 你的用户名/知识库 'teamname/docs', // 团队知识库 ]; await start({ urlPaths });

🎯 高级技巧与最佳实践

1. 处理大型知识库

对于包含数百篇文档的知识库，yuque-exporter采用并发处理机制（默认10个并发任务），通过任务队列优化性能。你可以在src/lib/builder.ts中调整并发数：

const taskQueue = new PQueue({ concurrency: 10 }); // 调整此值优化性能

2. 图片资源本地化

工具会自动下载文档中的图片并替换为相对路径，确保离线可访问。所有图片文件会保存在文档同级目录的assets文件夹中。

3. 文档链接转换

语雀内部的文档链接会被智能转换为Markdown相对链接，保持文档间的关联性完整。

4. 草稿文档处理

草稿文档会被单独处理，确保与已发布文档的目录结构一致，便于后续编辑和发布。

🔄 导出结果结构解析

成功导出后，你会得到以下目录结构：

storage/ ├── .meta/ # 元数据缓存 │ ├── repos.json # 知识库信息 │ └── docs/ # 文档原始数据 ├── 知识库名称/ # 按知识库分类 │ ├── 目录一/ # 保持语雀目录结构 │ │ ├── 文档一.md │ │ └── assets/ # 图片资源 │ └── 目录二/ │ └── 文档二.md └── drafts/ # 草稿文档