Markdown常用语法

2,924

本文总结和列举常用的Markdown格式，以帮助自己熟悉和方便日后查阅。

1. 段落、换行和缩进

  • 一个 Markdown 段落前后要有一个以上的空行（只有空格或制表符也会被视为空行）
  • 如果需要插入 <br/> 标签，在插入处先按入两个以上的空格然后回车。
  • 我们用 html 写作时，往往会在段首插入4个空格（或一个Tab）进行缩进，但是在 Markdown 中4个空格（或1个Tab）有其他意义（插入代码块，生成 <pre></pre>），如果需要缩进，可以用CSS实现，或输入两个全角空格。

2. 标题和分割线

Markdown提供了两种方式（Setext和Atx）来显示标题，Setext方式能生成一级和二级标题，Atx方式能生成一级到六级标题。

  • Setext方式：在文字底部加任意数量的 =或-，分别生成h1和h2
  • Atx方式：生成h1 ~ h6,在文字前面加上相应个数的 # 来实现。
  • 连续3个或以上* 、_或-符号，然后加一个空行，会生成一个 <hr/> 分割线。你也可以在符号中间插入空格。

示例：

Setext方式 一级标题
================== 
Setext方式 二级标题
------------------ 
# 一级标题
## 二级标题
###### 六级标题
---

输出：

Setext方式 一级标题

Setext方式 二级标题

一级标题

二级标题

六级标题

注：# 和「一级标题」之间建议保留一个字符的空格，这是最标准的 Markdown 写法。

3. 列表

  • 使用 *，+，- 表示无序列表
  • 使用 数字接着一个 . (英文句点) 表示有序列表，数字必须有，不过数字的大小并不影响输出的有序列表序号

示例：

- 无序列表项 一
- 无序列表项 二
- 无序列表项 三

输出：

  • 无序列表项 一
  • 无序列表项 二
  • 无序列表项 三

示例：

1. 有序列表项 一
3. 有序列表项 二
4. 有序列表项 三

输出:

  1. 有序列表项 一
  2. 有序列表项 二
  3. 有序列表项 三

4. 文字引用

  • 在每行的最前面加上>表示文字引用，相当于Html的 <blockquote></blockquote>，Markdown 也允许你偷懒只在整个段落的第一行最前面加上 >
  • 区块引用可以嵌套（例如：引用内的引用），只要根据层次加上不同数量的 >

示例：

> 我是一条被引用的语句。
> 我是另一条被引用的语句。

输出：

我是一条被引用的语句。
我是另一条被引用的语句。

嵌套引用示例:

> 我是一条被引用的语句。
> > 我是另一条被引用的语句。

嵌套引用输出：

我是一条被引用的语句。

我是另一条被引用的语句。

4. 链接

  • 行内式：使用 [锚文本](url "可选的title") 为文字增加外链接，可以使用相对路径。
  • 参考式：使用 [锚文本][ref_name]，接着，在文件的任意处，你可以把这个标记的链接内容定义出来 [ref_name]: url (可选的title) （方括号+冒号+空格+url+用括号、单引号或双引号包裹的title） 。通常的ref_name一般用数字表示，这样显得专业
  • 简写url：用尖括号包裹url，这样生成的url锚文本就是url本身

示例：

This is [my blog](//miu.im/ "Let's whisper") url.
[This link](//miu.im/) has no title attribute.
This is my [About](/about) page.

输出：

This is my blog url.
This link has no title attribute.
This is my About page.
http://miu.im

参考式示例：

This is my [blog][1] url, and this is my [about][2] page link.
[1]: http://miu.im (Let's whipser)
[2]: //miu.im/about "whipserer's about page"

输出：

This is my blog url, and this is my about page link.

5. 插入图像

插入图像跟插入链接的方式相似，只是在前面多加一个惊叹号 !

  • 使用 ![描述](url "可选的title")插入图像，支持相对路径。
  • 引用表示法: ![alt_text][id],预先定义 [id]:url "可选title"
  • 目前 Markdown 还无法指定图片的大小尺寸，如果需要可以使用普通的标签实现

示例：

![图片Alt描述](/misc/whisperer.jpg)

输出：

图片Alt描述

6. 斜体和粗体

  • 使用星号 * 和下划线 _ 作为标记强调字词的符号，在文字前后分别加上一个和两个符号，分别表示斜体（<em>）和粗体（strong），在文字前后加两个~，表示删除线 <del></del>

示例：

这是 *斜体*，这是 **粗体**。

输出:

这是 斜体，这是 粗体。

7. 行内代码块

  • 使用两个 `（反引号，键盘上Esc下方的键）包围代码，表示行内代码块，相当于Html的 <code></code> 。

示例：

`Markdown` 是一种简单高效的写作方式。

输出：

Markdown 是一种简单高效的写作方式。

8. 代码块

  • 使用4个空格（或一个Tab）表示代码块，生成 <pre></pre> 标签，一个代码区块会一直持续到没有缩进的那一行（或是文件结尾）。
  • 在代码块的开头和结尾分别插入三个反引号 ` 也可以生成 <pre></pre>
  • 由于 Markdown 不能添加class和id，要实现代码高亮工具的各种自定义设置，目前只能使用普通的html标签实现，如 <pre class="toolbar:2 nums:false" ></pre>。

示例：

    这是一个代码块，此行左侧有四个不可见的空格。

输出：

这是一个代码块，此行左侧有四个不可见的空格。

示例：

```
  $string = "Hello World!";
  echo $string;
```

输出：

  $string = "Hello World!";
  echo $string;

9. 表格支持

示例：

| Class        | Score   |  Rank  |
| --------   | -----:  | :----:  |
| Chinese     | 120 |   5     |
| English        |  136    |   1   |
| Math        |    145    |  1  |

输出：

Class Score Rank
Chinese 120 5
English 136 1
Math 145 1

10. Markdown符号转义

如果要插入普通的 Markdown 符号，可能需要进行转义，方式跟其他语言类似，在符号前加反斜杠 \ ,以下 Markdown 符号可以被转义：

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号

参考链接

  1. Markdown 语法说明 (简体中文版)
  2. 开始使用 Markdown
  3. 强大的文本编译工具 Pandoc，支持 markdown 和 html 之间的互译
  4. 作业部落出品：在线 Markdown 编辑器