Skip to content

Commit 23c3c49

Browse files
committed
chore: 添加github文档发布工作流
1 parent ad05954 commit 23c3c49

File tree

8 files changed

+107
-4
lines changed

8 files changed

+107
-4
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# 构建 文档站点工作流
2+
#
3+
name: Deploy docs site to Pages
4+
5+
on:
6+
# 在针对 `main` 分支的推送上运行。如果你
7+
# 使用 `master` 分支作为默认分支,请将其更改为 `master`
8+
push:
9+
branches: [main]
10+
11+
# 允许你从 Actions 选项卡手动运行此工作流程
12+
workflow_dispatch:
13+
14+
# 设置 GITHUB_TOKEN 的权限,以允许部署到 GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# 只允许同时进行一次部署,跳过正在运行和最新队列之间的运行队列
21+
# 但是,不要取消正在进行的运行,因为我们希望允许这些生产部署完成
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# 构建工作
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
with:
34+
fetch-depth: 0 # 如果未启用 lastUpdated,则不需要
35+
- uses: pnpm/action-setup@v3 # 如果使用 pnpm,请取消此区域注释
36+
with:
37+
version: 10
38+
# - uses: oven-sh/setup-bun@v1 # 如果使用 Bun,请取消注释
39+
- name: Setup Node
40+
uses: actions/setup-node@v4
41+
with:
42+
node-version: 22
43+
cache: pnpm # 或 pnpm / yarn
44+
- name: Setup Pages
45+
uses: actions/configure-pages@v4
46+
- name: Install dependencies
47+
run: pnpm install # 或 pnpm install / yarn install / bun install
48+
- name: Build with VitePress and Rspress
49+
run: pnpm build:docs # 或 pnpm docs:build / yarn docs:build / bun run docs:build
50+
- name: Upload artifact
51+
uses: actions/upload-pages-artifact@v3
52+
with:
53+
path: docs/dist
54+
55+
# 部署工作
56+
deploy:
57+
environment:
58+
name: github-pages
59+
url: ${{ steps.deployment.outputs.page_url }}
60+
needs: build
61+
runs-on: ubuntu-latest
62+
name: Deploy
63+
steps:
64+
- name: Deploy to GitHub Pages
65+
id: deployment
66+
uses: actions/deploy-pages@v4

docs/react/docs/_meta.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@
1212
{
1313
"text": "其他链接",
1414
"items": [
15-
{ "text": "Virtual Vue", "link": "https://github.com/zyt-cloud/virtual" },
16-
{ "text": "Virtual Taro", "link": "https://github.com/zyt-cloud/virtual" }
15+
{ "text": "Virtual Vue", "link": "https://www.npmjs.com/package/@z-cloud/virtual-vue" },
16+
{ "text": "Virtual Taro", "link": "https://www.npmjs.com/package/@z-cloud/virtual-taro" },
17+
{ "text": "Virtual uni-app", "link": "https://www.npmjs.com/package/@z-cloud/virtual-uni" }
1718
]
1819
}
1920
]

docs/react/docs/guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
- 统一web以及小程序以相同的配置方式使用虚拟列表
88
- 实现瀑布流、grid等常用场景
99
- 满足固定尺寸,每一项指定尺寸,以及动态尺寸的场景
10-
- 集成滚动加载、下拉刷新等需求
10+
- 集成滚动加载、下拉刷新等需求(开发中)

docs/react/docs/guide/installation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,15 @@ pnpm add @z-cloud/virtual-react
1313
```bash
1414
pnpm add @z-cloud/virtual-vue
1515
```
16+
17+
## Taro Virtual
18+
19+
```bash
20+
pnpm add @z-cloud/virtual-taro
21+
```
22+
23+
## uni-app Virtual
24+
25+
```bash
26+
pnpm add @z-cloud/virtual-uni
27+
```

docs/vue/docs/.vitepress/config.mts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@ export default defineConfig({
3535
nav: [
3636
{ text: '指南', link: '/guide', activeMatch: '/guide' },
3737
{ text: '联系我', link: '/contact', activeMatch: '/contact' },
38+
{
39+
text: '其他链接',
40+
items: [
41+
{ text: 'Virtual React', link: 'https://www.npmjs.com/package/@z-cloud/virtual-react' },
42+
{ text: 'Virtual Taro', link: 'https://www.npmjs.com/package/@z-cloud/virtual-taro' },
43+
{ text: 'Virtual uni-app', link: 'https://www.npmjs.com/package/@z-cloud/virtual-uni' },
44+
],
45+
},
3846
],
3947

4048
sidebar: {

docs/vue/docs/guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
- 统一web以及小程序以相同的配置方式使用虚拟列表
88
- 实现瀑布流、grid等常用场景
99
- 满足固定尺寸,每一项指定尺寸,以及动态尺寸的场景
10-
- 集成滚动加载、下拉刷新等需求
10+
- 集成滚动加载、下拉刷新等需求(开发中)

docs/vue/docs/guide/installation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,15 @@ pnpm add @z-cloud/virtual-vue
1313
```bash
1414
pnpm add @z-cloud/virtual-react
1515
```
16+
17+
## Taro Virtual
18+
19+
```bash
20+
pnpm add @z-cloud/virtual-taro
21+
```
22+
23+
## uni-app Virtual
24+
25+
```bash
26+
pnpm add @z-cloud/virtual-uni
27+
```

packages/browser/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515
"virtual-browser",
1616
"virtual list for browser"
1717
],
18+
"repository": {
19+
"type": "git",
20+
"url": "https://github.com/zyt-cloud/virtual"
21+
},
1822
"publishConfig": {
1923
"access": "public",
2024
"registry": "https://registry.npmjs.org"

0 commit comments

Comments
 (0)