github-pages.md

title
在 GitHub Pages 上部署 Hexo

本文將使用 GitHub Actions 部屬至 GitHub Pages，此方法適用於公開或私人儲存庫。若你不希望將整個資料夾推上 GitHub，請參閱 一鍵部屬。

1. 建立名為 username.github.io 的儲存庫，username 是你在 GitHub 上的使用者名稱，若之前已將 Hexo 上傳至其他儲存庫，將該儲存庫重命名即可。
2. 將 Hexo 檔案 push 到儲存庫的預設分支，預設分支通常名為 main，舊一點的儲存庫可能名為 master。

• 將 main 分支 push 到 GitHub：

  $ git push -u origin main
  

• 預設情況下 public/ 不會被上傳(也不該被上傳)，確認 .gitignore 檔案中包含一行 public/。整體資料夾結構應會與範例儲存庫極為相似。

3. 使用 node --version 指令檢查你電腦上的 Node.js 版本，並記下該版本 (例如：v16.y.z)
4. 在儲存庫中建立 .github/workflows/pages.yml，並填入以下內容 (將 16 替換為上個步驟中記下的版本)：

name: Pages

on:
  push:
    branches:
      - main  # default branch

jobs:
  pages:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          # If you have other token like `ssh-key`, please check the usage of this action: https://github.com/actions/checkout#usage
          token: ${{ secrets.DEPLOY_TOKEN }}
          # If your repository depends on submodule, please see: https://github.com/actions/checkout
          submodules: recursive
      - name: Use Node.js 16.x
        uses: actions/setup-node@v2
        with:
          node-version: '16'
      - name: Cache NPM dependencies
        uses: actions/cache@v2
        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: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          # Please check the supported token here: https://github.com/peaceiris/actions-gh-pages#supported-tokens
          github_token: ${{ secrets.DEPLOY_TOKEN }}
          publish_dir: ./public

5. 當部屬作業完成後，產生的頁面會放在儲存庫中的 gh-pages 分支。
6. 在儲存庫中前往 Settings > Pages > Source，並將 branch 改為 gh-pages。
7. 前往 username.github.io 查看網站。

{% note info CNAME %} 若你使用 CNAME 自訂域名，你需要在 source/ 資料夾中新增 CNAME 檔案。更多資訊 {% endnote %}

專案頁面

如果你希望網站部署在 <你的 GitHub 用戶名>.github.io 的子目錄中：

1. 開啟你在 GitHub 的儲存庫，並前往 Settings 頁面。更改你的 Repository name 使你的部落格網址變成 username.github.io/repository，repository 可以是任何名稱，例如 blog 或 hexo。
2. 編輯你的 _config.yml，將 url: 更改為 https://username.github.io/repository。
3. Commit 並 push 到預設分支上。
4. 當部屬完成後，在 gh-pages 分支可以找到產生的網頁。
5. 在 GitHub 儲存庫中，前往 Settings > Pages > Source，並將 branch 改為 gh-pages 後儲存。
6. 前往 username.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

3. 執行 hexo clean && hexo deploy 。
4. 瀏覽 <GitHub 用戶名>.github.io 檢查你的網站能否運作。

{% note info Windows 用戶 %} Awesome Hexo 中收錄了更多有關在 GitHub Pages 上部署 Hexo ，你也可透過搜尋引擎了解更多。 歡迎更多有誌之士前來改善 Hexo 文檔，不勝感激。 {% endnote %}

參考連結

• GitHub Pages 使用文檔
• peaceiris/actions-gh-pages