Skip to content

Commit 4638956

Browse files
author
Jay Hsueh
committed
refactor: Update project to use VitePress, replacing VuePress; modify package.json scripts, add deployment workflow, and update documentation structure
1 parent 3475bf7 commit 4638956

33 files changed

Lines changed: 33024 additions & 7985 deletions

.github/workflows/deploy-docs.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Deploy VitePress site to Pages
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- 'docs/**'
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: pages
17+
cancel-in-progress: false
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0
26+
27+
- uses: pnpm/action-setup@v4
28+
29+
- uses: actions/setup-node@v4
30+
with:
31+
node-version: 20
32+
cache: pnpm
33+
34+
- run: pnpm install --frozen-lockfile
35+
36+
- run: pnpm build
37+
working-directory: docs
38+
39+
- uses: actions/configure-pages@v4
40+
41+
- uses: actions/upload-pages-artifact@v3
42+
with:
43+
path: docs/.vitepress/dist
44+
45+
deploy:
46+
environment:
47+
name: github-pages
48+
url: ${{ steps.deployment.outputs.page_url }}
49+
needs: build
50+
runs-on: ubuntu-latest
51+
steps:
52+
- id: deployment
53+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
node_modules
2-
docs/.vuepress/dist
2+
docs/.vitepress/dist
33
.vscode
44
.DS_Store
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{
2+
"hash": "bf73bfa3",
3+
"configHash": "84c0ce0d",
4+
"lockfileHash": "159ad52b",
5+
"browserHash": "fa094d08",
6+
"optimized": {
7+
"vue": {
8+
"src": "../../../../node_modules/.pnpm/vue@3.5.30/node_modules/vue/dist/vue.runtime.esm-bundler.js",
9+
"file": "vue.js",
10+
"fileHash": "59e95a11",
11+
"needsInterop": false
12+
},
13+
"vitepress > @vue/devtools-api": {
14+
"src": "../../../../node_modules/.pnpm/@vue+devtools-api@8.1.0/node_modules/@vue/devtools-api/dist/index.js",
15+
"file": "vitepress___@vue_devtools-api.js",
16+
"fileHash": "3141e658",
17+
"needsInterop": false
18+
},
19+
"vitepress > @vueuse/core": {
20+
"src": "../../../../node_modules/.pnpm/@vueuse+core@14.2.1_vue@3.5.30/node_modules/@vueuse/core/dist/index.js",
21+
"file": "vitepress___@vueuse_core.js",
22+
"fileHash": "6cc90de2",
23+
"needsInterop": false
24+
},
25+
"vitepress > @vueuse/integrations/useFocusTrap": {
26+
"src": "../../../../node_modules/.pnpm/@vueuse+integrations@14.2.1_focus-trap@7.8.0_vue@3.5.30/node_modules/@vueuse/integrations/dist/useFocusTrap.js",
27+
"file": "vitepress___@vueuse_integrations_useFocusTrap.js",
28+
"fileHash": "8dffa45e",
29+
"needsInterop": false
30+
},
31+
"vitepress > mark.js/src/vanilla.js": {
32+
"src": "../../../../node_modules/.pnpm/mark.js@8.11.1/node_modules/mark.js/src/vanilla.js",
33+
"file": "vitepress___mark__js_src_vanilla__js.js",
34+
"fileHash": "24750055",
35+
"needsInterop": false
36+
},
37+
"vitepress > minisearch": {
38+
"src": "../../../../node_modules/.pnpm/minisearch@7.2.0/node_modules/minisearch/dist/es/index.js",
39+
"file": "vitepress___minisearch.js",
40+
"fileHash": "29eb30d6",
41+
"needsInterop": false
42+
}
43+
},
44+
"chunks": {
45+
"chunk-J334NHAN": {
46+
"file": "chunk-J334NHAN.js"
47+
},
48+
"chunk-7V3IUMCS": {
49+
"file": "chunk-7V3IUMCS.js"
50+
}
51+
}
52+
}

0 commit comments

Comments
 (0)