Project Icon

feishu2md

将飞书文档高效转换为Markdown格式的工具

feishu2md是一款开源工具,用于将飞书文档转换为Markdown格式。支持单文档和批量文件夹转换,提供命令行、Docker和在线版本。用户通过简单配置即可获取API Token,实现文档快速下载和转换。该工具简化了飞书文档的处理流程,适用于需要Markdown格式文档的场景。

feishu2md

Golang - feishu2md 单元测试 发布 Docker - feishu2md Render - feishu2md 最后审核

这是一个使用Go语言实现的工具,用于将飞书文档下载为Markdown文件。

请注意:正在招募有需求和兴趣的开发者,共同探讨开发维护,如有兴趣请联系。

动机

《一日一技 | 我开发的这款小工具,轻松助你将飞书文档转为 Markdown》

获取 API Token

配置文件需要填写APP ID和APP SECRET信息,请参考飞书官方文档获取。推荐按以下步骤设置:

  • 进入飞书开发者后台
  • 创建企业自建应用(个人版),信息可随意填写
  • (重要)打开权限管理,开通以下必要的权限(可点击以下链接参考 API 调试台->权限配置字段)
  • 打开凭证与基础信息,获取App ID和App Secret

如何使用

注意:飞书旧版文档的下载工具已决定不再维护,但分支v1_support仍可使用,对应的归档为v1.4.0,请知悉。

命令行版本

借助Go语言跨平台的特性,已编译好了主要平台的可执行文件,可以在Release中下载,并将相应平台的feishu2md可执行文件放置在PATH路径中即可。

查阅帮助文档

$ feishu2md -h
名称:
  feishu2md - 下载飞书/Larksuite文档为Markdown文件

用法:
  feishu2md [全局选项] 命令 [命令选项] [参数...]

版本:
  v2-0e25fa5

命令:
  config        读取配置文件或设置字段(如果提供)
  download, dl  下载飞书/Larksuite文档为Markdown文件
  help, h       显示命令列表或某个命令的帮助

全局选项:
  --help, -h     显示帮助 (默认: false)
  --version, -v  打印版本 (默认: false)

$ feishu2md config -h
名称:
   feishu2md config - 读取配置文件或设置字段(如果提供)

用法:
   feishu2md config [命令选项] [参数...]
选项:
--appId value      设置 OPEN API 的应用 ID
--appSecret value  设置 OPEN API 的应用密钥
--help, -h         显示帮助信息(默认:false)

$ feishu2md dl -h
名称:
feishu2md download - 将飞书/Lark 文档下载为 Markdown 文件

用法:
feishu2md download [命令选项] <url>

选项:
--output value, -o value  指定 Markdown 文件的输出目录(默认:"./")
--dump                    导出 OPEN API 的 JSON 响应(默认:false)
--batch                   下载文件夹下的所有文档(默认:false)
--help, -h                显示帮助信息(默认:false)

**生成配置文件**

通过 `feishu2md config --appId <your_id> --appSecret <your_secret>` 命令即可生成该工具的配置文件。

通过 `feishu2md config` 命令可以查看配置文件路径以及是否成功配置。

更多的配置选项请手动打开配置文件更改。

**下载单个文档为 Markdown**

通过 `feishu2md dl <your feishu docx url>` 直接下载,文档链接可以通过 **分享 > 开启链接分享 > 互联网上获得链接的人可阅读 > 复制链接** 获得。

示例:

```bash
$ feishu2md dl "https://domain.feishu.cn/docx/docxtoken"

批量下载某文件夹内的全部文档为 Markdown

此功能暂时不支持 Docker 版本

通过 feishu2md dl --batch <your feishu folder url> 直接下载,文件夹链接可以通过 分享 > 开启链接分享 > 互联网上获得链接的人可阅读 > 复制链接 获得。

示例:

$ feishu2md dl --batch -o output_directory "https://domain.feishu.cn/drive/folder/foldertoken"

Docker 版本

Docker 镜像:https://hub.docker.com/r/wwwsine/feishu2md

Docker 命令:docker run -it --rm -p 8080:8080 -e FEISHU_APP_ID=<your id> -e FEISHU_APP_SECRET=<your secret> -e GIN_MODE=release wwwsine/feishu2md

Docker Compose:

# docker-compose.yml
version: '3'
services:
  feishu2md:
    image: wwwsine/feishu2md
    environment:
      FEISHU_APP_ID: <your id>
      FEISHU_APP_SECRET: <your secret>
      GIN_MODE: release
    ports:
      - "8080:8080"

启动服务 docker compose up -d

然后访问 https://127.0.0.1:8080 粘贴文档链接即可,文档链接可以通过 分享 > 开启链接分享 > 复制链接 获得。

在线版本

我使用个人的测试 API Token 部署了一个不稳定版本在 Render 平台上,该版本不会保存任何的文档资料和图片在容器中,直接通过 HTTP 从内存中返回压缩包文件,但是 Render 平台的日志可能会记录一些 HTTP 信息。

该版本仅供不在意隐私或懒于配置的用户临时使用,也可用于测试对比是否自己的 Token 权限配置有问题。Render 平台使用免费配额,仅有 512M 内存,不保证高可用性,信任链全靠开源代码,请自行斟酌。

访问 https://feishu2md.onrender.com/ 粘贴文档链接即可,文档链接可以通过 分享 > 开启链接分享 > 复制链接 获得。

感谢

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

稿定AI

稿定设计 是一个多功能的在线设计和创意平台,提供广泛的设计工具和资源,以满足不同用户的需求。从专业的图形设计师到普通用户,无论是进行图片处理、智能抠图、H5页面制作还是视频剪辑,稿定设计都能提供简单、高效的解决方案。该平台以其用户友好的界面和强大的功能集合,帮助用户轻松实现创意设计。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号