## 贡献文档要求
-å½\93ä½ æ\89\93ç®\97è´¡ç\8c®æ\9f\90é\83¨å\88\86ç\9a\84å\86\85容æ\97¶ï¼\8cä½ åº\94该尽é\87\8fç¡®ä¿\9d：
+å½\93ä½ æ\89\93ç®\97è´¡ç\8c®æ\9f\90é\83¨å\88\86ç\9a\84å\86\85容æ\97¶ï¼\8cä½ åº\94该尽é\87\8fç\86\9fæ\82\89以ä¸\8bä¸\89é\83¨å\88\86：
-- æ\96\87æ¡£å\86\85容满足å\9fºæ\9c¬æ ¼å¼\8fè¦\81æ±\82；
+- æ\96\87æ¡£å\98å\82¨ç\9a\84æ ¼å¼\8f；
- 文档的合理性；
-- 文档存储的格式。
+- 文档内容满足 remark-lint 和 Latex 公式的格式要求。
+
+## 文档存储的格式
+
+1. **文件名请务必都小写，以 `-` 分割，如 `file-name` 。**
+2. 请务必确保您的文档中引用的 **外链** 图片已经全部转存到了 **本库内** 对应的 `images` 文件夹中（防止触发某些网站的防盗链），建议处理成 `MD 文档名称 + 编号` 的形式（可参考已有文档中图片的处理方式）。（即格式为 `` ）。
+3. 请确保您的文档中的引用链接的稳定性， **不推荐** 引用 **自建** 服务（如 OJ）中的资源（如题目）
+
+## 文档的合理性
+
+所谓合理性，指所编写的 **内容** 必须具有如下的特性：
+
+- 由浅入深，内容的难度应该具有渐进性。
+- 逻辑性，对于每类内容的撰写应该尽量包含以下的内容：
+ - 原理，说明该内容对应的原理。
+ - 例子，给出 1 ~ 2 个典型的例子。
+ - 题目，在该标题下， **只需要给出题目名字、题目链接** 。
## 基本格式要求
-### Remark-lint 要求怎样的格式
+### Remark-lint 的格式要求
-我们现在启用的配置文件在[.remarkrc](https://github.com/24OI/OI-wiki/blob/master/.remarkrc)，它可以自动给项目内文件统一风格。
+[remark-lint](https://github.com/remarkjs/remark-lint) 可以自动给项目内文件统一风格，我们现在启用的配置文件在[.remarkrc](https://github.com/24OI/OI-wiki/blob/master/.remarkrc)。
在配置过程中我们也遇到了一些 remark-lint 不能很好处理的问题：
2. `1. 例子` 点号后要有空格。
4. 行间公式前后各要有一行空行，否则会被当做是行内公式。
5. 伪代码请使用 ```` ```text```` ，直接使用 ```` ``` ```` 可能导致内容被错误地缩进。
-6. 涉及到目录的更改，需要改动 mkdocs.yml，另外也请注意如果影响到作者信息统计，麻烦更新[author 字段](https://oi-wiki.org/intro/faq/#_15)。（不改动目录的时候不需要维护 author 字段。）
+6. 涉及到目录的更改的时候：
+ 1. 需要改动 mkdocs.yml
+ 2. 请注意如果影响到作者信息统计，麻烦更新[author 字段](https://oi-wiki.org/intro/faq/#_15)。（不改动目录的时候不需要维护 author 字段。）
+ 3. 需要在项目内搜索一下是否有内链需要更新。
7. 使用 `???` 或 `!!!` 开头的 Details 语法时，需要注意：开头至少有 4 个空格的行才会被当做是在 Details 语法的文本框中。
### 标点符号的使用
> - 第五步，若这个点未被访问过，则将这个点放入队列，且设置这个点为已经访问过；
> - 第六步，回到第三步，直到队列为空。
-### LaTeX 公式的格式
+### LaTeX 公式的格式要求
LaTeX 作为公式排版的首选，我们应当正确地使用它。因此对于 LateX 的使用我们有严格的要求。如果您想要快速上手，可以阅读本章节末给出的表格。
2. 表示强调时请使用 `**SOMETHING**` 而非某级标题，因为使用标题会导致文章结构层次混乱和（或）目录出现问题。
3. 请正确使用 Markdown 的区块功能，插入行间代码请使用一个反引号包围代码区块，行间代码请使用三个反引号包围代码区块，其中反引号就是键盘左上角波浪线下面那个符号。
-### 文档存储的格式
-
-1. **文件名请务必都小写，以 `-` 分割，如 `file-name` 。**
-2. 请务必确保您的文档中引用的 **外链** 图片已经全部转存到了 **本库内** 对应的 `images` 文件夹中（防止触发某些网站的防盗链），建议处理成 `MD 文档名称 + 编号` 的形式（可参考已有文档中图片的处理方式）。（即格式为 `` ）。
-3. 请确保您的文档中的引用链接的稳定性， **不推荐** 引用 **自建** 服务（如 OJ）中的资源（如题目）
-
-### 文档的合理性
-
-所谓合理性，指所编写的 **内容** 必须具有如下的特性：
-
-- 由浅入深，内容的难度应该具有渐进性。
-- 逻辑性，对于每类内容的撰写应该尽量包含以下的内容：
- - 原理，说明该内容对应的原理。
- - 例子，给出 1 ~ 2 个典型的例子。
- - 题目，在该标题下， **只需要给出题目名字、题目链接** 。
-
### 主题扩展格式
如果对 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 支持的扩展语法。
OSDN Git Service
