OI Wiki 的内容是通过上百位创作者的撰稿、修正,不断地完善,最终呈现在大家面前。如果您也想成为创作者之一,我们欢迎您的加入!本文旨在规范创作内容的格式,请您在撰稿或者修正 Wiki 页面以前,仔细阅读以下内容,以帮助你完成更高质量的内容。
+如果您没有足够的时间阅读完整的要求,可以直接到图片举例的章节查看。
+
## 贡献文档要求
当你打算贡献某部分的内容时,你应该尽量确保:
- 例子,给出 1 ~ 2 个典型的例子。
- 题目,在该标题下, **只需要给出题目名字、题目链接** 。
-### 文档内容的基本格式
-
-在提交 PR 前,请先确保文档内容符合下文中的格式要求(如有疑问可以在[How To Contribute](https://github.com/OI-wiki/OI-wiki/wiki/How-to-contribute)页面中查阅相关例子)。格式缺乏基本的规范性、严谨性可能会使你的贡献不能及时通过审核。
+### 主题扩展格式
如果对 mkdocs-material(我们使用的这个主题)还有什么问题,还可以查阅[MkDocs 使用说明](https://github.com/ctf-wiki/ctf-wiki/wiki/Mkdocs-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)和[cyent 的笔记](https://cyent.github.io/markdown-with-mkdocs-material/),前者介绍了 mkdocs-material 主题的插件使用方式,而后者介绍了 markdown 传统语法和 mkdocs-material 支持的扩展语法。
+## 图解
+
+可能上述要求把握起来有些困难,接下来我们给出一些图片来具体分析哪种格式应该使用,哪种不该使用。
+
+### 例 1
+
+![](./images/htc-1.png)
+
+将复杂的 LaTeX 公式使用行间格式,可以使得页面错落有致。但 OI Wiki 作为一个以中文为主体的站点,我们希望大部分纲领性的信息(如标题)尽量使用中文(除英文专有名词)。
+
+### 例 2
+
+![](./images/htc-2.png)
+
+较复杂度的 LaTeX 公式请注意等号的对齐,同时可以适当引用 Wiki 的页面链接来完善内容。
+
+## 例 3
+