A downloader for articles from yuque
事先拥有一个 hexo 项目,在package.json
配置相关信息,详见 例子。
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 静态博客
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
-
语雀同步过来的文章会生成两部分文件;
- 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 处理格式问题