Skip to content

Commit 9f6bf90

Browse files
committed
计划文档更新
1 parent fb804fb commit 9f6bf90

File tree

1 file changed

+141
-17
lines changed

1 file changed

+141
-17
lines changed

PROJECT_PLAN_YARN.md

Lines changed: 141 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## 🌙 项目概述
44

55
**项目名称**: Goldfish Scheme 文档网站
6-
**技术栈**: VitePress + TypeScript + ESLint + Prettier
6+
**技术栈**: VitePress + TypeScript + Tailwind CSS v4 + ESLint + Prettier
77
**包管理器**: Yarn 1.22.22
88
**目标**: 为 [MoganLab/goldfish](https://github.com/MoganLab/goldfish)
99
创建一个现代化、易用的文档网站
@@ -18,24 +18,82 @@
1818
- [x] ESLint + Prettier 配置
1919
- [x] Yarn 包管理器配置
2020
- [x] 脚本绑定优化
21-
22-
### 阶段 2: 文档架构
23-
24-
- [ ] 设计文档导航结构
25-
- [ ] 创建指南部分
26-
- [ ] 搭建 API 文档框架
27-
28-
### 阶段 3: 内容编写
21+
- [x] GitHub Pages 自动化部署
22+
23+
### 阶段 2: 文档架构 🟡
24+
25+
- [ ] **导航结构设计**
26+
- [x] 顶部导航(NavBar)
27+
- [ ] 侧边栏导航(Sidebar.vue)
28+
- [x] 页脚信息(Footer.vue)
29+
- [ ] 文档目录组件(Toc.vue)
30+
31+
- [ ] **自定义主题完善**
32+
- [x] 基础布局(Layout.vue)
33+
- [x] 导航栏(NavBar.vue)
34+
- [x] 页脚(Footer.vue)
35+
- [ ] 侧边栏组件(Sidebar.vue)
36+
- [ ] 文档目录组件(Toc.vue)
37+
- [ ] 深色/浅色模式切换
38+
39+
- [ ] **页面模板**
40+
- [x] 首页模板(home: true)
41+
- [ ] 文档页模板
42+
- [ ] 全宽页面模板(可选)
43+
44+
### 阶段 3: 内容编写 🔴
2945

3046
- [ ] 编写快速开始指南
3147
- [ ] 编写 API 文档
3248
- [ ] 编写标准库文档
3349

34-
### 阶段 4: 高级功能
35-
36-
- [ ] 搜索功能
37-
- [ ] 多语言支持
38-
- [ ] 自动化部署
50+
### 阶段 4: 高级功能 🔴
51+
52+
- [ ] **搜索功能**
53+
- [ ] 配置本地搜索
54+
- [ ] 自定义搜索 UI(可选)
55+
56+
- [ ] **多语言支持 (i18n)**
57+
- [ ] 配置多语言目录结构
58+
- [ ] 配置语言切换器
59+
- [ ] 中文内容 (zh) - 🟢 当前开发
60+
- [ ] 英文内容 (en) - 🔴 预留
61+
- [ ] 日语内容 (ja) - 🔴 预留
62+
- [ ] 法语内容 (fr) - 🔴 预留
63+
- [ ] 俄语内容 (ru) - 🔴 预留
64+
65+
- [ ] **Tailwind CSS v4 集成**
66+
- [ ] 配置 Tailwind CSS v4
67+
- [ ] 设计系统/组件库
68+
- [ ] 响应式布局优化
69+
- [ ] 深色模式支持
70+
71+
- [ ] **自动化部署**
72+
- [x] GitHub Actions 配置
73+
- [x] GitHub Pages 部署
74+
75+
### 阶段 5: Playground 🔴
76+
77+
- [ ] **技术调研**
78+
- [ ] 确认 Goldfish Scheme 构建方式
79+
- [ ] 选择 WASM 编译方案
80+
- [ ] 评估性能需求
81+
82+
- [ ] **WASM 编译**
83+
- [ ] 配置编译环境
84+
- [ ] 编译 Goldfish 为 WASM
85+
- [ ] 导出 JavaScript API
86+
87+
- [ ] **Playground 组件**
88+
- [ ] 代码编辑器(Monaco/CodeMirror)
89+
- [ ] 运行按钮与交互
90+
- [ ] 结果输出显示
91+
- [ ] 错误处理与提示
92+
93+
- [ ] **功能增强**
94+
- [ ] 预设示例代码
95+
- [ ] 代码分享功能
96+
- [ ] 多文件支持(可选)
3997

4098
---
4199

@@ -48,10 +106,34 @@ case-lambda/
48106
├── docs/ # 文档内容
49107
│ ├── .vitepress/ # VitePress 配置
50108
│ │ ├── config.mts # 主配置 (TypeScript)
109+
│ │ ├── config/ # 多语言配置
110+
│ │ │ ├── shared.ts # 共享配置
111+
│ │ │ ├── zh.ts # 中文配置
112+
│ │ │ ├── en.ts # 英文配置(预留)
113+
│ │ │ ├── ja.ts # 日语配置(预留)
114+
│ │ │ ├── fr.ts # 法语配置(预留)
115+
│ │ │ └── ru.ts # 俄语配置(预留)
116+
│ │ ├── theme/ # 自定义主题
117+
│ │ │ ├── Layout.vue
118+
│ │ │ ├── components/
119+
│ │ │ │ ├── NavBar.vue
120+
│ │ │ │ ├── Footer.vue
121+
│ │ │ │ ├── Sidebar.vue # 待实现
122+
│ │ │ │ └── Toc.vue # 待实现
123+
│ │ │ └── style.css # Tailwind CSS 入口
51124
│ │ └── env.d.ts # 类型声明
52-
│ ├── guide/ # 指南文档
53-
│ ├── api/ # API 文档
54-
│ └── examples/ # 示例
125+
│ ├── zh/ # 中文内容(默认)
126+
│ │ ├── index.md
127+
│ │ └── guide/
128+
│ │ └── getting-started.md
129+
│ ├── en/ # 英文内容(预留)
130+
│ │ └── index.md
131+
│ ├── ja/ # 日语内容(预留)
132+
│ │ └── index.md
133+
│ ├── fr/ # 法语内容(预留)
134+
│ │ └── index.md
135+
│ └── ru/ # 俄语内容(预留)
136+
│ └── index.md
55137
├── package.json # 项目配置
56138
├── tsconfig.json # TypeScript 配置
57139
├── eslint.config.js # ESLint 配置
@@ -137,6 +219,7 @@ yarn install
137219
- 自动修复未使用变量(忽略 `_` 前缀)
138220
- Vue 组件命名宽松
139221
- 代码风格统一
222+
- 禁用与 Prettier 冲突的 Vue 格式规则
140223

141224
### Prettier (prettier.config.js)
142225

@@ -145,6 +228,38 @@ yarn install
145228
- 支持 Vue、Markdown、JSON 格式化
146229
- 不同文件类型的覆盖配置
147230

231+
### Tailwind CSS v4 (待配置)
232+
233+
- 使用 CSS-first 配置方式
234+
- 与 VitePress 集成
235+
- 支持深色模式
236+
- 自定义设计系统
237+
238+
---
239+
240+
## 🌐 多语言支持
241+
242+
### 语言优先级
243+
244+
| 优先级 | 语言 | 代码 | 状态 |
245+
|--------|------|------|------|
246+
| P0 | 中文 | zh | 🟢 当前开发 |
247+
| P1 | 英文 | en | 🔴 预留 |
248+
| P2 | 日语 | ja | 🔴 预留 |
249+
| P2 | 法语 | fr | 🔴 预留 |
250+
| P2 | 俄语 | ru | 🔴 预留 |
251+
252+
### 多语言目录结构
253+
254+
```
255+
docs/
256+
├── zh/ # 中文内容(默认)
257+
├── en/ # 英文内容(预留)
258+
├── ja/ # 日语内容(预留)
259+
├── fr/ # 法语内容(预留)
260+
└── ru/ # 俄语内容(预留)
261+
```
262+
148263
---
149264

150265
## 📋 依赖管理
@@ -162,6 +277,14 @@ yarn install
162277
}
163278
```
164279

280+
### 计划添加
281+
282+
```json
283+
{
284+
"tailwindcss": "^4.0.0"
285+
}
286+
```
287+
165288
### 版本控制
166289

167290
- `package.json` 使用 `^` 允许小版本更新
@@ -239,6 +362,7 @@ yarn eslint --print-config eslint.config.js
239362
| 阶段2 | 文档架构 | 🟡 进行中 |
240363
| 阶段3 | 内容编写 | 🔴 待开始 |
241364
| 阶段4 | 高级功能 | 🔴 待开始 |
365+
| 阶段5 | Playground | 🔴 待调研 |
242366

243367
---
244368

0 commit comments

Comments
 (0)