-# 交流方式
+## 交流方式
本项目主要使用 Issues / [QQ](https://jq.qq.com/?_wv=1027&k=5EfkM6K) / [Telegram](https://t.me/OIwiki) 进行交流沟通。
Telegram 群组链接为 [@OIwiki](https://t.me/OIwiki) ， QQ 群号码为 [`588793226`](https://jq.qq.com/?_wv=1027&k=5EfkM6K)，欢迎加入。
-# 贡献方式
+## 贡献方式
-## 我之前没怎么用过 Github
+### 我之前没怎么用过 Github
参与 Wiki 的编写 **需要** 一个 Github 账号， **不需要** 高超的 Github 技巧。
如果还是不放心，可以参考这篇文章：https://juejin.im/entry/56e638591ea49300550885cc
-## 我之前用过 Github
+### 我之前用过 Github
基本协作方式如下
1. Fork 主仓库到自己的仓库中。
目前，（人员较少），基本上可以忽略 2-3 步，可以直接在 GitHub 网页版进行修改。
-# 贡献文档要求
+## 贡献文档要求
当你打算贡献某部分的内容时，你应该尽量确保
- 文档的合理性
- 文档存储的格式
-## 文档内容的基本格式
+### 文档内容的基本格式
这里主要是指 [中文排版指南](https://github.com/ctf-wiki/ctf-wiki/wiki/%E4%B8%AD%E6%96%87%E6%8E%92%E7%89%88%E6%8C%87%E5%8D%97) 与 [MkDocs 使用说明](https://github.com/ctf-wiki/ctf-wiki/wiki/Mkdocs-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)。
-## 文档的合理性
+### 文档的合理性
所谓合理性，指所编写的 **内容** 必须具有如下的特性
- 例子，给出 1 ~ 2 个典型的例子。
- 题目，在该标题下， **只需要给出题目名字、题目链接**
-## 文档存储的格式
+### 文档存储的格式
对于每类要编写的内容，对应的文档应该存储在合适的目录下
- images， 存储文档介绍时所使用的图片，位置为所添加的目录下（即格式为 ``）。
- **文件名请务必都小写，以 `-` 分割， 如 `file-name`**
-# F.A.Q.
+## F.A.Q.
-## 目录在哪
+### 目录在哪
目录在项目根目录下的 [mkdocs.yml](https://github.com/24OI/OI-wiki/blob/master/mkdocs.yml#L17) 文件中。
-## 如何修改一个 topic 的内容
+### 如何修改一个 topic 的内容
在对应页面右上方有一个编辑按钮，点击之后会跳转到 Github 上对应文件的位置。
或者也可以自行阅读目录 [(mkdocs.yml)](https://github.com/24OI/OI-wiki/blob/master/mkdocs.yml#L17) 查找文件位置
-## 如何添加一个 topic
+### 如何添加一个 topic
1. 可以开一个 Issue，注明希望能添加的内容
2. 可以开一个 Pull Request，在目录 [(mkdocs.yml)](https://github.com/24OI/OI-wiki/blob/master/mkdocs.yml#L17) 中加上新的 topic，并在 [docs](https://github.com/24OI/OI-wiki/tree/master/docs) 文件夹下对应位置创建一个空的 `.md` 文件。
-## commit message 怎么写
+### commit message 怎么写
我们推荐使用 [commitizen/cz-cli](https://github.com/commitizen/cz-cli) 来规范 commit message （并非强求）。
-## 我尝试访问 Github 的时候遇到了困难
+### 我尝试访问 Github 的时候遇到了困难
推荐在 hosts 文件中加入如下几行：（来源： [@GoogleHosts](https://github.com/googlehosts/hosts/blob/master/hosts-files/hosts#L481-L485)）
```
-# Github Start
+## Github Start
192.30.253.118 gist.github.com
192.30.253.112 github.com
192.30.253.112 www.github.com
-# Github End
+## Github End
```
可以在 [@GoogleHosts 主页](https://github.com/googlehosts/hosts) 上了解到更多信息。
-## 我这里 pip 也太慢了
+### 我这里 pip 也太慢了
可以选择更换国内源，参考： https://blog.csdn.net/lambert310/article/details/52412059
pip install -U -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple/
```
-## 我在客户端 clone 了这个项目，速度太慢
+### 我在客户端 clone 了这个项目，速度太慢
如果有安装 `git bash`，可以加几个限制来减少下载量：
参考这篇文章：https://blog.csdn.net/FreeApe/article/details/46845555
-## 我没装过 python3
+### 我没装过 python3
可以访问 [Python 官网](https://www.python.org/downloads/) 了解更多信息。
-## 好像提示我 pip 版本过低
+### 好像提示我 pip 版本过低
进入 cmd / shell 之后
```
python -m pip install --upgrade pip
```
-## 我安装依赖失败了
+### 我安装依赖失败了
检查一下：网络？权限？查看错误信息？
-## 我已经 clone 下来了，为什么部署不了？
+### 我已经 clone 下来了，为什么部署不了？
检查一下是否安装好了依赖？
-## 我 clone 了很久之前的 repo，怎么更新到新版本呢？
+### 我 clone 了很久之前的 repo，怎么更新到新版本呢？
参考： https://help.github.com/articles/syncing-a-fork/
-## 如果是装了之前的依赖怎么更新
+### 如果是装了之前的依赖怎么更新
```
pip install -U -r requirements.txt
```
-## 我的数学公式怎么乱码了？
+### 我的数学公式怎么乱码了？
如果是行间公式（用的 `$$`），目前已知的问题是需要在 `$$` 两侧留有空行。格式如下：
------
-## 关于本项目
+### 关于本项目
Q：你们是为什么想要做这个 Wiki 的呢？
OSDN Git Service
