几乎所有 Git 平台在 Pull request
/ Issue
等功能上大量使用 Markdown 语法,所以在这里简单介绍并给出效果预览,以方便使用。
一级标题
二级标题
三级标题
四级标题
有序列表:
- this
- is
- a
- test
- list
无序列表:
- this
- is
- a
- test
- list
还有一种写法:
- this
- is
- a
- test
- list
有序列表:
- this
- is
- a
- test
- list
有序列表和无序列表中间都可以加一行空行,Markdown 会自动调整行间距更大,方便阅读。
- 高亮
This is a example
text.
- 加粗
This is a example text.
- 斜体
This is a example text.
- 引用:
This is a example text.
分割线(就是上面这个,几个连接符-
)
另外:
以上语法全部可以嵌套使用。
在换行时必须使用中间空一行的方式,以方便在纯文本模式下的 Markdown 可读性。
列表、标题符号之后必须带一个空格再写文本。
扩展阅读:https://www.jianshu.com/p/3dbef7dd9c8e、https://www.jianshu.com/p/468f111d8fd3。
支持预览的在线编辑器:https://www.zybuluo.com/mdeditor。