@@ -116,24 +116,25 @@ bun check
116116```
117117
118118这会运行:
119+
119120- Prettier 处理 Markdown/TypeScript/JavaScript
120121- ` zig fmt ` 处理 Zig 源文件
121122- AutoCorrect 处理中文文本格式
122123
123124## 关键文件及其用途
124125
125- | 文件/目录 | 用途 |
126- | -----------| ------|
127- | ` build.zig ` | 主构建编排器,检测 Zig 版本并委托给对应的构建脚本 |
128- | ` build/0.15.zig ` | 当前活跃的构建脚本,具有智能示例发现功能 |
129- | ` course/.vitepress/config.mts ` | VitePress 配置(语言、主题、SEO) |
130- | ` course/.vitepress/sidebar.ts ` | 定义课程导航结构 |
131- | ` course/code/15/ ` | Zig 0.15 可运行示例(当前活跃版本) |
132- | ` course/basic/ ` | Zig 基础概念(变量、类型、控制流) |
133- | ` course/advanced/ ` | 进阶主题(comptime、异步、内存管理) |
134- | ` course/update/ ` | 版本迁移指南 |
135- | ` package.json ` | 构建脚本和 Node.js 依赖 |
136- | ` .github/workflows/build.yml ` | 跨平台和版本的 CI/CD 测试 |
126+ | 文件/目录 | 用途 |
127+ | ------------------------------ | ------------------------------------------------- |
128+ | ` build.zig ` | 主构建编排器,检测 Zig 版本并委托给对应的构建脚本 |
129+ | ` build/0.15.zig ` | 当前活跃的构建脚本,具有智能示例发现功能 |
130+ | ` course/.vitepress/config.mts ` | VitePress 配置(语言、主题、SEO) |
131+ | ` course/.vitepress/sidebar.ts ` | 定义课程导航结构 |
132+ | ` course/code/15/ ` | Zig 0.15 可运行示例(当前活跃版本) |
133+ | ` course/basic/ ` | Zig 基础概念(变量、类型、控制流) |
134+ | ` course/advanced/ ` | 进阶主题(comptime、异步、内存管理) |
135+ | ` course/update/ ` | 版本迁移指南 |
136+ | ` package.json ` | 构建脚本和 Node.js 依赖 |
137+ | ` .github/workflows/build.yml ` | 跨平台和版本的 CI/CD 测试 |
137138
138139## 代码示例组织方式
139140
@@ -199,13 +200,15 @@ bun check
199200### 主构建脚本(` build.zig ` )
200201
201202主构建脚本:
203+
2022041 . 检测当前 Zig 编译器版本
2032052 . 分发到 ` build/ ` 目录下对应的版本特定构建脚本
2042063 . 优雅处理版本兼容性
205207
206208### 版本特定构建脚本(` build/0.15.zig ` )
207209
208210每个版本构建脚本:
211+
2092121 . ** 发现示例** :扫描 ` course/code/VERSION/ ` 目录
2102132 . ** 分类** :
211214 - 独立 ` .zig ` 文件 → 编译为可执行文件
@@ -256,6 +259,7 @@ bun check
256259### 提交信息
257260
258261遵循 Conventional Commits:
262+
259263```
260264<type>(<scope>): <description>
261265
@@ -283,17 +287,20 @@ update/<description> # 版本更新
283287### 代码风格
284288
285289** Zig 代码** :
290+
286291- 使用 ` zig fmt ` (在 CI 中强制执行)
287292- 遵循 Zig 风格指南原则
288293- 为公共 API 添加文档注释
289294
290295** Markdown** :
296+
291297- 中文文本使用中文标点(。,!?)
292298- 中文和英文/数字之间添加空格
293299- 代码块使用具体语言标记:` ```zig ` ,不要用 ` ```
294300- 图片使用相对路径:`  `
295301
296302** 中文文本** :
303+
297304- 正确使用标点符号(。不是 .)
298305- 正确使用引号(「」不是 "")
299306- 中英文之间加空格
@@ -302,16 +309,19 @@ update/<description> # 版本更新
302309### 文件组织
303310
304311** 文档文件** :
312+
305313- 放在 ` course/ ` 下的适当分类中
306314- 使用英文描述性文件名
307315- 如添加新页面需更新 ` course/.vitepress/sidebar.ts `
308316
309317** 代码示例** :
318+
310319- 放在 ` course/code/15/ ` (或当前版本)
311320- 尽可能匹配文档结构
312321- 包含解释概念的文档注释
313322
314323** 图片** :
324+
315325- 放在 ` course/picture/ ` 中
316326- 使用子目录组织
317327- 提交前优化图片
0 commit comments