🌟 主要特性
全面的文档同步解决方案,满足不同场景的需求
智能同步引擎
实时监控语雀文档变更,自动更新本地备份
多格式导出
支持 PDF 和 Markdown 两种导出格式
知识库整体同步
一次性同步整个知识库,无需逐个操作
智能变更检测
精准识别文档更新,避免重复下载
保留原文档格式
完整保留原始文档样式和结构
Docker 部署
开箱即用,支持容器化部署
快速开始
三个简单步骤开启文档同步之旅
1
获取凭证
登录语雀,打开开发者工具 (F12) → Network,刷新页面。 在任意请求头中找到 yuque_ctoken 和 _yuque_session。
2
选择运行方式
推荐使用 Docker 运行,简单快速,环境隔离。也支持 Python 本地直接运行。
3
开始同步
服务启动后会自动开始同步任务,您可以查看日志确认进度。
Bash
# 运行容器$$ docker run -d \$ --name yuque-sync \$ --restart always \$ -e YUQUE_TOKEN="你的token" \$ -e YUQUE_SESSION="你的session" \$ -v /path/to/save:/data \$ ghcr.io/deadmau5v/YuqueSync:v1.0.0
配置说明
详细的环境变量配置参数
| 环境变量 | 必填 | 默认值 | 说明 |
|---|---|---|---|
YUQUE_TOKEN | 必需 | - | 语雀 Token |
YUQUE_SESSION | 必需 | - | 语雀 Session |
YUQUE_BASE_URL | 可选 | https://www.yuque.com | 语雀网站地址 |
SAVE_PATH | 可选 | /data | 文档保存路径 |
MONITOR_INTERVAL_MINUTES | 可选 | 10 | 同步间隔(分钟) |
EXPORT_FORMAT | 可选 | 导出格式 (pdf/markdown) |