跳转至

贡献文档要求

当你打算贡献某部分的内容时,你应该尽量确保

  • 文档内容满足基本格式要求
  • 文档的合理性
  • 文档存储的格式

文档内容的基本格式

这里主要是指 中文排版指南MkDocs 使用说明。额外的基本要求如下

  • 之后可能会考虑为段落标题自动生成序号,所以我们不推荐在段落标题处增加序号。
  • 由于所涉及的题目我们都合理地放在了 ctf-challenge 仓库,所以我们无需在文档中注明题目的链接。而且,题目可能会随时移动,修复链接是一个非常费时间的事情。

文档的合理性

所谓合理性,指所编写的内容必须具有如下的特性

  • 由浅入深,内容的难度应该具有渐进性。
  • 逻辑性,对于每类内容的撰写应该尽量包含以下的内容
    • 原理,说明该内容对应的原理。
    • 例子,给出 1 ~ 2 个典型的例子。
    • 题目,在该标题下, 只需要给出题目名字

文档存储的格式

对于每类要编写的内容,对应的文档应该存储在合适的目录下

  • figure,存储编写文档时所使用的图片。需要注意的是,图片要放在本地文件夹,避免引用外链。请使用相对路径 ./figure 来索引图片。
  • 文件名请务必都小写,以 - 分割, 如 file-name
  • 注意:无论是例子还是题目,相应的附件都应该存储在 ctf-challenge 仓库中的对应目录中