说明
本文只列举了 MarkDown 的基本语法,对于技术文章已经足够用了。
本文所使用的 MarkDown 编辑器,为 “作业部落” 在线编辑器。
本文所有示例,左侧为原内容,右侧为显示效果。
本文即使用 MarkDown 编写。
参考
[1] https://zh.wikipedia.org/wiki/MarkDown
[2] http://xianbai.me/learn-md/index.html
0. MarkDown 简介
MarkDown是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。
它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。(from wikipedia)
1. 标题
MarkDown 使用不同数量的 #
表示对应级别的标题。
标题示例
2. 字体
MarkDown 使用不同数量的 *
和 ~
表示斜体、粗体、粗斜体、~~删除线~~。
字体示例
3. 换行
需使用 html 的换行符 <br>
。但很多 MarkDown 编辑器不需要使用换行符,直接按回车键就可以。
换行示例
4. 列表
4.1 有序列表
MarkDown 使用 数字+点号+空格
表示有序列表。
有序列表示例
4.2 无序列表
MarkDown 使用 星号+空格
表示无序列表,并用缩进表示层级。
无序列表示例
4.3 任务列表
MarkDown 使用 - [ ]
表示任务列表(中号内需有空格,横线和中括号之间也需要有空格),并用缩进表示层级,用 - [X]
表示任务完成。
任务列表示例
5. 链接和图片
链接和图片的用法类似,只在前面增加了一个叹号。
链接语法:[链接描述](链接的URL)
图片语法:[图片描述](图片的URL)
注意:链接的“链接描述”部分会显示出来,而图片不会。
链接和图片示例
6. 转义符
有一些字符为 MarkDown 或 html 固定字符,比如 * *
会被认为是斜体,但有时就需要显示这些字符本身。
对于 MarkDown 字符,可以使用反斜杠 转义。 Html 的尖括号 <>
使用 <
和 >
转义。
转义符示例
7. 引用
MarkDown 使用不同数量的右尖括号 >
表示引用。
8. 分隔符
MarkDown 使用不少于三个的 *
、-
、_
表示分割线。字符之间可以有空格,但不能有其他字符。 在不同的 MarkDown 编辑器中显示效果可能不同。
分隔符示例
9. 代码插入
代码块就和普通文本一样插入即可,不过需要在代码块前增加一个空行,并且每行代码前至少有一个 Tab 缩进。
行内代码使用 “``” 插入,这个符号是键盘左上角 ~ 按键的符号。
10. 表格
MarkDown 使用 |
来划分不同的列,使用 -
还划分表头和表内容,并在 -
前后添加 :
来表示本列的对齐方式。
表格插入示例