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

第七步:

第八步:

如果工作流失败:

相关推荐
想你依然心痛4 小时前
我的第一个开源项目:从0到1,我在GitHub写下的成长印记
开源·github
查老师7 小时前
人在上班,突然被开源社区用户点名不要脸?我想问你,你给我刷过几个子儿?
后端·开源·github
lpfasd1238 小时前
当 GitHub 宕机时,我们如何协作?
github
放飞自我的Coder10 小时前
【github-action 如何为github action设置secrets/environment】
github·action
绝无仅有11 小时前
编写 Go 项目的 Dockerfile 文件及生成 Docker 镜像
后端·面试·github
绝无仅有11 小时前
使用 Docker 部署 Go 项目(Beego 框架)
后端·面试·github
星哥说事12 小时前
开源轻量级表格革命——用Teable解锁你的数据管理新姿势
github
悟空聊架构13 小时前
从 0 到 1:Jenkins 对接企微机器人避坑指南(附可下载 Pipeline 模板)
后端·架构·github
HelloGitHub13 小时前
直击痛点的开源项目「GitHub 热点速览」
开源·github
超级小忍1 天前
深入解析 GitHub Actions 工作流文件编写:从入门到实战
github