A downloader for articles from yuque
事先拥有一个 hexo 项目，在package.json配置相关信息，详见 例子。
package.json
{
"name": "your hexo project",
"yuqueConfig": {
"postPath": "source/_posts/yuque",
"cachePath": "yuque.json",
"adapter": "hexo",
"concurrency": 5,
"baseUrl": "https://www.yuque.com/api/v2",
"login": "yinzhi",
"repo": "blog",
"mdNameFormat": "title",
}
}| 参数名 | 含义 | 默认值 |
|---|---|---|
| postPath | 文档同步后生成的路径 | source/_posts/yuque |
| cachePath | 文档下载缓存文件 | yuque.json |
| mdNameFormat | 文件名命名方式 (title / slug) | title |
| adapter | 文档生成格式 (hexo/markdown) | hexo |
| concurrency | 下载文章并发数 | 5 |
| baseUrl | 语雀 API 地址 | - |
| login | 语雀 login (group) | - |
| repo | 语雀仓库短名称 | - |
slug 是语雀的永久链接名，一般是几个随机字母。
npm i -g yuque-hexo
# or
npm i --save-dev yuque-hexo
yuque-hexo sync
yuque-hexo clean
{
"dev": "npm run sync && hexo s",
"sync": "yuque-hexo sync",
"clean:yuque": "yuque-hexo clean"
}DEBUG=yuque-hexo.* yuque-hexo sync
提供了一个触发 Travis CI 构建的 HTTP API 接口，详情请查看文档 (请勿恶意使用)
- 语雀同步过来的文章会生成两部分文件；
- 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
---注意：分割线不能少，兼容一个或多个属性的自定义
https://github.com/x-cold/blog/blob/master/package.json
- 支持 hexo-front-matter，可以在文章中编辑 tags / date 等属性
- 修复 windows 环境下命令行报错的问题
- 支持自定义文件夹和博客文件命名
- 修复 front-matter 处理格式问题
- 升级项目架构，增强扩展性，支持自定义 adpter
- 支持纯 markdown 导出
- 支持请求并发数量参数
concurrency