大家好,我是热爱开源的了不起。
了不起非常喜欢飞书文档这个产品(先声明一下,我不是在打广告哈)。我日常需要协作的技术文档,以及公众号文章都是在飞书文档里敲出来的。简洁美观的 UI 设计以及对 markdown 语法的完美支持,让我成为了飞书文档的自来水。
但是,我唯一要吐槽的一点就是,你这个文档支持 markdown 语法,为啥不能直接导出 markdown 文档啊?这导致每次我写完文章都要手动将整篇文字复制到 typora 中,然后再处理一下复制出来的没有后缀的图片上传到图床,才能保存为一个正常的 markdown 文档。
虽然这一系列工作很麻烦,但是时间长了也就轻车熟路,习惯了这些麻烦事。直到我前几天发现了这个项目……
项目简介
Feishu2Md 是使用 go 语言开发的一个很轻便的小工具,他可以帮助你方便的将飞书文档导出为 markdown 格式的文档,并且将图片按照正确的格式保存到本地。估计飞书的产品经理看到了都会哭泣。
Feishu2Md 的底层实现逻辑,是通过调用飞书提供的开发者 API 来实现文档和图片的读取和保存功能,进而实现一篇 markdown 文档完整的导出。所以,想要用好 Feishu2Md,首先需要创建一个企业自建应用,并生成一组 API 的 token。过程看似麻烦,但是跟着了不起一步一步来,其实很简单。
获取 API Token
第一步,进入开发者后台,网址:https://open.feishu.cn/app。点击“创建企业自建应用”按钮,随便填写一些信息即可。
第二步,选择左侧菜单的“测试企业和人员”,点击“创建测试企业”按钮,绑定企业和应用。之后切换至测试版本。具体的步骤和按钮的位置看图就好了,已经清晰的标记出来了。
第三步,点击左侧菜单的“权限管理”,开通图中的四个权限。
第四步,点击左侧菜单的“凭证与基础信息”,就可以获取 App ID 和 App Secret 啦。
之后就不要轻易的改动以上信息了,否则 App ID 和 App Secret 会发生变化,之后还得再重新配置 Feishu2Md 工具。
安装与配置
工具无需安装,直接在项目的 release 页面下载对应平台的可执行应用即可。
我们需要使用 feishu2md config --appId <your_id> --appSecret <your_secret>
命令来生成配置文件,之后可以用 feishu2md config
命令查看配置完成的信息。
以 macOS 环境为例,如图所示:
如果你能查看到配置信息,就说明配置完成啦。
下载文档
打开飞书中你想下载的文档,点击右上角的分享按钮获取文档的分享链接。这里需要勾选“互联网上获得连接的人可阅读”,这样 feishu2md 工具才能访问到该文档,并下载到本地。
之后使用命令 feishu2md <your feishu docx url>
进行下载。例如:
文档和图片就都下载成功了。
总结
feishu2md 弥补了飞书文档功能上的欠缺,一键导出为 markdown 格式确实是了不起非常想要的功能,大大的提高了工作效率。如果你也有将飞书文档导出为 markdown 文档的需求,建议你一定要试试!
代码语言:javascript复制项目地址:https://github.com/Wsine/feishu2md