如何快速导出语雀文档？yuque-exporter 完整使用指南 🚀
【免费下载链接】yuque-exporter 
项目地址: https://gitcode.com/gh_mirrors/yuqu/yuque-exporter
yuque-exporter 是一款强大的开源工具，专为需要将语雀文档批量导出为 Markdown 格式的用户设计。无论是技术博主、内容创作者还是团队文档管理者，都能通过这款工具轻松实现语雀文档的本地备份与多平台发布，让你的知识管理更高效！
🌟 为什么选择 yuque-exporter？
随着语雀定位转向「创作工具」，许多用户需要将文档迁移到其他平台。yuque-exporter 应运而生，它能够：
✅ 一键批量导出：告别手动复制粘贴，轻松导出整个知识库
✅ 自动处理格式：完美保留 Markdown 格式，自动下载图片并替换链接
✅ 灵活配置选项：支持自定义输出目录、文件命名规则等高级功能
本项目开发过程中得到了语雀官方团队的指导与建议，兼容性与稳定性值得信赖！
📋 核心功能解析
🔄 导出流程全揭秘
yuque-exporter 的工作流程清晰高效，主要分为四步：
1️⃣ 调用语雀 API：通过官方接口获取文档元数据
2️⃣ 存储元数据：统一管理文档结构信息
3️⃣ 构建目录结构：根据 TOC 自动生成本地文件夹
4️⃣ 内容处理：下载图片、替换内部链接、清理多余 HTML 标签
yuque-exporter 工作流程示意图
图：yuque-exporter 的核心工作流程，展示从 API 调用到本地文件生成的完整过程
🛠️ 技术架构概览
项目采用模块化设计，核心代码位于 src/lib/ 目录：
- crawler.ts：负责爬取语雀 API 数据
- builder.ts：构建本地目录结构
- doc.ts：处理文档内容转换
- utils.ts：提供图片下载、链接替换等工具函数
🚀 快速上手指南
🔑 准备工作：获取语雀 Token
- 登录语雀账号，进入「个人设置 → 开发者设置」
- 创建新的 API Token，权限选择「文档读取」
- 复制生成的 Token，妥善保存
详细步骤可参考 语雀开发者文档
⚡ 两种安装方式
方式一：直接使用 npx（推荐新手）
无需安装，一行命令即可运行：
npx yuque-exporter --token=<你的 Token>
方式二：源码安装（适合开发者）
# 克隆仓库
git clone https://gitcode.com/gh_mirrors/yuqu/yuque-exporter
cd yuque-exporter
# 安装依赖
npm install
# 配置 Token 并启动
YUQUE_TOKEN=<你的 Token> npm start
# 查看导出结果
ls output
📝 基础命令示例
| 命令 | 功能描述 |
|---|---|
npx yuque-exporter --token=<token> | 使用 Token 导出默认知识库 |
npx yuque-exporter --repo=<repo-id> --output=docs | 指定知识库 ID 并导出到 docs 目录 |
npx yuque-exporter --help | 查看完整命令说明 |
更详细的命令行参数说明参见 帮助文档
💡 高级使用技巧
🎯 自定义导出配置
通过修改配置文件 src/config.ts，你可以：
- 调整文件命名规则（中文/英文 slug）
- 设置图片存储路径
- 过滤草稿文档
🤖 自动化导出脚本
创建 export.sh 文件，实现定期备份：
#!/bin/bash
# 每天凌晨 2 点执行导出
0 2 * * * YUQUE_TOKEN=<你的 Token> npx yuque-exporter --output=/backup/yuque-docs
📊 常见问题解决
Q：导出的 Markdown 图片无法显示？
A：工具会自动下载图片到 assets/ 目录，若缺失可能是网络问题，可尝试重新运行导出命令。
Q：如何导出私有知识库？
A：确保 Token 拥有对应知识库的访问权限，在命令中指定 --repo=<知识库路径> 即可。
📈 最佳实践案例
📚 个人博客同步方案
- 在语雀创建「博客文章」知识库
- 使用 yuque-exporter 导出为 Markdown：
npx yuque-exporter --repo=my-blog --output=./hexo/source/_posts - 直接通过 Hexo/Gatsby 等工具生成静态博客
🏢 团队文档备份策略
为团队知识库设置定时导出任务，结合 Git 实现版本控制：
# 导出文档
npx yuque-exporter --repo=team-docs --output=docs
# 提交更新到 Git
git add docs
git commit -m "Update team docs $(date +%Y-%m-%d)"
git push origin main
📄 许可证信息
本项目采用 MIT 许可证，详细条款见 LICENSE 文件。
🙏 致谢
感谢语雀官方提供的 API 支持，以及所有为本项目贡献代码的开发者们！
如果你在使用中遇到问题，欢迎提交 Issue 或参与代码贡献！
【免费下载链接】yuque-exporter 项目地址: https://gitcode.com/gh_mirrors/yuqu/yuque-exporter
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
