同步语雀的文章到你的 Hexo 项目吧!
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
command
lib
test
.eslintignore
.eslintrc
.gitignore
.travis.yml
LICENSE
README.md
appveyor.yml
index.js
package.json

README.md

yuque-hexo

NPM version build status Test coverage David deps Known Vulnerabilities npm download

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 文件

Example

https://github.com/x-cold/blog/blob/master/package.json

Changelog

v1.1.1

  • 支持 hexo-front-matter,可以在文章中编辑 tags / date 等属性

v1.2.1

  • 修复 windows 环境下命令行报错的问题
  • 支持自定义文件夹和博客文件命名