Skip to content

Commit f312198

Browse files
committed
回归使用vitepress默认主题
1 parent 4682552 commit f312198

File tree

11 files changed

+313
-1139
lines changed

11 files changed

+313
-1139
lines changed

PROJECT_PLAN_YARN.md

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

55
**项目名称**: Goldfish Scheme 文档网站
6-
**技术栈**: VitePress + TypeScript + Tailwind CSS v4 + ESLint + Prettier
6+
**技术栈**: VitePress + TypeScript + ESLint + Prettier
77
**包管理器**: Yarn 1.22.22
88
**目标**: 为 [MoganLab/goldfish](https://github.com/MoganLab/goldfish)
99
创建一个现代化、易用的文档网站
@@ -20,54 +20,56 @@
2020
- [x] 脚本绑定优化
2121
- [x] GitHub Pages 自动化部署
2222

23-
### 阶段 2: 文档架构 🟡
24-
25-
- [ ] **导航结构设计**
26-
- [x] 顶部导航(NavBar)
27-
- [ ] 侧边栏导航(Sidebar.vue)
28-
- [x] 页脚信息(Footer.vue)
29-
- [ ] 文档目录组件(Toc.vue)
30-
- [ ] **自定义主题完善**
31-
- [x] 基础布局(Layout.vue)
32-
- [x] 导航栏(NavBar.vue)
33-
- [x] 页脚(Footer.vue)
34-
- [ ] 侧边栏组件(Sidebar.vue)
35-
- [ ] 文档目录组件(Toc.vue)
36-
- [ ] 深色/浅色模式切换
37-
- [ ] **页面模板**
38-
- [x] 首页模板(home: true)
39-
- [ ] 文档页模板
40-
- [ ] 全宽页面模板(可选)
41-
42-
### 阶段 3: 内容编写 🔴
43-
44-
- [ ] 编写快速开始指南
45-
- [ ] 编写 API 文档
46-
- [ ] 编写标准库文档
23+
### 阶段 2: 文档架构 ✅
24+
25+
- [x] **导航结构设计**
26+
- [x] 顶部导航(NavBar)- VitePress 默认主题
27+
- [x] 侧边栏导航(Sidebar)- VitePress 默认主题
28+
- [x] 页脚信息(Footer)- VitePress 默认主题
29+
- [x] 文档目录组件(Toc)- VitePress 默认主题
30+
- [x] **主题配置**
31+
- [x] 扩展 VitePress 默认主题
32+
- [x] 自定义样式(style.css)
33+
- [x] 语言自动重定向
34+
- [x] **页面模板**
35+
- [x] 首页模板(layout: home)
36+
- [x] 文档页模板
37+
- [x] **多语言目录结构**
38+
- [x] 中文内容 (zh/) - 🟢 当前开发
39+
- [x] 英文内容 (en/) - 🔴 预留
40+
- [x] 日语内容 (ja/) - 🔴 预留
41+
- [x] 法语内容 (fr/) - 🔴 预留
42+
- [x] 俄语内容 (ru/) - 🔴 预留
43+
- [x] 根目录重定向 (index.md)
44+
45+
### 阶段 3: 内容编写 ✅
46+
47+
- [x] 编写快速开始指南
48+
- [x] 编写 API 文档
49+
- [x] 编写标准库文档
4750

4851
### 阶段 4: 高级功能 🔴
4952

50-
- [ ] **搜索功能**
51-
- [ ] 配置本地搜索
52-
- [ ] 自定义搜索 UI(可选)
53+
- [x] **搜索功能**
54+
- [x] 配置本地搜索
5355
- [ ] **多语言支持 (i18n)**
54-
- [ ] 配置多语言目录结构
55-
- [ ] 配置语言切换器
56-
- [ ] 中文内容 (zh) - 🟢 当前开发
56+
- [x] 配置多语言目录结构
57+
- [x] 配置语言切换器(VitePress 内置)
58+
- [x] 中文内容 (zh) - 🟢 当前开发
5759
- [ ] 英文内容 (en) - 🔴 预留
5860
- [ ] 日语内容 (ja) - 🔴 预留
5961
- [ ] 法语内容 (fr) - 🔴 预留
6062
- [ ] 俄语内容 (ru) - 🔴 预留
61-
- [ ] **Tailwind CSS v4 集成**
63+
- [ ] **Tailwind CSS v4 集成**(可选)
6264
- [ ] 配置 Tailwind CSS v4
6365
- [ ] 设计系统/组件库
6466
- [ ] 响应式布局优化
6567
- [ ] 深色模式支持
66-
- [ ] **自动化部署**
68+
- [x] **自动化部署**
6769
- [x] GitHub Actions 配置
6870
- [x] GitHub Pages 部署
6971

70-
### 阶段 5: Playground 🔴
72+
### 阶段 5: Playground 🔴(长期)
7173

7274
- [ ] **技术调研**
7375
- [ ] 确认 Goldfish Scheme 构建方式
@@ -98,34 +100,35 @@ case-lambda/
98100
├── docs/ # 文档内容
99101
│ ├── .vitepress/ # VitePress 配置
100102
│ │ ├── config.mts # 主配置 (TypeScript)
101-
│ │ ├── config/ # 多语言配置
102-
│ │ │ ├── shared.ts # 共享配置
103-
│ │ │ ├── zh.ts # 中文配置
104-
│ │ │ ├── en.ts # 英文配置(预留)
105-
│ │ │ ├── ja.ts # 日语配置(预留)
106-
│ │ │ ├── fr.ts # 法语配置(预留)
107-
│ │ │ └── ru.ts # 俄语配置(预留)
108-
│ │ ├── theme/ # 自定义主题
109-
│ │ │ ├── Layout.vue
110-
│ │ │ ├── components/
111-
│ │ │ │ ├── NavBar.vue
112-
│ │ │ │ ├── Footer.vue
113-
│ │ │ │ ├── Sidebar.vue # 待实现
114-
│ │ │ │ └── Toc.vue # 待实现
115-
│ │ │ └── style.css # Tailwind CSS 入口
103+
│ │ ├── theme/ # 主题配置
104+
│ │ │ ├── index.ts # 扩展默认主题
105+
│ │ │ └── style.css # 自定义样式
116106
│ │ └── env.d.ts # 类型声明
117-
│ ├── zh/ # 中文内容(默认)
118-
│ │ ├── index.md
119-
│ │ └── guide/
120-
│ │ └── getting-started.md
121-
│ ├── en/ # 英文内容(预留)
107+
│ ├── zh/ # 中文内容(默认)✅
108+
│ │ ├── index.md # 首页
109+
│ │ ├── guide/ # 指南文档
110+
│ │ │ ├── getting-started.md
111+
│ │ │ ├── installation.md
112+
│ │ │ ├── cli.md
113+
│ │ │ ├── repl.md
114+
│ │ │ ├── modules.md
115+
│ │ │ └── modes.md
116+
│ │ └── api/ # API 文档
117+
│ │ ├── index.md
118+
│ │ ├── liii/ # Liii 库 (19个文件)
119+
│ │ ├── srfi/ # SRFI (14个文件)
120+
│ │ └── scheme/ # R7RS 标准 (6个文件)
121+
│ ├── en/ # 英文内容(预留)✅
122122
│ │ └── index.md
123-
│ ├── ja/ # 日语内容(预留)
123+
│ ├── ja/ # 日语内容(预留)
124124
│ │ └── index.md
125-
│ ├── fr/ # 法语内容(预留)
125+
│ ├── fr/ # 法语内容(预留)
126126
│ │ └── index.md
127-
│ └── ru/ # 俄语内容(预留)
128-
│ └── index.md
127+
│ ├── ru/ # 俄语内容(预留)✅
128+
│ │ └── index.md
129+
│ ├── index.md # 语言重定向页
130+
│ └── public/ # 公共资源
131+
│ └── GoldfishScheme-logo.png
129132
├── package.json # 项目配置
130133
├── tsconfig.json # TypeScript 配置
131134
├── eslint.config.js # ESLint 配置
@@ -220,12 +223,16 @@ yarn install
220223
- 支持 Vue、Markdown、JSON 格式化
221224
- 不同文件类型的覆盖配置
222225

223-
### Tailwind CSS v4 (待配置)
226+
### VitePress 默认主题
227+
228+
项目使用 VitePress 默认主题,通过 `extends: DefaultTheme` 扩展:
224229

225-
- 使用 CSS-first 配置方式
226-
- 与 VitePress 集成
227-
- 支持深色模式
228-
- 自定义设计系统
230+
- ✅ 完整的导航、侧边栏、目录功能
231+
- ✅ 内置搜索功能
232+
- ✅ 多语言切换
233+
- ✅ 响应式设计
234+
- ✅ 深色/浅色模式
235+
- ✅ 自定义样式通过 `style.css`
229236

230237
---
231238

@@ -245,13 +252,24 @@ yarn install
245252

246253
```
247254
docs/
248-
├── zh/ # 中文内容(默认)
249-
├── en/ # 英文内容(预留)
250-
├── ja/ # 日语内容(预留)
251-
├── fr/ # 法语内容(预留)
252-
└── ru/ # 俄语内容(预留)
255+
├── zh/ # 中文内容(默认)
256+
├── en/ # 英文内容(预留)
257+
├── ja/ # 日语内容(预留)
258+
├── fr/ # 法语内容(预留)
259+
└── ru/ # 俄语内容(预留)
253260
```
254261

262+
### 语言自动检测
263+
264+
根目录 `docs/index.md` 会根据浏览器语言自动重定向:
265+
266+
- `zh-CN`, `zh-TW`, `zh-HK`, `zh-SG``/zh/`
267+
- `en-US`, `en-GB`, `en``/en/`
268+
- `ja-JP`, `ja``/ja/`
269+
- `fr-FR`, `fr``/fr/`
270+
- `ru-RU`, `ru``/ru/`
271+
- 其他 → `/zh/` (默认中文)
272+
255273
---
256274

257275
## 📋 依赖管理
@@ -269,14 +287,6 @@ docs/
269287
}
270288
```
271289

272-
### 计划添加
273-
274-
```json
275-
{
276-
"tailwindcss": "^4.0.0"
277-
}
278-
```
279-
280290
### 版本控制
281291

282292
- `package.json` 使用 `^` 允许小版本更新
@@ -351,8 +361,8 @@ yarn eslint --print-config eslint.config.js
351361
| 阶段 | 任务 | 状态 |
352362
| ----- | ---------- | --------- |
353363
| 阶段1 | 基础配置 | ✅ 完成 |
354-
| 阶段2 | 文档架构 | 🟡 进行中 |
355-
| 阶段3 | 内容编写 | 🔴 待开始 |
364+
| 阶段2 | 文档架构 | ✅ 完成 |
365+
| 阶段3 | 内容编写 | ✅ 完成 |
356366
| 阶段4 | 高级功能 | 🔴 待开始 |
357367
| 阶段5 | Playground | 🔴 待调研 |
358368

0 commit comments

Comments
 (0)