首先声明,这份文档可能不完整,因为它是基于我日常的使用来整理的,如果有一些语法我还没有使用到,就不会记录在这份文档上面。但是,我会不定期更新这份文档,把自己使用到的越来越多的语法整理进来,这样就可以不断完善这份文档,从而越来越接近标题中的 语法手册 。
最近更新于:2019-11-01 。
语法手册
标题
使用井号表示:#,一个代表一级标题,两个代表二级标题,三个代表三级标题,以此类推,最多可以有六级标题。
换行
在 GitHub 中写 README.MD 文档,正常的一个换行在被 GitHub 解析后展示出来不是换行,内容仍旧在同一行。如果需要显示出换行,在 README.MD 文件中需要连续 2 个换行,经过 GitHub 解析后才是一个真正的换行。
如果使用连续的 3 个横杠符号:---,会产生分割线的效果,相当于在普通的换行基础上加了一个标识。
代码块
如果是少量的几个单词,可以直接使用两个反斜点表示,即键盘左上角那个波浪号按键。
如果内容有多行,并且满足某种语言,例如 Java、Python、JSON 等,则可以使用一对 3 个连续的反斜点表示,在前面连续 3 个反斜点后面跟上语言类型:
1 | xxx |
加粗
4 个星号。
斜体
xx
中划线
中划线,达到删除的效果:
1 | ~~ 这是中划线~~ |
链接
列表
无序列表
有序列表
表格
表格的使用【居中、加粗、边框线】
1 |

