mirror of
https://github.com/zuiidea/antd-admin
synced 2026-09-24 01:55:12 +00:00
chore: wire docs app into turbo and root README
Made-with: Cursor
This commit is contained in:
10
README.md
10
README.md
@@ -62,6 +62,16 @@ cd apps/basic && vp install && vp dev
|
||||
cd apps/with-lingui && vp install && vp dev
|
||||
```
|
||||
|
||||
### 文档站(Nextra)
|
||||
|
||||
中文使用文档位于 **`apps/docs`**(Next.js + Nextra)。在仓库根或该目录安装依赖后:
|
||||
|
||||
```bash
|
||||
cd apps/docs && pnpm install && pnpm dev
|
||||
```
|
||||
|
||||
浏览器打开 [http://localhost:3000](http://localhost:3000)。模板 Vite+ 应用仍为 [http://localhost:5173](http://localhost:5173)。开发与构建命令说明见 [`apps/docs/README.md`](./apps/docs/README.md)。
|
||||
|
||||
Core Playwright flows (from the app you are working in):
|
||||
|
||||
```bash
|
||||
|
||||
32
apps/docs/README.md
Normal file
32
apps/docs/README.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Antd Admin 文档站(`antd-admin-docs`)
|
||||
|
||||
基于 [Next.js](https://nextjs.org) App Router、[Nextra 4](https://nextra.site) 与 `nextra-theme-docs` 的中文文档,与模板应用(Vite+、`apps/basic`、`apps/with-lingui`)同仓维护。
|
||||
|
||||
## 端口说明
|
||||
|
||||
| 项目 | 默认开发地址 |
|
||||
| ---- | ------------ |
|
||||
| 模板应用(`vp dev`) | [http://localhost:5173](http://localhost:5173) |
|
||||
| 本文档站(`pnpm dev`) | [http://localhost:3000](http://localhost:3000) |
|
||||
|
||||
## 常用命令
|
||||
|
||||
在 **`apps/docs`** 目录下:
|
||||
|
||||
```bash
|
||||
pnpm install # 首次或依赖变更后
|
||||
pnpm dev # 本地开发(端口 3000)
|
||||
pnpm run build # 生产构建
|
||||
pnpm start # 预览生产构建(端口 3000)
|
||||
pnpm run lint # ESLint(Next 推荐规则)
|
||||
```
|
||||
|
||||
从仓库根目录也可:
|
||||
|
||||
```bash
|
||||
cd apps/docs && pnpm install && pnpm dev
|
||||
```
|
||||
|
||||
## 设计说明
|
||||
|
||||
实现与信息架构见:`docs/specs/2026-04-15-apps-docs-nextra-plan.md`(及同目录 design spec,若存在)。
|
||||
@@ -10,7 +10,9 @@
|
||||
".env*"
|
||||
],
|
||||
"outputs": [
|
||||
"dist/**"
|
||||
"dist/**",
|
||||
".next/**",
|
||||
"!.next/cache/**"
|
||||
]
|
||||
},
|
||||
"lint": {},
|
||||
|
||||
Reference in New Issue
Block a user