常见问题

大部分问题都可以在文档中找到解决办法，请优先从 快速开始 阅读文档，再进行实际操作。

如果还是运行报错，请 提交 issue 或在 discussions 中留言

配置问题

elog.config.js为 Elog 的配置文件，其中以 process.env开头的不需要改动，且为必填信息。

例如 process.env.YUQUE_TOKEN为语雀账号相关敏感信息，用于本地同步时在.elog.env中指定YUQUE_TOKEN=你的语雀 Token，其他配置可根据实际需求改动。

Elog 运行报缺少参数

1. 检查 elog.config.js中所有 platform 属性的值是否是你对应平台的值。例如如果想用语雀 Token 的方式同步语雀文档，则 write.platform = yuque；如果是使用语雀账号密码的方式，则write.platform = yuque-pwd
2. 检查.elog.env中是否填写账号信息。无论用哪种方式同步语雀，.elog.env中的YUQUE_LOGIN和YUQUE_REPO都是必填参数。其他必填参数请看本文档相关配置表格中的是否必填字段

如何重新全量同步文档

elog 默认为增量更新，只有该文档重新修改过，再次同步时，才会重新拉取该文档。如果想重新全量同步文档。有以下 3 种办法：

1. 运行同步命令时，增加禁用缓存标识：elog sync --disable-cache
2. 运行 elog clean，Elog 将会自动清除所有文档、本地图片、缓存文件(elog.cache.json)
3. elog.cache.json为 Elog 增量同步的关键，可手动删除此文件，推荐同时手动删除所有文档、本地图片

语雀/飞书子目录没有导出

默认是没有按目录导出的，可通过配置开启：按目录存放文档

如何升级 Elog 到指定版本

1. 运行elog upgrade更新全局 Elog 版本到最新正式版本

2. 如果你是通过包管理工具（npm/yarn/pnpm）全局安装的 Elog，则重新安装并指定版本号

   npm install @elog/[email protected] -g
   # 也可以指定测试版本号
   npm install @elog/[email protected] -g
   

3. 如果你是将 Elog安装在 package.json 中，则修改package.json中的@elog/cli版本号