Skip to content
On this page

写作平台配置

语雀(Token方式)

注意:根据语雀定价调整,此方式需要语雀高级会员可用,以前生成过token的账户依旧可用

语雀关键信息获取及配置流程请移步 关键信息获取 页面。

字段必填说明默认值
token语雀Token-
baseUrl语雀API请求的Base Urlhttps://www.yuque.com/api/v2
login个人路径/空间ID-
repo语雀仓库短名称,也称为语雀知识库路径-
onlyPublic是否只获取公开文章false
onlyPublished是否只获取已发布文章false
limit文档下载并发数3

baseUrl 为语雀 API 请求路径
当知识库类型为个人知识库时,无需配置。
当知识库类型为团队知识库时,baseUrl=https://空间id.yuque.com/api/v2login=空间idrepo=空间中的语雀知识库路径

语雀(账号密码方式)

此方式无需语雀会员也可用
注意:在非国内CI/CD环境中使用此方式,例如Github Workflow,会导致语雀后台登录设备中出现大量美国IP,目前尚不清楚语雀是否会有安全限制措施,请谨慎使用。推荐本地同步时使用。

语雀关键信息获取及配置流程请移步 关键信息获取 页面。

字段必填说明默认值
username语雀帐号,一般是手机号-
password语雀密码,可在设置进行绑定
host语雀域名/团队域名https://www.yuque.com
login个人路径/空间ID-
repo语雀仓库短名称,也称为语雀知识库路径-
onlyPublic是否只获取公开文章false
onlyPublished是否只获取已发布文章false
limit文档下载并发数3

host 为语雀域名
当知识库类型为个人知识库时,无需配置。
当知识库类型为团队知识库时,host=https://空间id.yuque.com

Notion

Notion 模版获取、关键信息获取及配置流程请移步 关键信息获取 页面。

字段必填类型说明默认值
tokenstringNotion Token
databaseIdstringnotion 中的数据库 id-
filterboolean|object过滤条件false
sortsboolean|string|object[]排序条件false
imgToBase64boolean文档图片转 Base64false
catalogboolean|object目录信息配置false
limitnumber文档下载并发数3

Filter 字段说明

filter字段是为了筛选 Notion 数据库文档,表示哪些文章需要被 Elog 下载。

  1. filter=true ,即筛选数据库的status属性,且属性值为已发布,对应 Notion 的筛选规则为:

    json
    { 
      property: 'status',
      select: {
      	equals: '已发布'
    	}
    }
    
  2. filter = false时,不进行筛选,默认下载数据库所有文档

  3. 当需要自定义筛选时,需要按照Notion的筛选规则进行。具体请参考 Notion API文档 - Filter database entries

Sorts 字段说明

sorts字段是为了对 Notion 数据库文档进行排序,以便生成一定顺序的目录信息,对文档的同步不影响。

例如,使用 VitePress 部署文档时,需要对文档按照指定顺序和结构生成路由和 sidebar。

详情见 Elog Docs 文档源码

  1. Elog 提供了一些预设参数,如下。例如sorts=sortDesc即按照数据库的 sort 字段进行倒序排列

    typescript
    export const enum NotionSortPreset {
      /** 按自定义日期排序 */
      dateDesc = 'dateDesc', // 倒序
      dateAsc = 'dateAsc', // 升序
      /** 按创建时间排序 */
      createTimeDesc = 'createTimeDesc', // 倒序
      createTimeAsc = 'createTimeAsc', // 升序
      /** 按更新时间排序 */
      updateTimeDesc = 'updateTimeDesc', // 倒序
      updateTimeAsc = 'updateTimeAsc', // 升序
      /** 按数据库的sort字段进行排序 */
      sortDesc = 'sortDesc', // 倒序
      sortAsc = 'sortAsc', // 升序
    }
    
  2. sorts=true或者不填时,默认按照文档创建时间倒序进行排序。

  3. 当需要自定义排序时,需要按照Notion的筛选规则进行。具体请参考 Notion API文档 - Sort database entries

Catalog 字段说明

catalog字段是为了配置文档的目录信息,如果需要按照指定目录分类下载时,则需要进行配置,对文档的同步不影响。

  1. 默认值为false,即不记录文档的目录信息

  2. catalog=true,则表示按照数据库的catalog字段进行记录

  3. 当需要自定义属性时,则可按照以下格式进行配置

    javascript
    catalog = {
      enable: true,
      property: "自定义属性"
    }
    
  4. 当需要配置catalog字段时,请保证数据库有相关属性存在(支持单选/多选)

  5. catalog字段为单选时,只能生成一层目录

  6. catalog字段为多选时,可生成多级目录,但是需要保证标签的顺序

注意:对于Notion和FlowUs,想要开启按指定目录分类下载,还需要开启deploy.local.catalog=true

imgToBase64 字段说明

0.10.0及以上版本可用

谨慎开启,开启后,Notion 文档的所有图片将以 Base64 格式输出到 markdown 文档中,但有以下问题值得注意:

  1. 本地/博客平台的Markdown 渲染器并未广泛支持 Base64 格式,请自行确认
  2. markdown 文档将变大很多,文档可读性变差,特别是图片较多的情况下
  3. 一般适用于在博客平台的渲染,而不是本地备份时使用,本地备份请优先下载图片到本地或上传到图床

FlowUs(息流)

FlowUs 模版获取、关键信息获取及配置流程请移步 关键信息获取 页面。

字段必填类型说明默认值
tablePageIdstringflowus 中的多维表格ID-
filterboolean|object过滤条件false
sortboolean|string|object[]排序条件false
catalogboolean|object目录信息配置false
limitnumber文档下载并发数3

Filter 字段说明

filter字段是为了筛选 FlowUs 多维表文档,表示哪些文章需要被 Elog 下载。

  1. 默认值为false,即不过滤文档,全部下载

  2. 如果设置为true,会按照以下规则进行过滤

    javascript
    // 表示将按照多维表中的【status】字段进行过滤,保留所有【已发布】的文档
    filter = {
      property: 'status',
      value: '已发布',
    }
    
  3. 如果想自定义过滤文档,可以指定多维表的属性名称和值进行过滤。目前只支持逻辑,不支持逻辑

    javascript
    // 表示将按照多维表中的【status】字段进行过滤,保留所有【已发布】的文档
    filter = {
      property: "status"
      value: "已发布"
    }
    // 表示将按照多维表中的【status】和【tag】字段进行过滤,保留所有status=已发布 且 tag=技术方案的文档
    filter = [
    	{
    	  property: "status"
    	  value: "已发布"
    	}, {
    	  property: "tag"
    	  value: "技术方案"
    	}
    ]
    

sort 字段说明

sorts 字段是为了对 FlowUs 多维表文档进行排序,以便生成一定顺序的目录信息,对文档的同步不影响

例如,使用 VitePress 部署文档时,需要对文档按照指定顺序和结构生成路由和 sidebar。

  1. 默认值为false,不进行排序

  2. sort=true,会按照文档的创建时间倒序排列

  3. Elog 提供了一些预设参数,如下。例如sort=sortDesc即按照多维表中的 sort 字段进行倒序排列

    typescript
    export enum FlowUsSortPresetEnum {
      /** 按自定义日期排序 */
      dateDesc = 'dateDesc', // 倒序
      dateAsc = 'dateAsc', // 正序
      /** 按创建时间排序 */
      createTimeDesc = 'createTimeDesc', // 倒序
      createTimeAsc = 'createTimeAsc', // 正序
      /** 按更新时间排序 */
      updateTimeDesc = 'updateTimeDesc', // 倒序
      updateTimeAsc = 'updateTimeAsc', // 正序
      /** 按sort字段排序 */
      sortDesc = 'sortDesc', // 倒序
      sortAsc = 'sortAsc', // 正序
    }
    
  4. 如果需要自定义排序时,可以指定多维表的属性名称和值进行自定义排序。暂不支持多个排序条件

    typescript
    // 表示将按照多维表中的【sort】字段进行【倒序】排列
    sort = {
      property: "sort"
      direction: "descending" // descending:倒序, ascending:正序
    }
    

Catalog 字段说明

catalog字段是为了配置文档的目录信息,如果需要按照指定目录分类下载时,则需要进行配置,对文档的同步不影响

  1. 默认值为false,即不记录文档的目录信息

  2. catalog=true,则表示按照数据库的catalog字段进行记录

  3. 当需要自定义属性时,则可按照以下格式进行配置

    typescript
    catalog = {
      enable: true,
      property: "自定义属性"
    }
    
  4. 当需要配置catalog字段时,请保证数据库有相关属性存在(支持单选/多选)

  5. catalog字段为单选时,只能生成一层目录

  6. catalog字段为多选时,可生成多级目录,但是需要保证标签的顺序

注意:对于Notion和FlowUs,想要开启按指定目录分类下载,还需要开启deploy.local.catalog=true

飞书

0.9.0及以上版本支持知识库导出

飞书关键信息获取及配置流程请移步 关键信息获取 页面。

字段必填说明默认值
type从知识库下载(wiki)/我的空间(space)下载文档space
wikiId知识库ID-
folderToken目标文件夹token-
appId飞书自建应用appId-
appSecret飞书自建应用appSecret-
baseUrl飞书 api 请求地址,国内飞书无须配置,国际版飞书可配置为https://open.larksuite.com/open-apishttps://open.feishu.cn/open-apis
disableParentDoc是否忽略存在子文档的父文档,将其视作文件夹。0.12.1 及以上版本可用false
limit文档下载并发数3

字段说明

typespace(我的空间)时,folderToken为必填,表示从「我的空间」中的指定文件夹内下载文档。

typewiki(知识库)时,wikiId 为必填,folderToken可选,表示从指定知识库中的指定目录内下载文档,folderToken不填时,默认下载整个知识库。

type 不填时,默认为从我的空间下载,folderToken为必填字段

知识库与我的空间区别

「我的空间」中存在文件夹,文档可以放置在文件夹之下

「知识库」中不存在文件夹,但文档本身可以当做文件夹,文档下可以继续放置文档

当开启按目录存放文档 时,因为知识库中不存在文件夹概念,如果父文档下有子文档,会在本地生成父文档的同时,创建和父文档同名的文件夹,子文档会放在该文件夹之下。

0.12.1及以上版本可设置 disableParentDoc 属性,用来控制:当父文档下存在文档时,父文档是否作为文件夹使用

Untitled.png

例如:当disableParentDoc=false或不设置时,默认是将以上 6 个文档全部下载,会在本地生成父文档的同时,创建和父文档同名的文件夹,子文档会放在该文件夹之下。

disableParentDoc=true时,则只会下载「测试」和「四级文档」两篇文档。其他文档因为其children存在文档,会将其作为文件夹,下载到本地的「四级文档」会被放置在文件夹之中。

下一步

点击 下一篇 继续配置部署平台