Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update deploy.md #3281

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update deploy.md #3281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 16 additions & 9 deletions docs/guide/deploy.md
View file
Open in desktop
@@ -1,13 +1,16 @@
---
outline: deep

---

# Deploy Your VitePress Site

The following guides are based on some shared assumptions:

- The VitePress site is inside the `docs` directory of your project.

- You are using the default build output directory (`.vitepress/dist`).

- VitePress is installed as a local dependency in your project, and you have set up the following scripts in your `package.json`:

```json
Expand Down Expand Up @@ -125,28 +128,28 @@ Don't enable options like _Auto Minify_ for HTML code. It will remove comments f
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
Expand All @@ -162,20 +165,24 @@ Don't enable options like _Auto Minify_ for HTML code. It will remove comments f
uses: actions/setup-node@v3
with:
node-version: 18
cache: npm # or pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v3
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Install dependencies
run: npm ci # or pnpm install / yarn install / bun install
run: pnpm install # or npm install / yarn install / bun install
- name: Build with VitePress

run: |
npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
pnpm docs:build
touch docs/.vitepress/dist/.nojekyll
# or npm run docs:build / yarn docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: docs/.vitepress/dist

# Deployment job
deploy:
environment:
Expand Down