Vitepress部署到GitHub Pages,工作流

效果:

 第一步:

部署 VitePress 站点 | VitePress

执行 npm run docs:build,npm run docs:preview,生成dist文件

 

第二步:

手动创建.gitignore文件:

node_modules

.DS_Store

dist-ssr

cache

.cache

.temp

*.local

第三步:

使用npm install命令创建package-lock.json文件

第四步;

config.mts文件中添加base,仓库名称

第五步:

去github,名称一致(这个不确定哈)

 

在编辑器一一执行,

 

第六步:

 

 

 

第7步:

填入代码。说明一下,  path: doc/.vitepress/dist这里需要看实际的是什么,例如:

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

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

  # 允许你从 Actions 选项卡手动运行此工作流程
  workflow_dispatch:

# 设置 GITHUB_TOKEN 的权限,以允许部署到 GitHub Pages
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@v4
        with:
          fetch-depth: 0 # 如果未启用 lastUpdated,则不需要
      # - uses: pnpm/action-setup@v3 # 如果使用 pnpm,请取消注释
      # - uses: oven-sh/setup-bun@v1 # 如果使用 Bun,请取消注释
      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 18
          cache:  yarn
      - name: Setup Pages
        uses: actions/configure-pages@v4
      - name: Install dependencies
        run:  yarn install
      - name: Build with VitePress
        run:  yarn docs:build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: 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@v4

 第七步:

 

第八步:

 

 

如果工作流失败:

 

相关推荐

  1. 一个好用的文档部署工具-VitePress

    2024-04-01 09:48:02       20 阅读

最近更新

  1. TCP协议是安全的吗?

    2024-04-01 09:48:02       18 阅读
  2. 阿里云服务器执行yum,一直下载docker-ce-stable失败

    2024-04-01 09:48:02       19 阅读
  3. 【Python教程】压缩PDF文件大小

    2024-04-01 09:48:02       19 阅读
  4. 通过文章id递归查询所有评论(xml)

    2024-04-01 09:48:02       20 阅读

热门阅读

  1. C++经典面试题目(十五)

    2024-04-01 09:48:02       16 阅读
  2. 微信小程序(3.3.5) 对实时帧数据调速

    2024-04-01 09:48:02       16 阅读
  3. 微信小程序——wxss和css的区别

    2024-04-01 09:48:02       19 阅读
  4. uView内置样式

    2024-04-01 09:48:02       15 阅读
  5. Github2024-03-31 开源项目日报 Top10

    2024-04-01 09:48:02       17 阅读
  6. GitHub常用命令

    2024-04-01 09:48:02       16 阅读
  7. 量化交易入门(三十五)回测框架backtrader-Strategy

    2024-04-01 09:48:02       19 阅读
  8. three.js昼夜切换,白天黑夜的实现(含源码)

    2024-04-01 09:48:02       17 阅读
  9. python_2

    python_2

    2024-04-01 09:48:02      18 阅读