貢獻文檔要求¶

當你打算貢獻某部分的內容時，你應該儘量確保

• 文檔內容滿足基本格式要求
• 文檔的合理性
• 文檔存儲的格式

文檔內容的基本格式¶

這裏主要是指 中文排版指南 與 MkDocs 使用說明。額外的基本要求如下

• 之後可能會考慮爲段落標題自動生成序號，所以我們不推薦在段落標題處增加序號。
• 由於所涉及的題目我們都合理地放在了 ctf-challenge 倉庫，所以我們無需在文檔中註明題目的鏈接。而且，題目可能會隨時移動，修復鏈接是一個非常費時間的事情。

文檔的合理性¶

所謂合理性，指所編寫的內容必須具有如下的特性

• 由淺入深，內容的難度應該具有漸進性。
• 邏輯性，對於每類內容的撰寫應該儘量包含以下的內容
  • 原理，說明該內容對應的原理。
  • 例子，給出 1 ~ 2 個典型的例子。
  • 題目，在該標題下， 只需要給出題目名字。

文檔存儲的格式¶

對於每類要編寫的內容，對應的文檔應該存儲在合適的目錄下

• figure，存儲編寫文檔時所使用的圖片。需要注意的是，圖片要放在本地文件夾，避免引用外鏈。請使用相對路徑 ./figure 來索引圖片。
• 文件名請務必都小寫，以 - 分割， 如 file-name
• 注意：無論是例子還是題目，相應的附件都應該存儲在 ctf-challenge 倉庫中的對應目錄中。