如何贡献

感谢您对这个动态书籍项目的兴趣！我们欢迎各种形式的贡献，让这本书变得更好。

🤝 贡献方式

📝 内容贡献

• 新增章节或文章
• 完善现有内容
• 修正错误和改进表述
• 添加实例和案例

🐛 问题反馈

• 报告内容错误
• 提出改进建议
• 反馈阅读体验问题

💡 想法分享

• 提出新的主题建议
• 分享相关资源
• 参与讨论和交流

📋 贡献流程

步骤1：准备工作

1. Fork仓库

   # 在GitHub上点击Fork按钮
   # 然后克隆到本地
   git clone https://github.com/yourusername/my-dynamic-book.git
   cd my-dynamic-book

2. 安装依赖

   npm install

3. 启动开发服务器

   npm run dev

步骤2：创建内容

1. 创建新分支

   git checkout -b feature/new-article

2. 添加内容

   • 在docs/articles/目录下创建新的.md文件
   • 或者编辑现有文件

3. 预览效果

   • 在浏览器中查看 http://localhost:5173
   • 确保格式和显示正确

步骤3：提交更改

1. 提交代码

   git add .
   git commit -m "添加新文章：文章标题"
   git push origin feature/new-article

2. 创建Pull Request

   • 在GitHub上创建Pull Request
   • 详细描述您的更改
   • 等待审核和合并

✍️ 写作规范

文件结构

docs/
├── articles/           # 文章目录
│   ├── education-ai.md
│   └── new-article.md
├── images/            # 图片资源
└── .vitepress/        # 配置文件
    └── config.js

Markdown格式

每篇文章应该包含：

# 文章标题

::: info 章节信息
**更新时间**: 2024年1月  
**阅读时间**: 约15分钟  
**难度级别**: 初级/中级/高级  
:::

## 摘要
简要描述文章内容...

## 主要内容
...

---

*下一章节：[链接到下一章](/articles/next-article)*

样式指南

标题层级

• # - 文章标题（每篇文章只有一个）
• ## - 主要章节
• ### - 子章节
• #### - 详细分点

强调和提示

::: info 信息提示
重要信息内容
:::

::: tip 小贴士
有用的提示
:::

::: warning 注意
需要注意的内容
:::

::: danger 警告
重要警告信息
:::

代码块

```javascript
// 代码示例
function example() {
    return "Hello World";
}
``` // 这里应该有反引号，为了显示我用了中文

引用和链接

> 这是一个引用

[内部链接](/articles/other-article)
[外部链接](https://example.com)

🎨 图片和媒体

图片规范

• 格式：PNG, JPG, WebP
• 大小：建议不超过1MB
• 尺寸：宽度不超过800px
• 命名：使用有意义的文件名

添加图片

![图片描述](../images/image-name.png)

图片优化

• 使用压缩工具减小文件大小
• 为图片添加有意义的alt文本
• 考虑使用SVG格式的图标

📚 内容类型

学术文章

• 结构清晰的学术论文
• 包含摘要、关键词、参考文献
• 使用适当的引用格式

技术教程

• 步骤清晰的操作指南
• 包含代码示例和截图
• 提供实际可运行的代码

思考笔记

• 个人观点和思考
• 学习心得和总结
• 灵感和想法记录

🔍 质量标准

内容质量

• ✅ 内容准确、有价值
• ✅ 逻辑清晰、结构合理
• ✅ 语言流畅、易于理解
• ✅ 格式规范、排版美观

技术要求

• ✅ Markdown语法正确
• ✅ 链接有效可访问
• ✅ 图片正常显示
• ✅ 代码可以运行

🔄 审核流程

自动检查

• Markdown语法检查
• 链接有效性验证
• 拼写检查
• 构建测试

人工审核

1. 内容审核：检查内容质量和准确性
2. 格式审核：确保符合写作规范
3. 技术审核：验证代码和链接
4. 最终审核：整体质量把关

反馈和修改

• 审核者会在PR中提供具体反馈
• 请根据反馈进行相应修改
• 修改完成后重新请求审核

🏆 贡献者权益

署名权

• 在文章中署名贡献者
• 在贡献者页面展示
• 在更新日志中记录

社区权益

• 优先参与重要讨论
• 获得社区徽章
• 参与编辑决策

💬 沟通渠道

GitHub Issues

用于：

• 报告问题
• 提出建议
• 跟踪任务

GitHub Discussions

用于：

• 一般性讨论
• 想法交流
• 问题求助

Email联系

• 紧急问题：zhanbing2025@gmail.com
• 私人讨论和合作提议

📋 常见问题

Q: 我不熟悉Git，如何贡献？

A: 可以通过以下方式：

• 使用GitHub的在线编辑器
• 通过Issues提出建议
• 发送邮件提供内容

Q: 文章的版权如何处理？

A:

• 采用Creative Commons许可证
• 贡献者保留署名权
• 允许非商业使用和修改

Q: 如何确保内容质量？

A:

• 多轮审核机制
• 社区反馈系统
• 持续改进流程

Q: 可以贡献哪些类型的内容？

A:

• 学术文章和研究
• 技术教程和指南
• 案例研究和分析
• 工具和资源推荐

---

开始贡献

准备好开始贡献了吗？

1. 🍴 Fork这个仓库
2. 💡 查看当前Issues
3. 💬 参与讨论

感谢您的贡献！ 🙏