部署 VitePress 网站

部署 VitePress 的详细内容请阅读 [官方手册]

GitHub Pages

在项目的 .github/workflows 目录中创建一个名为 deploy.yml 的文件，其中包含如下内容：

yml

# 构建VitePress站点并将其部署到GitHub Pages的示例工作流
name: deploy tutorial site to GitHub Pages

on:
  # 在针对“main”分支的推送上运行。如果使用“master”分支作为默认分支，请将其更改为“master”。
  push:
    branches: [main]

  # 允许您从“操作”选项卡手动运行此工作流
  workflow_dispatch:

# 设置GITHUB_TOKEN的权限以允许部署到GITHUB页面
permissions:
  contents: read
  pages: write
  id-token: write

# 只允许一次并发部署，跳过在进行中的运行和最近排队的运行之间排队的运行。
# 但是，不要取消正在进行的运行，因为我们希望完成这些生产部署。
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  # 构建工作
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0 # 如果未启用lastUpdated，则不需要
      # 如果使用pnpm，请取消注释
      - uses: pnpm/action-setup@v2
        name: Install pnpm
        id: pnpm-install
        with:
          version: 8.8.0
          run_install: false
      # - uses: oven-sh/setup-bun@v1 # 如果您使用Bun，请取消注释
      - name: Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: pnpm # 或 npm / yarn
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Install dependencies
        run: pnpm install # 或 npm ci / yarn install / bun install
      - name: Build with VitePress
        run: |
          pnpm install --no-frozen-lockfile
          pnpm build # pnpm docs:build or npm run docs:build / yarn docs:build / bun run docs:build
          touch .vitepress/dist/.nojekyll # 子目录下是 doc/.vitepress/dist/.nojekyll
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: .vitepress/dist # 子目录下是 doc/.vitepress/dist

  # 部署工作
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    needs: build
    runs-on: ubuntu-latest
    name: Deploy
    steps:
      - name: deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2

TIP

确保 VitePress 中的 base 选项已正确配置。有关更多详细信息，请参见设置公共基路径。

在“Pages”菜单项下的存储库设置中，选择“Build and deployment Source”中的“GitHub Actions”。
将您的更改推送到 main 分支，并等待 GitHub Actions 工作流完成。您应该看到您的站点部署到 https://<username>.github.io/[repository]/或 https://<custom-domain>/，具体取决于您的设置。您的网站将在每次推送到 main 分支时自动部署。

部署 VitePress 网站 ​

GitHub Pages ​

部署 VitePress 网站

GitHub Pages