CTF Wiki开发指南：贡献者必知的文档规范与流程

CTF Wiki是一个面向网络安全学习者的开源知识库，为CTF竞赛和网络安全学习提供全面的技术文档和教程。这个社区驱动的项目欢迎所有对网络安全感兴趣的开发者参与贡献，共同完善这个宝贵的学习资源。🎯

📝 贡献前准备

在开始贡献之前，请确保你已经了解CTF Wiki的基本理念和社区文化。这个项目没有任何指派性任务，完全基于个人兴趣和热情。你可以自由选择想要编写或完善的内容，把所学知识与他人分享。

参与贡献只需要一个GitHub账号，不需要高超的GitHub技巧！ 😊

🔄 基本贡献流程

新手友好的一键编辑方式

如果你不熟悉GitHub的复杂操作，可以直接在CTF Wiki网站上找到对应页面，点击右上方的"编辑此页"按钮即可在线编辑。GitHub会自动帮你处理fork和Pull Request的流程，让你可以专注于内容创作。

有经验开发者的标准流程

1. Fork仓库：将主仓库fork到自己的账户中
2. 检查任务：查看Issue和Project，避免重复工作
3. 本地开发：拉取最新代码，处理冲突，确保文档正常生成
4. 提交PR：包含清晰的标题和必要的问题描述

📋 文档内容规范要求

文档格式基本要求

• 段落标题：不推荐在标题中增加序号，系统会自动处理
• 内容结构：由浅入深，逻辑清晰
• 图片使用：所有图片必须存储在本地figure文件夹中

内容合理性标准

每类内容应该包含以下部分：

• 原理说明：清晰解释技术原理
• 典型示例：提供1-2个代表性的例子
• 相关题目：只需列出题目名称

🌐 多语言翻译指南

CTF Wiki支持多语言版本，目前包含中文、英文等版本。翻译工作主要遵循以下原则：

• 保持文件结构的一致性
• 确保意思表达准确
• 图片资源需要同步拷贝

翻译工作流程

1. 确定语言代码：如英语为en
2. 复制文件结构：从中文版本复制到对应语言目录
3. 更新配置文件：在对应语言的mkdocs.yml中添加导航
4. 内容翻译：进行实际的翻译工作

💡 最佳实践建议

Pull Request注意事项

• 单一任务：每个PR只解决一个主要问题
• 本地测试：确保在本地可以正常生成文档
• 预览检查：在PR评论中查看预览效果

新章节开发流程

如果你想要开启全新的技术章节，请务必：

1. 在Discord社区中交流讨论
2. 发起新的issue简要说明计划
3. 等待管理人员将任务放入Project中

🚀 快速开始指南

想要立即开始贡献？只需要：

1. 访问CTF Wiki在线网站
2. 找到你感兴趣或擅长的页面
3. 点击"编辑此页"开始你的贡献之旅！

记住，CTF Wiki的成功依赖于每一位贡献者的努力。无论你是网络安全新手还是资深专家，你的每一次贡献都能帮助更多人学习成长。🌟