Yuque-Hexo 同步工具使用指南

Yuque-Hexo 同步工具使用指南

yuque-hexo同步语雀的文章到你的 Hexo 项目吧！项目地址:https://gitcode.com/gh_mirrors/yu/yuque-hexo

本文档将详细介绍如何安装并使用 Yuque-Hexo 开源项目，这是一款帮助您将语雀上的文章同步到 Hexo 项目的工具。

1. 项目目录结构及介绍

├── adapter       # 适配器相关代码
├── bin            # 包含可执行脚本
├── command        # 命令处理相关代码
├── lib            # 核心功能库
├── test           # 测试用例
└── util           # 辅助工具函数

• adapter: 存放与语雀API交互的适配器代码。
• bin: 包含可以执行的脚本，如 yuque-hexo。
• command: 定义命令行接口及其处理逻辑。
• lib: 提供核心同步功能的代码库。
• test: 对项目进行单元测试的代码。
• util: 一些辅助的工具函数。

2. 项目的启动文件介绍

项目的启动文件位于 bin 目录下的 yuque-hexo 脚本。这个脚本是通过Node.js环境调用的，用于初始化和运行同步操作。在终端中，你可以直接输入 yuque-hexo <命令> 来执行相应的功能，例如 sync 或 clean。

3. 项目的配置文件介绍

Yuque-Hexo 配置主要依赖于环境变量和Hexo项目中的package.json配置。以下是关键配置项：

• YUQUE_TOKEN: 为了访问语雀知识库，你需要设置环境变量 YUQUE_TOKEN。可以通过语雀个人设置->Token来获取它。

• Hexo配置：确保你的 package.json 文件中包含了 yuque-hexo 的依赖，并且在 scripts 部分定义了相关的部署命令。例如：

  {
    "name": "your-hexo-blog",
    "version": "0.0.1",
    "scripts": {
      "sync-yuque": "yuque-hexo clean && yuque-hexo sync"
    },
    "dependencies": {
      "yuque-hexo": "^版本号"
    }
  }
  

要启动同步，只需在项目根目录下运行 npm run sync-yuque。

示例配置

环境变量设置 (Unix-like系统)

export YUQUE_TOKEN=<your_yuque_token>

或在执行命令时传递：

YUQUE_TOKEN=<your_yuque_token> npm run sync-yuque

GitHub Actions自动化

若要在GitHub Actions中自动化同步，可以在.github/workflows文件夹内创建一个新的YAML文件，添加类似以下内容：

name: Sync Yuque to Hexo
on: schedule
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '12'
      - name: Checkout code
        uses: actions/checkout@v3
      - name: Cache dependencies
        uses: actions/cache@v2
        with:
          path: node_modules
          key: ${{ runner.os }}-hexo-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-hexo-
      - name: Configure Git
        run: |
          git config --global user.email "你的邮箱"
          git config --global user.name "你的用户名"
      - name: Run Yuque-Hexo
        run: |
          npm install
          npm run sync-yuque
      - name: Commit Changes
        run: |
          git add .
          git commit -m "Update from Yuque"
      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

以上就是关于Yuque-Hexo项目的基本目录结构、启动文件和配置说明。请根据自身需求定制配置，并确保所有依赖已经正确安装，以便顺利进行文章的同步。

yuque-hexo同步语雀的文章到你的 Hexo 项目吧！项目地址:https://gitcode.com/gh_mirrors/yu/yuque-hexo