填写 Token

• Settings -> Developer settings -> Personal access tokens -> Tokens(classic)

• Generate new token -> Generate new token(classic)

• 权限选择 repo、read:repo_hook、delete_repo 后生成

• 打开项目的 setting -> Secrets -> Actions -> New respository -> secret

• 将获取的 token 填入

编写 Action

• 在项目的 Actions 中点击 New workflow 来创建新的工作流

• 点击 set up a workflow yourself 并填入以下内容

  name: Pages
  on:
    push:
      branches: [ "main" ]
    workflow_dispatch:
  jobs:
    build:
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v3
        - name: Build
          run: npm install && npm run docs:build
        - name: Deploy
          uses: JamesIves/github-pages-deploy-action@releases/v3
          with:
            ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} # 生成的 secret
            BRANCH: gh-pages # 部署到 gh-pages 分支
            FOLDER: docs/.vuepress/dist # vuepress 生成的静态文件存放的地方
  

推送

• 库新建 gh-pages 分支

• 开启 Pages 服务，Branch 选择 gh-pages，路径选择根路径

• 将项目库中的文件推送至主分支

• 请确保 package-lock.json、package.json 两份文件在根目录

• 仓库结构参考

  📦 VuePress                # 仓库名
  ├── 📂 .github/workflows   # Action 文件
  ├── 📂 docs                # 文档
  ├── 📜 package-lock.json
  ├── 📜 package.json
  └── 📜 README.md