Skip to content

Commit 44321fd

Browse files
committed
feat: Add custom JavaScript for enhanced user experience
- Implemented loading animation, code block enhancements, and table of contents. - Added reading progress bar, back-to-top button, and copy code functionality. - Integrated lazy loading for images and enhanced search with keyboard shortcuts. - Included page statistics and theme toggle functionality. - Added error handling and performance monitoring. chore: Update book.json with new structure and plugins configuration - Added plugins for sharing, theme, code copying, and GitHub integration. - Configured font settings and added versioning information. chore: Update package dependencies in package.json and package-lock.json - Added new GitBook plugins for enhanced functionality. - Updated honkit and prism dependencies. docs: Add robots.txt and sitemap.xml for better SEO - Configured robots.txt to manage crawler access. - Created sitemap.xml to improve site indexing.
1 parent 9b3359f commit 44321fd

File tree

8 files changed

+1428
-6
lines changed

8 files changed

+1428
-6
lines changed

CONTRIBUTING.md

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
# 贡献指南
2+
3+
感谢你对 Clacky AI 编程入门教程项目的关注!我们欢迎各种形式的贡献,包括但不限于:
4+
5+
## 🤝 如何贡献
6+
7+
### 📝 内容贡献
8+
9+
1. **改进教程内容**
10+
- 修正错误或不准确的信息
11+
- 补充缺失的内容
12+
- 优化表达方式和结构
13+
14+
2. **添加新的练习项目**
15+
- 设计适合初学者的项目
16+
- 提供完整的项目说明和代码
17+
18+
3. **翻译工作**
19+
- 将教程翻译成其他语言
20+
- 维护多语言版本的同步
21+
22+
### 🐛 问题报告
23+
24+
如果你发现了问题,请:
25+
26+
1. 检查是否已有相关的 Issue
27+
2. 创建新的 Issue,包含:
28+
- 问题的详细描述
29+
- 重现步骤
30+
- 期望的行为
31+
- 实际的行为
32+
- 环境信息(浏览器、操作系统等)
33+
34+
### 💡 功能建议
35+
36+
我们欢迎新功能的建议:
37+
38+
1. 创建 Feature Request Issue
39+
2. 详细描述建议的功能
40+
3. 说明功能的用途和价值
41+
4. 如果可能,提供实现思路
42+
43+
## 🚀 提交流程
44+
45+
### 1. Fork 项目
46+
47+
点击项目页面右上角的 "Fork" 按钮,将项目复制到你的 GitHub 账户。
48+
49+
### 2. 克隆到本地
50+
51+
```bash
52+
git clone https://github.com/你的用户名/ai-clacky-workshop-tutorial.git
53+
cd ai-clacky-workshop-tutorial
54+
```
55+
56+
### 3. 创建分支
57+
58+
```bash
59+
git checkout -b feature/你的功能名称
60+
#
61+
git checkout -b fix/你的修复名称
62+
```
63+
64+
### 4. 进行修改
65+
66+
- 遵循项目的代码风格
67+
- 确保修改不会破坏现有功能
68+
- 添加必要的测试
69+
70+
### 5. 提交更改
71+
72+
```bash
73+
git add .
74+
git commit -m "描述你的更改"
75+
```
76+
77+
### 6. 推送到 GitHub
78+
79+
```bash
80+
git push origin feature/你的功能名称
81+
```
82+
83+
### 7. 创建 Pull Request
84+
85+
1. 访问你的 Fork 项目页面
86+
2. 点击 "New Pull Request"
87+
3. 填写 PR 描述,包括:
88+
- 更改的内容
89+
- 更改的原因
90+
- 测试情况
91+
92+
## 📋 代码规范
93+
94+
### Markdown 文档
95+
96+
- 使用中文标点符号
97+
- 代码块使用适当的语言标识
98+
- 保持一致的标题层级
99+
- 使用有意义的链接文本
100+
101+
### 文件命名
102+
103+
- 使用中文文件名(如现有文件)
104+
- 保持命名的一致性
105+
- 避免特殊字符
106+
107+
### 提交信息
108+
109+
使用清晰的提交信息:
110+
111+
```
112+
类型: 简短描述
113+
114+
详细描述(如果需要)
115+
116+
- 具体更改1
117+
- 具体更改2
118+
```
119+
120+
类型包括:
121+
- `feat`: 新功能
122+
- `fix`: 修复
123+
- `docs`: 文档更新
124+
- `style`: 格式调整
125+
- `refactor`: 重构
126+
- `test`: 测试相关
127+
128+
## 🎯 学员作品提交
129+
130+
### 提交你的学习作品
131+
132+
完成教程学习后,欢迎提交你的作品到学员作品展示区:
133+
134+
1.`student-works` 目录下创建你的文件夹
135+
2. 文件夹命名格式:`你的名字-城市`(如:`张三-北京`
136+
3. 包含以下文件:
137+
- `README.md` - 项目介绍
138+
- `index.html` - 项目主页(如果适用)
139+
- 其他项目文件
140+
141+
### 作品要求
142+
143+
- 必须是通过本教程学习完成的项目
144+
- 代码整洁,有适当的注释
145+
- 包含项目说明和使用方法
146+
- 如果有在线演示,请提供链接
147+
148+
### 作品展示格式
149+
150+
在你的 `README.md` 中包含:
151+
152+
```markdown
153+
# 项目名称
154+
155+
## 作者信息
156+
- 姓名:你的名字
157+
- 城市:你的城市
158+
- 学习时间:完成教程的时间
159+
160+
## 项目描述
161+
简要描述你的项目功能和特色
162+
163+
## 技术栈
164+
- 使用的技术和工具
165+
166+
## 在线演示
167+
- 项目链接(如果有)
168+
169+
## 学习心得
170+
分享你的学习体验和收获
171+
172+
## 项目截图
173+
![项目截图](screenshot.png)
174+
```
175+
176+
## 🔍 代码审查
177+
178+
所有的 Pull Request 都会经过代码审查:
179+
180+
1. 自动化检查(如果配置)
181+
2. 维护者人工审查
182+
3. 社区反馈
183+
184+
请耐心等待审查结果,并根据反馈进行调整。
185+
186+
## 📞 联系我们
187+
188+
如果你有任何问题或建议:
189+
190+
- 创建 GitHub Issue
191+
- 发送邮件到:support@clacky.ai
192+
- 参与社区讨论
193+
194+
## 🏆 贡献者认可
195+
196+
我们会在项目中认可所有贡献者:
197+
198+
- 在 README 中列出贡献者
199+
- 在发布说明中感谢贡献者
200+
- 为重要贡献者提供推荐信
201+
202+
## 📄 许可证
203+
204+
通过贡献代码,你同意你的贡献将在 MIT 许可证下发布。
205+
206+
---
207+
208+
再次感谢你的贡献!让我们一起让这个教程变得更好! 🎉

0 commit comments

Comments
 (0)