Markdown用法简记

概述

Markdown 的目标是实现「易读易写」。

Markdown 是一种轻量级的「标记语言」，Markdown 的格式语法只涵盖纯文本可以涵盖的范围，一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布，并且看起来不会像是由许多标签或是格式指令所构成。

语法

兼容HTML

不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。
在 HTML 文件中，需要特殊处理的两个字符： < 和 & 会根据使用的场景自动转换为 < 和 &amp ;

基本语法

使用空白行来分割段落，很多Markdown语法都是基于段落的，例如：引用，在段落的开始处使用引用符号后，同一个段落的文字（即紧邻的下一行和其后连续的多行）都会被视为引用内容。
使用反斜杠 \ 来展示特殊字符，例如展示星号符 * 则使用 \*

标题

在文字的下一行使用===表示1级标题
在文字的下一行使用---表示2级标题

注：标题级别和=或-的数量无关
注：需要多级标题，可以在文字前方加n个#号来表示n级标题，支持1-6级标题

例子：

一级标题===二级标题---# 一级标题## 二级标题### 三级标题###### 六级标题

粗体和斜体

使用*将文字括住，展示 斜体 样式
使用**将文字括住，展示 粗体 样式

例子：

*斜体***粗体**

图片，超链接和邮件链接

图片语法：![Alt text](/path/to/img.jpg "Optional title") 效果：在该处代码出会展现对应的图片。
其中，”Alt text”是图片的代替文字；括号里为图片的链接地址，可以为绝对的url地址或者相对地址；”Optional title”为可选的提示文字，在鼠标悬浮在图片上时进行展示。

超链接和邮件链接都可以简写为：
<http://example.com/> 效果：http://example.com/
<[e-mail]> 效果：[e-mail]

超链接的一般格式（称为行内式）：
[an example](http://example.com/ "Title") 效果：an example
其中，”an example”为超链接的文字；括号里为超链接的地址，可以为绝对url地址或者相对地址；”Title”为可选的提示文字，在鼠标悬浮在超链接上时进行展示。

超链接的参考式：

详情可以在网站查阅： [Google] [1] ，[Yahoo] [2] 或 [MSN] [3].  [1]: http://google.com/        "Google"  [2]: http://search.yahoo.com/  "Yahoo Search"  [3]: http://search.msn.com/    "MSN Search"

展现效果：
详情可以在网站查阅： Google ，Yahoo 或 MSN.

*注：后面所列的3个参考链接[1]，[2]，[3]是不可见的，即不会对外展示任何内容；只有引用链接处才会展示为超链接文字

引用

在段落的最前面加入大于号 > ，表示该段落使用引用的格式。

例如：

>这是引用的文字>引用的内容第2行

效果如下：

这是引用的文字
引用的内容第2行

注：引用是以段落为单位，即上面示例中的第2行，去掉开头的 >，其效果不变

代码段

使用一个或多个反引号 ` 来括起来的文字或代码按照代码格式进行展示。
使用4个空格或者1个制表符的缩进也会让该行展示代码段的展示效果
一般使用2个反引号来括住在段落中需要以代码格式展示的部分文字，而以缩进来表示包含多行的代码段落。

例如：
``words`` 效果：words

注：使用4个空格或者1个制表符的缩进也可以指定代码段的展示效果

列表

使用星号 * 开头的行会展示为无序列表样式

例如：

* 列表项1* 列表项2

效果：
- 列表项1
- 列表项2

注：Markdown标记里，该处使用 *， +， - 会获得相同的效果

分割线

使用3个星号 * 可以展示为一条分割线

例如：

***

效果：

---

注：Markdown标记里，该处使用 *， +， - 会获得相同的效果

表格

注：表格非Markdown官方支持的标记，属于Markdown扩展，参见Gitlab。使用Markdown编辑的网站有可能支持，慎用
格式：使用竖直线 | 来分割表格的字段，可以使用冒号来定义表格的对齐方式

举例：

| Tables | Are | Cool || :-- |:--:| --:|| col 3 is | right-aligned | $1600 || col 2 is | centered | $12 |

展示效果：

Tables Are Cool col 3 is right-aligned $1600 col 2 is centered $12

Markdown编辑器

参见Markdown语法说明和简书Markdown入门指南