saber-plugin-yuque

Introduction

Yuque is a note and document service, this plugin uses its REST API to inject Yuque documents as pages into your Saber app.

Note that it's not very user-friendly for non-Chinese users :sweat_smile: Since non-Chinese users won't use it anyway, I'll document this plugin in Chinese.

把语雀知识库文档转换成 Saber 里的页面。

Install

npm i saber-plugin-yuque

Usage

In saber-config.yml:

plugins:
  - resolve: saber-plugin-yuque
    options:
      # 用户名/知识库缩略名
      book: egoist/til
  # 配合 saber-plugin-query-posts 使用
  - resolve: saber-plugin-query-posts

当 API 访问受限时需要设置语雀 API 访问密钥到环境变量 process.env.YUQUE_TOKEN。

这个插件会把相关知识库里的文档插入到 pages 中，这样 saber-plugin-query-posts 就能获取到并将其作为插入到你所需要的的页面里，在相关页面组件上你就可以通过 this.page.posts 获取到。这个插件支持所有支持 saber-plugin-query-posts 的主题。

插入的文档的结构：

| 属性 | 类型 | 描述 | | ----------- | -------- | -------------------- | | title | string | 文档标题 | | createdAt | Date | 文档创建日期 | | updatedAt | Date | 文档更新日期 | | excerpt | string | 文档摘要 | | wordCount | number | 字数统计 | | layout | 'post' | 要使用的 layout 组件 | | permalink | string | 页面永久链接 | | slug | string | 文档缩略名 |

License

MIT © EGOIST