Feishu Pages 项目使用教程

Feishu Pages 项目使用教程

feishu-pagesGenerate Feishu Wiki into a Markdown for work with Static Page Generators.项目地址:https://gitcode.com/gh_mirrors/fe/feishu-pages

1. 项目的目录结构及介绍

Feishu Pages 项目的目录结构如下:

  1. feishu-pages/

  2. ├── README.md

  3. ├── package.json

  4. ├── src/

  5. │ ├── index.js

  6. │ ├── config.js

  7. │ └── utils/

  8. ├── dist/

  9. └── env.example

  • README.md: 项目说明文档。
  • package.json: 项目的依赖和脚本配置文件。
  • src/: 源代码目录。
    • index.js: 项目的主入口文件。
    • config.js: 项目的配置文件。
    • utils/: 工具函数目录。
  • dist/: 生成的 Markdown 文件和图片文件存放目录。
  • env.example: 环境变量配置示例文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。这个文件是整个项目的入口点,负责初始化配置、调用 API 接口、处理数据转换等核心功能。

  1. // src/index.js

  2. const config = require('./config');

  3. const { fetchDocuments, convertToMarkdown } = require('./utils');

  4. async function main() {

  5. // 初始化配置

  6. const { FEISHU_APP_ID, FEISHU_APP_SECRET, FEISHU_SPACE_ID } = process.env;

  7. if (!FEISHU_APP_ID || !FEISHU_APP_SECRET || !FEISHU_SPACE_ID) {

  8. throw new Error('Missing required environment variables');

  9. }

  10. // 获取文档数据

  11. const documents = await fetchDocuments(FEISHU_SPACE_ID);

  12. // 转换为 Markdown 格式

  13. await convertToMarkdown(documents);

  14. }

  15. main().catch(console.error);

3. 项目的配置文件介绍

项目的配置文件是 src/config.js。这个文件定义了项目运行所需的各种配置参数,包括环境变量、API 接口地址等。

  1. // src/config.js

  2. module.exports = {

  3. FEISHU_ENDPOINT: process.env.FEISHU_ENDPOINT || 'https://open.feishu.cn',

  4. OUTPUT_DIR: process.env.OUTPUT_DIR || 'dist',

  5. BASE_URL: process.env.BASE_URL || '/',

  6. ROOT_NODE_TOKEN: process.env.ROOT_NODE_TOKEN || '',

  7. URL_STYLE: process.env.URL_STYLE || 'nested',

  8. };

  • FEISHU_ENDPOINT: 飞书 API 节点地址。
  • OUTPUT_DIR: 输出目录,默认为 dist
  • BASE_URL: 自定义文档输出的 URL 前缀。
  • ROOT_NODE_TOKEN: 从哪个节点开始导出。
  • URL_STYLE: 导出的文档 URL 风格,支持 nestedoriginal

通过环境变量或 env 文件可以配置这些参数,确保项目在不同环境下都能正常运行。

feishu-pagesGenerate Feishu Wiki into a Markdown for work with Static Page Generators.项目地址:https://gitcode.com/gh_mirrors/fe/feishu-pages

© 版权声明

相关文章

暂无评论

您必须登录才能参与评论!
立即登录
暂无评论...