From f2b215e4485749a51cca53693cb13f8338d25682 Mon Sep 17 00:00:00 2001
From: sshwy <jy.cat@qq.com>
Date: Mon, 5 Aug 2019 00:00:44 +0800
Subject: [PATCH] =?utf8?q?=E5=85=88copy=E4=B8=80=E4=B8=8B=EF=BC=8C?=
 =?utf8?q?=E4=B9=8B=E5=90=8E=E6=89=93=E7=AE=97=E6=8A=8A=E5=86=85=E9=93=BE?=
 =?utf8?q?=E7=9A=84=E5=86=85=E5=AE=B9=E7=9B=B4=E6=8E=A5=E5=B1=95=E5=BC=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

---
 docs/intro/htc.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 docs/intro/htc.md

diff --git a/docs/intro/htc.md b/docs/intro/htc.md
new file mode 100644
index 00000000..2c342860
--- /dev/null
+++ b/docs/intro/htc.md
@@ -0,0 +1,59 @@
+OI Wiki 的内容是通过上百位创作者的撰稿、修正，不断地完善，最终呈现在大家面前。如果您也想成为创作者之一，我们欢迎您的加入！本文旨在规范创作内容的格式，请您在撰稿或者修正Wiki页面以前，仔细阅读以下内容，以帮助你完成更高质量的内容。
+
+## 贡献文档要求
+
+当你打算贡献某部分的内容时，你应该尽量确保：
+
+-   文档内容满足基本格式要求；
+-   文档的合理性；
+-   文档存储的格式。
+
+### 文档内容的基本格式
+
+在提交 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 支持的扩展语法。
+
+#### remark-lint 要求怎样的格式
+
+我们现在启用的配置文件在[.remarkrc](https://github.com/24OI/OI-wiki/blob/master/.remarkrc)，它可以自动给项目内文件统一风格。
+
+在配置过程中我们也遇到了一些 remark-lint 不能很好处理的问题：
+
+1.  不要在页面中添加 `<h1>` 或者 `# 标题` 。
+2.   `## 简介` 标题要空一格（英文半角空格），也不要写成 `## 简介 ##` 。
+3.  列表
+    1.  列表前要有空行，新开一段。
+    2.   `1. 例子` 点号后要有空格。
+4.  行间公式前后各要有一行空行，否则会被当做是行内公式。
+5.  伪代码请使用 ```` ```text```` ，直接使用 ```` ``` ```` 可能导致内容被错误地缩进。
+6.  涉及到目录的更改，需要改动 mkdocs.yml，另外也请注意如果影响到作者信息统计，麻烦更新[author 字段](https://oi-wiki.org/intro/faq/#_15)。
+7.  所有比赛请使用官方正式中文/英文名称。特别注意 NOI 系列赛官方英文名称均为全大写，如 NOIP。
+
+#### 文档中 LaTeX 公式的格式
+
+-   请不要滥用 LaTeX 公式字体（比如对一些英文单词使用公式字体）
+-   对于 LaTeX 公式，请注意常见的问题， **一定要使用**  `$\log$` 、 `$\min$` 、 `$\max$` 、 `$\gcd$` 等，而非 `$log$` 、 `$min$` 、 `$max$` 、 `$gcd$` 。对于最小公倍数，请使用 `$\operatorname{lcm}$` 而非 `$lcm$` ，省略号请使用 `$\cdots$` ，叉乘请使用 `$\times$` ，点乘请使用 `$\cdot$` 。其他非数学内容，包括中文、英文、特殊符号等，一律使用 `\text{}` 。
+-   所有公式中的希腊字母等特殊符号，请不要使用输入法的插入特殊符号功能，而应该使用对应的 LaTeX 公式符号。如 phi 大多数情况下应该使用 `$\varphi$` 而不是 `$\phi$` 。
+-   在不会引起歧义的情况下，请用 `\times` 代替星号。如 $a\times b$ ，而不是 $a*b$ 。
+-   请用 `\cdots` ， `\ldots` ， `\vdots` 代替 `...` 。如 $a_1,a_2,\cdots a_n$ ，而不是 $a_1,a_2,... a_n$ 。
+-   请用 `=` 代替 `==` 。如 $a=b$ ，而不是 $a==b$ 。
+-   请用 `a\bmod b` 代替 `a%b` 。如 $a\bmod b$ ，而不是 $a%b$ 。
+-   为了统一，复杂度分析时大 $O$ 记号请直接使用 `$O()$` 而不要 `$\mathcal O()$` 。
+-   公式中尽量避免中括号而多使用下标。即 $a_{i,j,k}$ 而不是 $a[i][j][k]$ 。在公式中下标较复杂的情况下建议改用多元函数（ $f(i,j,k)$ ）或内联代码格式。
+
+#### 文档存储的格式
+
+-    **文件名请务必都小写，以 `-` 分割，如 `file-name` 。** 
+-   请务必确保您的文档中引用的 **外链** 图片已经全部转存到了 **本库内** 对应的 `images` 文件夹中（防止触发某些网站的防盗链），建议处理成 `MD 文档名称 + 编号` 的形式（可参考已有文档中图片的处理方式）。（即格式为 `![](./images/xx.jpg)` ）。
+-   请确保您的文档中的引用链接的稳定性， **不推荐** 引用 **自建** 服务（如 OJ）中的资源（如题目）
+
+### 文档的合理性
+
+所谓合理性，指所编写的 **内容** 必须具有如下的特性：
+
+-   由浅入深，内容的难度应该具有渐进性。
+-   逻辑性，对于每类内容的撰写应该尽量包含以下的内容：
+    -   原理，说明该内容对应的原理。
+    -   例子，给出 1 ~ 2 个典型的例子。
+    -   题目，在该标题下， **只需要给出题目名字、题目链接** 。
\ No newline at end of file
-- 
2.11.0