
图1:语雀平台Logo
YuqueSync 是一款跨平台的语雀文档同步工具。它支持实时监控、多格式导出、知识库完整备份,旨在确保用户的知识资产安全无忧。

图2:YuqueSync工具v2.0介绍及Docker部署命令
主要特性:
- 智能同步引擎:实时监控语雀文档变更,自动更新本地备份
- 多格式导出:支持 PDF 和 Markdown 两种导出格式
- 知识库整体同步:一次性同步整个知识库,无需逐个操作
- 智能变更检测:精准识别文档更新,避免重复下载
- 保留原文档格式:完整保留原始文档样式和结构
- Docker 部署:开箱即用,支持容器化部署,便于在各类环境(如NAS)中快速搭建。
准备:获取语雀访问凭证
要部署此工具,首先需要获取语雀的访问凭证。打开你需要同步的目标知识库页面(例如:https://www.yuque.com/david-gshie/nasbox)。

图3:目标语雀知识库(NASBox)的页面概览
在页面上按下 F12 键,打开浏览器开发者工具,然后切换到 网络(Network) 标签页。

图4:在知识库页面打开浏览器开发者工具
刷新页面,此时网络面板会记录大量请求。点击面板上的搜索按钮。

图5:在开发者工具的网络请求记录中进行搜索
搜索关键词 yuque_ctoken 或 _yuque_session(这两个参数通常在一起,搜索其一即可),按回车确认。

图6:在请求的Cookie信息中搜索到目标凭证
选择出现在 Cookie 字段中的结果,将完整的Cookie字符串复制到一个空白文本编辑器中。

图7:查看包含yuque_ctoken的Cookie详情
在复制出的文本中,找到 yuque_ctoken 和 _yuque_session 这两个参数对应的值,记录下来备用。

图8:从Cookie字符串中提取出所需的token和session值
安装:通过 Docker Compose 部署
获得凭证后,即可通过 Docker 快速部署。创建一个 docker-compose.yml 文件,内容如下:
services:
yuque-sync:
image: heizicao/yuque-sync:latest
container_name: yuque-sync
environment:
- YUQUE_TOKEN=你的token
- YUQUE_SESSION=你的session
volumes:
- ./data:/data
restart: always
参数说明(更多高级参数建议查阅项目文档)
YUQUE_TOKEN(必需):填入上一步获取的语雀 Token 值。
YUQUE_SESSION(必需):填入上一步获取的语雀 Session 值。
YUQUE_BASE_URL(可选):语雀网站地址,默认可不设置。
SAVE_PATH(可选):文档在容器内的保存路径,默认为 /data,此处通过卷映射到本地 ./data 目录。
MONITOR_INTERVAL_MINUTES(可选):自动同步的间隔时间(分钟)。
EXPORT_FORMAT(可选):导出格式,可选择 pdf 或 markdown。
在 云原生/IaaS 实践中,使用 Docker Compose 管理此类服务非常便捷。配置完成后,在文件所在目录执行 docker-compose up -d 命令即可启动服务。
使用与验证
目前 YuqueSync 尚无可视化操作界面,主要通过查看容器日志来了解运行状态。

图9:Docker管理界面中,yuque-sync容器处于运行状态
查看该容器的运行日志,可以看到工具已成功初始化并开始识别知识库、下载文档。

图10:容器的运行日志,详细记录了同步启动、知识库发现和文档下载过程
同步完成后,访问之前映射的本地目录(本例中为 ./data),可以看到整个知识库的文档都已按结构下载至此。

图11:同步到本地的知识库文档列表(PDF格式)
导出的PDF文档整体效果不错,原始排版、代码高亮和图片均被保留,实现了完整的本地化备份。虽然行间距可能存在微小差异,但完全不影响阅读与归档。

图12:同步到本地的PDF文档内容预览,格式保留完整
总结
总体而言,YuqueSync 是一款非常实用的语雀文档本地化同步工具。部署后即可在后台自动运行,将云端文档持续同步至本地,为重要的知识资产增添一份可靠的本地保障。无论云端服务多么安全,拥有一份自己掌控的本地备份总能让人更加安心。
本次演示以 PDF 格式导出,效果基本完美。若选择 Markdown 格式导出,需注意文档内引用的图片可能仍是网络链接而非本地图片,这对于追求完全离线的用户来说是个小遗憾。希望开发者未来能增加可视化配置界面,并优化 Markdown 导出的图片本地化问题,让这个优秀的工具更加完善。对于有文档备份和自动化需求的语雀用户,不妨在您的 NAS 上部署一试。
综合推荐:⭐⭐⭐⭐(语雀用户推荐部署)
使用体验:⭐⭐⭐(核心功能扎实,细节有待优化)
部署难易:⭐⭐(步骤清晰,过程简单)
欢迎在 云栈社区 分享你的使用体验或探讨更多自动化运维方案。