在 GitHub Pages 上部署 Hexo

本文将使用 GitHub Actions 部署至 GitHub Pages，此方法适用于公开或私人储存库。若你不希望将源文件夹上传到 GitHub，请参阅 一键部署。

  1. 建立名为 <你的 GitHub 用户名>.github.io 的储存库，若之前已将 Hexo 上传至其他储存库，将该储存库重命名即可。
  2. 将 Hexo 文件夹中的文件 push 到储存库的默认分支，默认分支通常名为 main，旧一点的储存库可能名为 master。

  • 将 main 分支 push 到 GitHub：

    $ git push -u origin main

  • 默认情况下 public/ 不会被上传(也不该被上传)，确保 .gitignore 文件中包含一行 public/。整体文件夹结构应该与 示例储存库 大致相似。

  1. 使用 node --version 指令检查你电脑上的 Node.js 版本，并记下该版本 (例如：v20.y.z)
  2. 在储存库中前往 Settings > Pages > Source，并将 Source 改为 GitHub Actions。
  3. 在储存库中建立 .github/workflows/pages.yml，并填入以下内容 (将 20 替换为上个步骤中记下的版本)：
.github/workflows/pages.yml
name: Pages

on:
  push:
    branches:
      - main  # default branch

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          # If your repository depends on submodule, please see: https://github.com/actions/checkout
          submodules: recursive
      - name: Use Node.js 20
        uses: actions/setup-node@v4
        with:
          # Examples: 20, 18.19, >=16.20.2, lts/Iron, lts/Hydrogen, *, latest, current, node
          # Ref: https://github.com/actions/setup-node#supported-version-syntax
          node-version: '20'
      - name: Cache NPM dependencies
        uses: actions/cache@v4
        with:
          path: node_modules
          key: ${{ runner.OS }}-npm-cache
          restore-keys: |
            ${{ runner.OS }}-npm-cache
      - name: Install Dependencies
        run: npm install
      - name: Build
        run: npm run build
      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./public
  deploy:
    needs: build
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
  1. 部署完成后，前往 https://<你的 GitHub 用户名>.github.io 查看网站。
CNAME

若你使用了一个带有 CNAME 的自定义域名，你需要在 source/ 文件夹中新增 CNAME 文件。 更多信息

项目页面

如果你希望网站部署在 <你的 GitHub 用户名>.github.io 的子目录中：

  1. 建立名为 <repository 的名字> 的储存库，这样你的博客网址为 <你的 GitHub 用户名>.github.io/<repository 的名字>，repository 的名字可以任意，例如 blog 或 hexo。
  2. 编辑你的 _config.yml，将 url: 更改为 <你的 GitHub 用户名>.github.io/<repository 的名字>。
  3. 在储存库中前往 Settings > Pages > Source，并将 Source 改为 GitHub Actions。
  4. Commit 并 push 到默认分支上。
  5. 部署完成后，前往 https://<你的 GitHub 用户名>.github.io/<repository 的名字> 查看网站。

一键部署

以下教学改编自 一键部署。

  1. 安装 hexo-deployer-git。
  2. 在 _config.yml 中添加以下配置（如果配置已经存在，请将其替换为如下）:
deploy:
  type: git
  repo: https://github.com/<username>/<project>
  # example, https://github.com/hexojs/hexojs.github.io
  branch: gh-pages
  1. 执行 hexo clean && hexo deploy 。
  2. 浏览 <GitHub 用户名>.github.io 检查你的网站能否运作。
Windows 用户

Awesome Hexo 中收录了更多有关在 GitHub Pages 上部署 Hexo ，你也可通过搜索引擎了解更多。
欢迎更多有志之士前来改善 Hexo 文档，不胜感激。

参考链接