From 3ad7bf6f16a3662850e10ee1e4f1b051a82206dd Mon Sep 17 00:00:00 2001
From: Anduin Xue <Anduin@aiursoft.com>
Date: Tue, 1 Mar 2022 00:59:17 +0800
Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=AD=A3=E4=B8=80=E4=BA=9Bmarkdown?=
 =?UTF-8?q?=E6=8E=92=E7=89=88=E3=80=82?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CONTRIBUTING.md | 26 +++++++++++++++-----------
 1 file changed, 15 insertions(+), 11 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 44f81bc8..9eeb34fc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -97,23 +97,27 @@
 - 确保他没有签入任何个人身份信息、EUII、Email 地址、GitHub 用户名
 
 
-## Documentation Hosting
+## 文档网站构建
 
-利用`mkdocs-material`来render markdown文件。
+除了直接部署Readme.md的HTML，还可以利用`mkdocs-material`来render markdown文件。这会得到更加漂亮的页面。
 
-`./docs` 文件夹的存在是workaround mkdocs要求`.md`文件不能存在于根目录中。里面全部是relative symlink到
-实际的文件/文件夹
+`./docs` 文件夹的存在是workaround mkdocs要求`.md`文件不能存在于根目录中。里面全部是relative symlink到实际的文件夹
 
 需求: Python > 3.6
 
-如何使用：
-```
-pip install -r requirements.txt
-mkdocs serve
+### 调试
+
+```bash
+$ pip install -r requirements.txt
+$ mkdocs serve
 ```
 
-Documentation可以在本地 http://localhost:8000/ 打开。
+可以在本地 http://localhost:8000/ 打开。
 
-管理员：
-用`mkdocs build` 生成静态HTML网页, 存在于在`site/`文件夹下。Hosting的时候指向到`site/index.html`即可。
+### 编译
 
+```bash
+$ mkdocs build
+```
+
+生成静态HTML网页, 存在于在`site/`文件夹下。Hosting的时候指向到`site/index.html`即可。