F.A.Q.

交流方式

参见首页 QQ 群。

站长 QQ :3530235993

F.A.Q.

目录在哪

目录在项目根目录下的 mkdocs.yml 文件中。

如何修改一个页面的内容

在对应页面右上方有一个编辑按钮edit

如何添加一个知识点的页面

……

注意

写 .md 文件时,请勿在开头写上标题。

commit message 怎么写

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

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

推荐在 hosts 文件中加入如下几行:(来源: GoogleHosts-919f34e

1
2
3
4
5
6
# Github Start
13.250.177.223  gist.github.com
13.250.177.223  github.com
13.229.188.59   www.github.com
151.101.56.133  raw.githubusercontent.com
# Github End

可以在 GoogleHosts 主页 上了解到更多信息。

为什么我的 markdown 格式乱了

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

GitHub 是不是不显示我的数学公式?

是的,GitHub 的预览不显示数学公式。但是请放心,mkdocs 是支持数学公式的,可以正常使用,只要是 MathJax 支持的句式都可以使用。

我的数学公式怎么乱码了

如果是行间公式(用的 $$ ),目前已知的问题是需要在 $$ 两侧留有空行,且 $$单独 放在一行里(且不要在前加空格)。格式如下:

1
2
3
4
5
// 空行
$$
a_i
$$
// 空行

评论