F.A.Q

目录在哪

网站显示内容的目录结构在项目根目录下的 mkdocs.yml 文件中。

如何修改一个 topic 的内容

• 在对应页面右上方有一个编辑按钮，点击之后会跳转到 Github 上对应文件的位置。

• 可以自行阅读目录 mkdocs.yml 查找文件位置。

• 由于 wiki 的内容尽量层次化，因此亦可以根据对应 topic 的类型，寻找对应的文件。

如何添加一个 topic

1. 可以开一个 Issue，注明希望能添加的内容
2. 可以开一个 Pull Request，在目录 mkdocs.yml 中加上新的 topic，并在 docs 文件夹下对应位置创建一个空的 .md 文件。

commit message 怎么写

我们推荐使用 commitizen/cz-cli 来规范 commit message （并非强求）。

我尝试访问 Github 的时候遇到了困难

推荐在 hosts 文件中加入如下几行：（来源： github访问慢应该怎么办）

# Github Start
103.245.222.249 github.global.ssl.fastly.net
103.245.222.133 assets-cdn.github.com
23.235.47.133  assets-cdn.github.com
203.208.39.104  assets-cdn.github.com
204.232.175.78  documentcloud.github.com
192.30.252.123  github.com
207.97.227.239  github.com
204.232.175.94  gist.github.com
107.21.116.220  help.github.com
207.97.227.252  nodeload.github.com
199.27.76.130  raw.github.com
107.22.3.110    status.github.com
204.232.175.78  training.github.com
207.97.227.243  www.github.com
185.31.16.184  github.global.ssl.fastly.net
185.31.18.133  avatars0.githubusercontent.com
185.31.19.133  avatars1.githubusercontent.com
# Github End

我安装依赖失败了

检查一下：网络？权限？查看错误信息？

我已经 clone 下来了，为什么部署不了

根据项目根目录下的requirements.txt检查是否安装好了依赖？

我 clone 了很久之前的 repo，怎么更新到新版本呢

参考：https://help.github.com/articles/syncing-a-fork/

如果是装了之前的依赖怎么更新

pip install -U -r requirements.txt

我的数学公式怎么乱码了

如果是行间公式（用的 $$），目前已知的问题是需要在 $$ 两侧留有空行。格式如下：

// 空行
$$ a_i $$
// 空行

为什么我的 markdown 格式乱了

可以查阅 cyent 的笔记，或者 MkDocs 使用说明。