项目介绍
YuqueSync 用于把语雀中的文档同步到本地,常见用途是导出 Markdown、PDF 或保留知识库目录。备份的重点不只是正文,还包括图片、附件、目录和失败条目。
同步工具把知识库目录与正文转成本地文件,后续可用于离线阅读和备份。图片、附件和失败项决定归档是否完整。
适合自己的语雀资料保存。先用小知识库验证更新、改名和删除行为,再配置计划任务。
核心功能
| 功能 | 作用与使用方式 |
|---|---|
| 整库同步 | 保留目录层级 |
| 格式导出 | 选择支持的 Markdown 或 PDF |
| 变更检测 | 更新已修改内容 |
| 附件检查 | 核对图片与文件 |
| 任务记录 | 保留失败清单 |
功能示意

图 1:自制功能示意图,概括本文的使用要点。
项目信息
| 项目 | 说明 |
|---|---|
| 类型 | 配置指南 |
| 分类 | NAS 与运维 |
| 整理日期 | 2026-11-14 |
安装或使用条件
先确认所用项目版本、操作系统与依赖,准备独立测试目录及可恢复的数据副本。本文中的操作流程需与对应版本的官方说明配合使用。
安装与使用步骤
- 确认所用 YuqueSync 版本的实际代码来源与语雀授权方式,创建只需要读取目标知识库的凭据。先选择一个包含图片和附件的小知识库。
- 配置本地导出目录与支持的输出格式,执行一次手动同步。对照语雀目录检查文档数量、标题层级、图片路径和附件链接。
- 修改一篇测试文档后再次同步,确认工具如何处理更新、重命名和删除。把同步失败清单保留下来,不把命令退出成功视为全部内容已备份。
- 完整验证后再增加定时任务,并将导出目录纳入 NAS 版本备份;首次不要直接覆盖已有手工整理文件。
首次使用与操作检查
同步含图片附件的测试库,离线打开,再修改一篇测试文档重新同步。
不要直接覆盖已有手工文稿。授权凭据仅用于所需知识库,导出目录纳入独立版本备份。
配置与常见问题
- 外链附件如果只是保存 URL,离线时仍可能打不开,需要检查实际文件是否已下载。
- 同步目录会随上游变化,另做版本备份才能恢复误删前的状态。
更新与备份
备份导出正文、媒体文件、目录索引和同步日志;授权令牌单独加密存放。