yuque-hexo's Introduction

yuque-hexo

A downloader for articles from yuque

Usage

Premise

事先拥有一个 hexo 项目，在package.json配置相关信息，详见例子。

Config

package.json

{
  "name": "your hexo project",
  "yuqueConfig": {
    "baseUrl": "https://www.yuque.com/api/v2",
    "login": "yinzhi",
    "repo": "blog",
    "mdNameFormat": "title",
    "postPath": "source/_posts/yuque"
  }
}

"mdNameFormat": 生成的 Markdown 文件的文件名，可以选择 "title" 或者 "slug"，默认 "title"，slug 是语雀的永久链接名，一般是几个随机字母。

"postPath": 存放从语雀下载的 Markdown 文件的文件夹，除了 Hexo ，理论上可以支持其他支持 Front-matter 的 Markdown 静态博客

Install

npm i -g yuque-hexo
# or
npm i --save-dev yuque-hexo

Sync

yuque-hexo sync

Clean

yuque-hexo clean

Npm Scripts

{
  "dev": "npm run sync && hexo s",
  "sync": "yuque-hexo sync",
  "clean:yuque": "yuque-hexo clean"
}

Debug

DEBUG=yuque-hexo.* yuque-hexo sync

Notice

语雀同步过来的文章会生成两部分文件；
- yuque.json: 从语雀 API 拉取的数据
- source/_posts/yuque/*.md: 生成的 md 文件
支持配置front-matter, 语雀编辑器编写示例如下:
- 语雀编辑器示例，可参考原文：语雀编辑器转换成的markdown 如下（已做兼容）：
```
  tags: [hexo, node]<br />date: 2018-06-09<br />categories: 前端

  ---
```
- 标准 markdown 示例：
```
  date: 2015-04-18 00:00:00
  tags: [css]
  categories: CSS 
  ---
```
注意：分割线不能少，兼容一个或多个属性的自定义