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

第七步:

第八步:

如果工作流失败:

相关推荐
OpenTiny社区10 小时前
从零开发 AI 聊天页要两周?试试这款 Vue3 垂直对话组件库 TinyRobot,直接开箱即用
前端·vue.js·github
逛逛GitHub11 小时前
2 万多 Star!Google 开源了这个神级 GitHub 项目。
github
逛逛GitHub12 小时前
免费 Token 烧掉 5 万亿之后,他们出了个一站式创作平台。
github
用户8055336980313 小时前
RK-Forge外设系列开篇 - 把板子从「能启动」变成「能用」:Ethernet/SPI/MMC 三个纯接线外设
linux·github·嵌入式
inhere13 小时前
eget:不用等中央仓库,直接安装 GitHub 和任意下载站的工具
程序员·开源·github
YuePeng1 天前
写了五年注解的低代码框架,2.0 决定让你连注解都不用写了
github·产品
小白ai1 天前
从"能 ping 通吗"到"为什么上不了网"——我写了一个网络故障诊断引擎
github
徐小夕1 天前
jitword 协同文档3.2发布:打造浏览器中最强word编辑器
前端·架构·github
齐翊2 天前
分享一个在 Claude Code 里 [同时] 用多个 ApiKey 的方法
程序员·github·agent
A_Lonely_Cat2 天前
记一次 GitHub 幽灵协作者大清洗:强制重写 Git 历史与穿透 CDN 缓存实践
git·github