Quexo NPM | npm.io

quexo

A downloader for articles from yuque（语雀知识库同步到hexo工具）

Premise

事先拥有一个 hexo 项目，并在 package.json 中配置相关信息，可参考例子。

Config

配置 TOKEN

处于对安全性的考虑，在使用第三方API访问知识库和COS时需要将token传入环境变量语雀token获取方式：在语雀上点击个人头像 -> 设置 -> Token 即可获取。传入 YUQUE_TOKEN 到 quexo 的进程有两种方式：腾讯云: 控制台 -> 对象存储 -> 密钥管理 -> 点击「云 API 密钥」获取

设置全局的环境变量

命令执行时传入环境变量
- mac / linux: YUQUE_TOKEN=xxx COS_SECRETID=xxx COS_SECRETKEY=xxx quexo sync
- windows: set YUQUE_TOKEN=xxx YUQUE_TOKEN=xxx COS_SECRETID=xxx COS_SECRETKEY=xxx && quexo sync

配置知识库

quexo.config.js

module.exports = {
  login: "jianjunxie",
  repo: "kb",
  mdNameFormat: "title",
  postPath: "source/_posts/yq",
  imageLocalPath: "source/images/post",
  saveImage: "cos",
  cos: {
    bucket: "桶名",
    region: "地域",
    prefix: "post/",
    url: "桶的访url",
  },
};

参数名	含义	默认值
postPath	文档同步后生成的路径	source/_posts/yuque
cachePath	文档下载缓存文件	yuque.json
mdNameFormat	文件名命名方式 (title / slug)	title
adapter	文档生成格式 (hexo/markdown)	hexo
concurrency	下载文章并发数	5
baseUrl	语雀 API 地址	-
login	语雀 login (group), 也称为个人路径	-
repo	语雀仓库短名称，也称为语雀知识库路径	-
onlyPublished	只展示已经发布的文章	false
onlyPublic	只展示公开文章	false
saveImage	是否将图片保存到指定位置	可选值：undefined/cos/local，默认undefined
imageLocalPath	保存本地图片路径	source/images
cos	保存图片到腾讯云COS	undefined

slug 是语雀的永久链接名，一般是几个随机字母。

Install

npm i -g quexo
# or
npm i --save-dev quexo

Sync

quexo sync

Clean

quexo clean

Npm Scripts

{
  "sync": "quexo sync",
  "clean:yuque": "quexo clean"
}

Debug

DEBUG=quexo.* quexo sync

Best practice

Notice

语雀同步过来的文章会生成两部分文件；
- yuque.json: 从语雀 API 拉取的数据
- source/_posts/yuque/*.md: 生成的 md 文件

支持配置 front-matter, 语雀编辑器编写示例如下:

语雀编辑器示例，可参考原文

tags: [hexo, node]
categories: [fe]
cover: https://cdn.nlark.com/yuque/0/2019/jpeg/155457/1546857679810-d82e3d46-e960-419c-a715-0a82c48a2fd6.jpeg#align=left&display=inline&height=225&name=image.jpeg&originHeight=225&originWidth=225&size=6267&width=225

---

some description

<!-- more -->

more detail