Skip to content

网站部署


up:AZ_Channel

作品

up:正心全栈编程

作品

vitepress部署

使用版本

npm --version

10.5.0

node --version

v20.12.2

vitepress官网

可以选择不同的包管理工具(npm和pnpm都是Node.js的包管理器)由于我使用的npm,因此deploy.yml参考的 部署博客

首先在Settings-Pages-Branch-Select branch选中gh-pages,设置分支,然后new workflow(新建工作流)创建文件deploy.yml然后commit,个人理解这个就是在Github上执行运行项目的命令,不过有几处需要改动一下

  1. 文件中3处@v3被我修改为@v4
  2. node-version改为20
  3. publish_dir修改路径删除了博客中的docs/
yaml
# .github > workflows > deploy.yml
name: Deploy

on:
   push:
      branches:
         - master

jobs:
   deploy:
      runs-on: ubuntu-latest
      steps:
         - uses: actions/checkout@v4
           with:
              fetch-depth: 0
         - uses: actions/setup-node@v4
           with:
              node-version: 20
              cache: npm
         - run: npm install --frozen-lockfile

         - name: Build
           run: npm run docs:build

         - name: Deploy
            # 将构建产物 commit 到一个分支上,用于发布静态站点资源
            # https://github.com/peaceiris/actions-gh-pages
            #不要将peaceiris改为自己的仓库名,我单纯的以为这个需要改成自己的仓库名,部署上去就build失败了,需引用该仓库的配置
           uses: peaceiris/actions-gh-pages@v4
           with:
              # Github 会在 workflow 中自动生成 GIHUBT_TOKEN,用于认证 workflow 的运行
              github_token: ${{ secrets.GITHUB_TOKEN }}
              # 静态资源目录设置,如果你没有在.vitepress前面额外建立一个文件夹的话
              publish_dir: .vitepress/dist
              # 默认发布到 gh-pages 分支上,可以指定特定的发布分支(不能选拉取代码的分支)
              publish_branch: gh-pages
              full_commit_message: ${{ github.event.head_commit.message }}