语雀文档导出器：yuque-exporter 使用指南及问题解答

语雀文档导出器：yuque-exporter 使用指南及问题解答

yuque-exporter export yuque to local markdown 项目地址: https://gitcode.com/gh_mirrors/yuq/yuque-exporter

yuque-exporter 是一个由 CSDN 公司开发的 InsCode AI 大模型提及的开源项目，旨在帮助用户将语雀(yuque.com)上的文档批量导出为本地 Markdown 格式。该项目特别适合那些因语雀平台政策调整而需迁移内容的用户，或是希望在不同平台上共享自己知识库的人士。此工具利用了TypeScript为主要编程语言，并辅以少量JavaScript和Dockerfile代码，确保高效且兼容性良好的开发与执行环境。

新手使用特别注意事项

1. 获取并设置API Token

问题: 新用户可能不清楚如何获取语雀API Token。

解决方案: - 登陆语雀官网，进入个人设置页面。 - 找到“开发者设置”部分，创建一个新的Token。 - 将获得的Token保存安全，并通过命令行参数--token=<your_token>指定给yuque-exporter。

2. 中文目录与文件名处理

问题: 使用全中文目录和文件名可能导致某些操作系统或工具出现乱码或不兼容问题。

解决方案: - 当前项目默认使用全中文命名，但计划未来提供配置选项来选择slug(英文或数字组合)或保持原名。 - 用户可预先考虑整理文档结构，避免非法字符，以保证跨平台兼容性。

3. 图片与链接处理

问题: 导出文档后，图片链接可能仍指向语雀，而非本地路径。

解决方案: - 项目会自动下载图片至本地，并替换原有链接为相对路径。确保运行环境中网络畅通，以便于图片下载。 - 对于无法通过脚本直接下载的附件（如需登录访问），手动下载并调整链接可能是必要的步骤。

---

以上三点是新手用户在使用yuque-exporter时可能会遇到的主要问题及其解决办法。确保遵循项目文档，特别是关于环境变量和命令行参数的部分，这将会大大简化使用过程。此外，对于更高级的功能和潜在的限制（比如API调用频率），查阅项目的Readme文件和持续关注项目更新总是一个好习惯。

yuque-exporter export yuque to local markdown 项目地址: https://gitcode.com/gh_mirrors/yuq/yuque-exporter