diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9eeb34fc..a4b8b8be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,9 +99,9 @@ ## 文档网站构建 -除了直接部署Readme.md的HTML,还可以利用`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 @@ -120,4 +120,4 @@ $ mkdocs serve $ mkdocs build ``` -生成静态HTML网页, 存在于在`site/`文件夹下。Hosting的时候指向到`site/index.html`即可。 +生成静态 HTML 网页, 存在于在`site/`文件夹下。Hosting 的时候指向到`site/index.html`即可。