前言

参考 Elog 文档，仓库中有两个 elog 配置文件：

1. elog.config.js：同步到 Halo 时的配置文件，用于同步 FlowUs 文档到 Halo

   module.exports = {
     write: {
       platform: 'flowus',
       flowus: {
         tablePageId: process.env.FLOWUS_TABLE_PAGE_ID,
       }
     },
     deploy: {
       platform: 'halo',
       halo: {
         endpoint: process.env.HALO_ENDPOINT,
         token: process.env.HALO_TOKEN,
         policyName: process.env.HALO_POLICY_NAME,
         rowType: 'html',
         needUploadImage: true,
       }
     },
     image: {
       enable: false,
     }
   }
   
   

2. elog.config.local.js：同步到本地时的配置文件，用于备份 FlowUs 文档到本地

   module.exports = {
     write: {
       platform: 'flowus',
       flowus: {
         tablePageId: process.env.FLOWUS_TABLE_PAGE_ID,
       },
     },
     deploy: {
       platform: 'local',
       local: {
         outputDir: './docs',
         filename: 'title',
         format: 'markdown',
         frontMatter: {
           enable: true,
           exclude: ['cover']
         }
       }
     },
     image: {
       enable: true,
       platform: 'local',
       local: {
         outputDir: './images',
         pathFollowDoc: true,
       }
     }
   }
   
   

elog.config.js

FlowUs 配置

write: {
  platform: 'flowus',
  flowus: {
    tablePageId: process.env.FLOWUS_TABLE_PAGE_ID,
  }
}

• tablePageId为FlowUs 数据表格页面 ID，可从此处获取

Halo 配置

deploy: {
  platform: 'halo',
  halo: {
    endpoint: process.env.HALO_ENDPOINT,
    token: process.env.HALO_TOKEN,
    policyName: process.env.HALO_POLICY_NAME,
    needUploadImage: true,
  }
}

• endpoint表示 Halo 站点地址

• token表示 Halo 个人令牌

• policyName表示附件的存储策略

• needUploadImage表示文档将会把扫描到的图片上传到 Halo中去

图床配置

image: {
  enable: false
}

不使用图床。不推荐图床和needUploadImage一起打开，要么用在线图床图片，要么上传到 Halo 中

elog.config.local.js

本地配置

deploy: {
  platform: 'local',
  local: {
    outputDir: './docs',
    filename: 'title',
    format: 'markdown',
    frontMatter: {
      enable: true
    }
  }
}

• outputDir为导出文件夹，文档将被导出到此目录下

• filename为文件命名方式，title 表示按照文档标题命名

• format表示文档将被格式化为 markdown 形式的文档

• frontMatter.enable表示将生成带有 FrontMatter 的 markdown 文档

图床配置

image: {
  enable: true,
  platform: 'local',
  local: {
    outputDir: './images',
    pathFollowDoc: true,
  }
}

• outputDir为导出文件夹，图片将被导出到此目录下

• pathFollowDoc表示文档图片路径将跟随文档路径计算

更多 Elog 配置详情，请阅读 Elog 文档