feishu2md 项目常见问题解决方案

feishu2md 项目常见问题解决方案

feishu2md 一键命令下载飞书文档为 Markdown 项目地址: https://gitcode.com/gh_mirrors/fe/feishu2md

项目基础介绍

feishu2md 是一个用于将飞书文档下载为 Markdown 文件的开源工具。该项目使用 Go 语言实现，具有跨平台特性，支持多种操作系统。用户可以通过简单的命令行操作，将飞书文档转换为 Markdown 格式，便于在其他平台或工具中使用。

新手使用注意事项及解决方案

1. 配置文件生成问题

问题描述：新手在使用 feishu2md 时，可能会遇到配置文件生成失败或配置不正确的问题。

解决步骤：

1. 获取 API Token：

   • 进入飞书开发者后台，创建企业自建应用（个人版）。
   • 打开权限管理，开通以下必要的权限：
     • 获取文档基本信息：docx:document:readonly
     • 获取文档所有块：docx:document:readonly
     • 下载素材：docs:document:media:download
     • 获取文件夹中的文件清单：drive:file:readonly
     • 获取知识空间节点信息：wiki:wiki:readonly
   • 打开凭证与基础信息，获取 App ID 和 App Secret。

2. 生成配置文件：

   • 使用命令 feishu2md config --appId <your_id> --appSecret <your_secret> 生成配置文件。
   • 通过 feishu2md config 命令查看配置文件路径及是否成功配置。

2. 文档下载失败问题

问题描述：在下载飞书文档时，可能会遇到下载失败或下载内容不完整的问题。

解决步骤：

1. 检查文档链接：

   • 确保文档链接是通过飞书文档的“分享 > 开启链接分享 > 互联网上获得链接的人可阅读 > 复制链接”获得的。

2. 使用正确的命令：

   • 使用命令 feishu2md dl <your feishu docx url> 下载单个文档。
   • 示例：feishu2md dl "https://domain.feishu.cn/docx/xxxxxxxx"。

3. 检查网络连接：

   • 确保网络连接正常，避免因网络问题导致下载失败。

3. 跨平台使用问题

问题描述：新手在不同操作系统上使用 feishu2md 时，可能会遇到兼容性问题。

解决步骤：

1. 下载对应平台的可执行文件：

   • 在项目的 Release 页面下载适用于自己操作系统的 feishu2md 可执行文件。
   • 将下载的文件放置在系统的 PATH 路径中，确保可以在命令行中直接调用。

2. 查阅帮助文档：

   • 使用命令 feishu2md -h 查阅帮助文档，了解命令的具体使用方法。
   • 示例：feishu2md -h 会显示所有可用的命令及其选项。

3. 跨平台配置：

   • 确保配置文件在不同操作系统上的一致性，避免因配置文件路径或格式问题导致工具无法正常运行。

通过以上步骤，新手用户可以更好地理解和使用 feishu2md 项目，解决常见的问题，顺利完成飞书文档到 Markdown 的转换。

feishu2md 一键命令下载飞书文档为 Markdown 项目地址: https://gitcode.com/gh_mirrors/fe/feishu2md