{"repo":"longbridge/feishu-pages","free":true,"listed":false,"github":"https://github.com/longbridge/feishu-pages","clone":"git clone https://github.com/longbridge/feishu-pages.git","description":"Generate Feishu Wiki into a Markdown for work with Static Page Generators.","language":"TypeScript","stars":302,"topics":["feishu","github-pages","static-page-generator","larksuite","markdown","feishu-openapi"],"license":"MIT","category":"productivity","readme_excerpt":"Feishu Pages 导出 飞书知识库 ，并按相同目录结构生成 Static Page Generator 支持 Markdown 文件组织方式，用于发布为静态网站。 借用飞书文档较好的撰写能力，让不懂 Markdown 和 Git 的非技术人员可以轻松撰写文档，并也最终以静态页面生成的方式来部署文档。这样我们依然可以继续保持 CI 流程和 GitHub PR 的方式来 Review 文档变更。 可以访问此文档的 原始飞书知识库 对比看一下。 Features - feishu-docx - 支持将飞书新版文档 Docx 转换为 Markdown 或其他格式（ 目前只支持 Markdown ） - 目录结构组织，与 URL 路径自定义 - 图片、附件下载 - 国际化支持 - 与 GitHub Actions 结合 - 生成支持 Docusaurus 支持的 MDX 格式的 Meta 信息，以实现目录结构组织（基于 sidebar position ） Prepare 📌 在开始使用之前，必须先完成飞书开放平台的配置工作，获得一些必要的信息，和配置必要的权限，请认真阅读完此页再继续。 创建飞书应用并开通权限 1. 请访问 https://open.feishu.cn/app 创建一个新应用，并获得： - App ID - App Secret - 请注意保管 App Secret，不要泄露到互联网。 2. 为应用开启 机器人 应用能力。 3. 为应用开启 docx:document:readonly 和 wiki:wiki:readonly 权限。 4. 将应用发布正式版本，并确保审批通过。 5. 在飞书 IM 中创建新群 Feishu Pages ，将应用添加为该群机器人，知识库管理员在「知识空间设置」- 「权限设置」- 「添加管理员」中添加，把这个 Feishu Pages 群加成 管理员 。 - 否则会遇到 permission denied: wiki space permission denied 错误。 ref Feishu Permissions 你的飞书应用需要开通下面几个权限，工具通过飞书 API 访问必须要这几项。 - docx:document:readonly - wiki:wiki:readonly - drive:drive:readonly - board:whiteboard:node:read 获取飞书知识库 \\ \\ space id\\ \\ 我们需要配置 FEISHU SPACE ID 的环境变量，这个为飞书知识库的 space id ，你可以访问知识库设置界面，从 URL 中获取。 例如： https://your-company.feishu.cn/wiki/settings/6992046856314306562 这里面 6992046856314306562 为 space id 。 环境变量配置 Feishu Pages 支持 .env 文件，如果执行的根目录有个 .env 文件，将会自动读取。 请参考 .env.default 配置环境变量。 如需在 GitHub Actions 的 CI 流程里面使用，建议添加到 Secrets 中，再通过环境变量的方式获取。 Installation Feishu Pages 可以以 NPM 的方式引入到 Static Page Generator 的项目中。 例如我们有一个 Docusaurus 的静态页面网站项目。 然后你就可以执行 yarn feishu","default_branch":null,"files":null,"tree":[],"storefront":"/r/longbridge","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/longbridge/feishu-pages/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}