mirror of
https://github.com/hellodigua/ChatLab.git
synced 2026-10-25 17:54:34 +08:00
chore(docs): isolate docs workspace dependencies
This commit is contained in:
1 parent
7a6d0e9586
commit
ab90e06089
6 files changed
+32
-7
No files matched your search
@@ -8,6 +8,7 @@ This directory contains the source for the public documentation site.
|
||||
- Traditional Chinese docs source: `docs/tw/`
|
||||
- VitePress config: `docs/.vitepress/`
|
||||
- Static assets used by documentation pages: `docs/public/`
|
||||
- Package manifest: `docs/package.json`
|
||||
|
||||
## Content Boundaries
|
||||
|
||||
@@ -19,6 +20,7 @@ This directory contains the source for the public documentation site.
|
||||
## Maintenance Notes
|
||||
|
||||
- The VitePress public entry pages are `en/index.md`, `cn/index.md`, and `tw/index.md`.
|
||||
- Documentation site dependencies live in `docs/package.json`; root `pnpm docs:*` scripts delegate to this workspace package.
|
||||
- `README.md` and `README.zh-CN.md` are source-maintenance entry points and are excluded from the VitePress build.
|
||||
- When adding or moving public docs, update the sidebar in `docs/.vitepress/config.mts`.
|
||||
- When adding images or attachments referenced by docs pages, place only the required assets under `docs/public/`.
|
||||
|
||||
@@ -8,6 +8,7 @@
|
||||
- 繁体中文文档源码:`docs/tw/`
|
||||
- VitePress 配置:`docs/.vitepress/`
|
||||
- 文档页面使用的静态资源:`docs/public/`
|
||||
- 包配置:`docs/package.json`
|
||||
|
||||
## 内容边界
|
||||
|
||||
@@ -19,6 +20,7 @@
|
||||
## 维护说明
|
||||
|
||||
- VitePress 公开入口页是 `en/index.md`、`cn/index.md`、`tw/index.md`。
|
||||
- 文档站依赖维护在 `docs/package.json` 中;根目录 `pnpm docs:*` 脚本只转发到这个 workspace package。
|
||||
- `README.md` 和 `README.zh-CN.md` 是源码维护入口,已从 VitePress 构建中排除。
|
||||
- 新增或移动公开文档时,需要同步更新 `docs/.vitepress/config.mts` 里的侧边栏。
|
||||
- 新增图片或附件时,只把文档页面实际引用的资源放入 `docs/public/`。
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"name": "@openchatlab/docs",
|
||||
"version": "0.21.1",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vitepress dev .",
|
||||
"build": "vitepress build .",
|
||||
"preview": "vitepress preview ."
|
||||
},
|
||||
"devDependencies": {
|
||||
"vitepress": "^1.6.4",
|
||||
"vue": "^3.5.25"
|
||||
}
|
||||
}
|
||||
+3
-4
@@ -30,9 +30,9 @@
|
||||
"dev:web": "pnpm run ensure:server-native && CHATLAB_AUTO_SERVE=1 vite --config vite.web.config.mts",
|
||||
"ensure:server-native": "pnpm --filter chatlab-cli run ensure-native",
|
||||
"build:web": "vite build --config vite.web.config.mts",
|
||||
"docs:dev": "vitepress dev docs",
|
||||
"docs:build": "vitepress build docs",
|
||||
"docs:preview": "vitepress preview docs",
|
||||
"docs:dev": "pnpm --filter @openchatlab/docs dev",
|
||||
"docs:build": "pnpm --filter @openchatlab/docs build",
|
||||
"docs:preview": "pnpm --filter @openchatlab/docs preview",
|
||||
"format": "prettier --write .",
|
||||
"lint": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix",
|
||||
"type-check:web": "vue-tsc --noEmit -p tsconfig.web.json",
|
||||
@@ -69,7 +69,6 @@
|
||||
"tailwindcss": "^4.0.0",
|
||||
"typescript": "^5.8.3",
|
||||
"vite": "^7.0.0",
|
||||
"vitepress": "^1.6.4",
|
||||
"vue": "^3.5.25",
|
||||
"vue-router": "^4.6.3",
|
||||
"vue-tsc": "^3.1.1"
|
||||
|
||||
Generated
+9
-3
@@ -78,9 +78,6 @@ importers:
|
||||
vite:
|
||||
specifier: ^7.0.0
|
||||
version: 7.3.3(@types/node@25.2.2)(jiti@2.6.1)(lightningcss@1.31.1)(tsx@4.21.0)(yaml@2.8.2)
|
||||
vitepress:
|
||||
specifier: ^1.6.4
|
||||
version: 1.6.4(@algolia/client-search@5.52.1)(@types/node@25.2.2)(axios@1.13.5)(fuse.js@7.1.0)(lightningcss@1.31.1)(postcss@8.5.6)(search-insights@2.17.3)(typescript@5.9.3)
|
||||
vue:
|
||||
specifier: ^3.5.25
|
||||
version: 3.5.27(typescript@5.9.3)
|
||||
@@ -214,6 +211,15 @@ importers:
|
||||
specifier: ^5.0.0
|
||||
version: 5.0.0(vite@7.3.3(@types/node@25.2.2)(jiti@2.6.1)(lightningcss@1.31.1)(tsx@4.21.0)(yaml@2.8.2))
|
||||
|
||||
docs:
|
||||
devDependencies:
|
||||
vitepress:
|
||||
specifier: ^1.6.4
|
||||
version: 1.6.4(@algolia/client-search@5.52.1)(@types/node@25.2.2)(axios@1.13.5)(fuse.js@7.1.0)(lightningcss@1.31.1)(postcss@8.5.6)(search-insights@2.17.3)(typescript@5.9.3)
|
||||
vue:
|
||||
specifier: ^3.5.25
|
||||
version: 3.5.27(typescript@5.9.3)
|
||||
|
||||
packages/config:
|
||||
dependencies:
|
||||
smol-toml:
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
packages:
|
||||
- 'packages/**'
|
||||
- 'apps/*'
|
||||
- 'docs'
|
||||
Reference in new issue
Block a user