Markdown 语法笔记

时间 2019-11-10 标签 markdown 语法笔记

不久前狗大V —— 性感玉米在微博中说：css

必需要歌颂一下 Markdown 了，自称是语法很容易 Shock 到普通 User，其实要学的，一对手就数得过来。对能熟练背诵江户四十八手的玩家来讲不是问题。简易培训以后（比斯大林格勒保卫战中的肉盾培训时间略长）炸裂到彻底能够实如今双手不离开键盘的状况下进行简单的格式处理（绝对够用），伟大！相见恨晚！git

哈哈哈，狗大 V 都已经在学 Markdown 了，简直炸裂！不记得是去年仍是前年学习了 Markdown，相见恨晚，已经到了写文章、文档无 Markdown 不欢、寝食不安、没法下指敲键盘的地步了。一个网站若是不支持 Markdown 在我心中更会大打折扣。学习 Markdown 已经很长时间了，Markdown 语法简单易记，可是有时候遇到嵌套或者别的老是会有点晕。这里记载下 Markdown 语法，以供往后查阅。github

本文主要分为如下几部分：算法

Markdown 基本语法
- 兼容 HTML
- 段落和换行
- 区块引用 Blockquotes
- 列表
- 代码区块
- 分隔线
- 连接
- 强调
- 代码
- 图片
- 自动连接
GitHub 风格的 Markdown 语法
- 连接自动识别
- 围栏式代码块
- 任务清单
- 任务清单
- @
- Emoji
- table
- 强调
一些和排版有关的资源
参考文章

Markdown 语法

想要从头至尾一步步学习 Markdown 语法，请点击 http://wowubuntu.com/markdown/ 阅读, 这里只记录下对我来讲比较容易弄混的语法。shell

兼容 HTML

一些 HTML 区块元素――好比 <div>、<table>、<pre>、<p> 等标签，必须在先后加上空行与其它内容区隔开，还要求它们的开始标签与结尾标签不能用制表符或空格来缩进。在 HTML 区块标签间的 Markdown 格式语法将不会被处理。好比，你在 HTML 区块内使用 Markdown 样式的 * 强调 * 会没有效果。ubuntu

这是一个普通段落。

<table>
    <tr>
        <td>Foo</td>
    </tr>
</table>

这是另外一个普通段落。

效果：浏览器

这是一个普通段落。ruby

<table>
    <tr>
        <td>Foo</td>
    </tr>
</table>

这是另外一个普通段落。markdown

段落和换行

一个 Markdown 段落是由一个或多个连续的文本行组成，它的先后要有一个以上的空行（空行的定义是显示上看起来像是空的，便会被视为空行。比方说，若某一行只包含空格和制表符，则该行也会被视为空行）。普通段落不应用空格或制表符来缩进。框架

若是你确实想要依赖 Markdown 来插入 <br /> 标签的话，在插入处先按入两个以上的空格而后回车。

区块引用

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitrisus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.

效果：

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

或者只在整个段落的第一行最前面加上 > ：

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
  consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
  Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
  id sem consectetuer libero luctus adipiscing.

效果：

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

区块引用能够嵌套（例如：引用内的引用），只要根据层次加上不一样数量的 > ：

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

效果：

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

引用的区块内也可使用其余的 Markdown 语法，包括标题、列表、代码区块等：

> ## 这是一个标题。
>
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
>
> 给出一些例子代码：
>
>     return shell_exec("echo $input | $markdown_script");

效果：

这是一个标题。

这是第一行列表项。

这是第二行列表项。

给出一些例子代码：
return shell_exec("echo $input | $markdown_script");

列表

列表项目标记一般是放在最左边，可是其实也能够缩进，最多 3 个空格，项目标记后面则必定要接着至少一个空格或制表符。

若是列表项目间用空行分开，在输出 HTML 时 Markdown 就会将项目内容用 <p> 标签包起来，举例来讲：

* Bird
* Magic

会被转换为：

<ul>
<li>Bird</li>
<li>Magic</li>
</ul>

可是这个：

* Bird

* Magic

会被转换为：

<ul>
<li><p>Bird</p></li>
<li><p>Magic</p></li>
</ul>

列表项目能够包含多个段落，每一个项目下的段落都必须缩进 4 个空格或是 1 个制表符：

1.  This is a list item with two paragraphs. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit. Aliquam hendrerit
    mi posuere lectus.

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
    sit amet velit.

2.  Suspendisse id sem consectetuer libero luctus adipiscing.

效果：

This is a list item with two paragraphs. Lorem ipsum dolor
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
mi posuere lectus.

Vestibulum enim wisi, viverra nec, fringilla in, laoreet
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.

若是要在列表项目内放进引用，那 > 就须要缩进：

*   A list item with a blockquote:

    > This is a blockquote
    > inside a list item.

效果：

A list item with a blockquote:

This is a blockquote
inside a list item.

若是要放代码区块的话，该区块就须要缩进两次，也就是 8 个空格或是 2 个制表符：

*   一列表项包含一个列表区块：

            <代码写在这>

效果：

一列表项包含一个列表区块：
```
<代码写在这>
```

固然，项目列表极可能会不当心产生，像是下面这样的写法：

1986. What a great season.

效果：

What a great season.

换句话说，也就是在行首出现数字-句点-空白，要避免这样的情况，你能够在句点前面加上反斜杠。

1986\. What a great season.

效果：

1986. What a great season.

代码区块

要在 Markdown 中创建代码区块很简单，只要简单地缩进 4 个空格或是 1 个制表符就能够，一个代码区块会一直持续到没有缩进的那一行（或是文件结尾）。例如，下面的输入：

这是一个普通段落：

    这是一个代码区块。

效果：

这是一个普通段落：

这是一个代码区块。

段落和换行

你能够在一行中用三个以上的星号、减号、底线来创建一个分隔线，行内不能有其余东西。你也能够在星号或是减号中间插入空格。

连接

Markdown 支持两种形式的连接语法： 行内式 和 参考式 两种形式。

不论是哪种，连接文字都是用 [方括号] 来标记。

要创建一个 行内式 的连接，只要在方块括号后面紧接着圆括号并插入网址连接便可，若是你还想要加上连接的 title 文字，只要在网址后面，用双引号把 title 文字包起来便可，例如：

This is [an example](http://example.com/ "Title") inline link.

[This link](http://example.net/) has no title attribute.

会产生：

<p>This is <a href="http://example.com/" title="Title">
    an example</a> inline link.</p>

<p><a href="http://example.net/">This link</a> has no
    title attribute.</p>

若是你是要连接到一样主机的资源，你可使用相对路径：

See my [About](/about/) page for details.

参考式 的连接是在连接文字的括号后面再接上另外一个方括号，而在第二个方括号里面要填入用以辨识连接的标记：

This is [an example][id] reference-style link.

你也能够选择性地在两个方括号中间加上一个空格：

This is [an example] [id] reference-style link.

接着，在文件的任意处，你能够把这个标记的连接内容定义出来：

[id]: http://example.com/  "Optional Title Here"

连接内容定义的形式为：

方括号（前面能够选择性地加上至多三个空格来缩进），里面输入连接文字
接着一个冒号
接着一个以上的空格或制表符
接着连接的网址
选择性地接着 title 内容，能够用单引号、双引号或是括弧包着

下面这三种连接的定义都是相同：

[foo]: http://example.com/  "Optional Title Here"
[foo]: http://example.com/  'Optional Title Here'
[foo]: http://example.com/  (Optional Title Here)

请注意：有一个已知的问题是 Markdown.pl 1.0.1 会忽略单引号包起来的连接 title。

连接网址也能够用尖括号包起来：

[id]: <http://example.com/>  "Optional Title Here"

你也能够把 title 属性放到下一行，也能够加些缩进，若网址太长的话，这样会比较好看：

[id]: http://example.com/longish/path/to/resource/here
        "Optional Title Here"

网址定义只有在产生连接的时候用到，并不会直接出如今文件之中。

连接辨别标签能够有字母、数字、空白和标点符号，可是并不区分大小写，所以下面两个连接是同样的：

[link text][a]
[link text][A]

隐式连接标记 功能让你能够省略指定连接标记，这种情形下，连接标记会视为等同于连接文字，要用隐式连接标记只要在连接文字后面加上一个空的方括号，若是你要让 "Google" 连接到 google.com，你能够简化成：

[Google][]

而后定义连接内容：

[Google]: http://google.com/

因为连接文字可能包含空白，因此这种简化型的标记内也许包含多个单词：

Visit [Daring Fireball][] for more information.
而后接着定义连接：

[Daring Fireball]: http://daringfireball.net/

连接的定义能够放在文件中的任何一个地方，我比较偏好直接放在连接出现段落的后面，你也能够把它放在文件最后面，就像是注解同样。

下面是一个参考式连接的范例：

I get 10 times more traffic from [Google] [1] than from
    [Yahoo] [2] or [MSN] [3].

    [1]: http://google.com/        "Google"
    [2]: http://search.yahoo.com/  "Yahoo Search"
    [3]: http://search.msn.com/    "MSN Search"

若是改为用连接名称的方式写：

I get 10 times more traffic from [Google][] than from
    [Yahoo][] or [MSN][].

    [google]: http://google.com/        "Google"
    [yahoo]:  http://search.yahoo.com/  "Yahoo Search"
    [msn]:    http://search.msn.com/    "MSN Search"

上面两种写法都会产生下面的 HTML。

<p>I get 10 times more traffic from <a href="http://google.com/"
    title="Google">Google</a> than from
    <a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a>
    or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>

下面是用行内式写的一样一段内容的 Markdown 文件，提供做为比较之用：

I get 10 times more traffic from [Google](http://google.com/ "Google")
    than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or
    [MSN](http://search.msn.com/ "MSN Search").

参考式的连接其实重点不在于它比较好写，而是它比较好读，比较一下上面的范例，使用参考式的文章自己只有 81 个字符，可是用行内形式的却会增长到 176 个字元，若是是用纯 HTML 格式来写，会有 234 个字元，在 HTML 格式中，标签比文本还要多。

使用 Markdown 的参考式连接，可让文件更像是浏览器最后产生的结果，让你能够把一些标记相关的元数据移到段落文字以外，你就能够增长连接而不让文章的阅读感受被打断。

强调

Markdown 使用星号（*）和底线（_）做为标记强调字词的符号，被 * 或 _ 包围的字词会被转成用 <em> 标签包围，用两个 * 或 _ 包起来的话，则会被转成 <strong>

可是若是你的 * 和 _ 两边都有空白的话，它们就只会被当成普通的符号。

若是要在文字先后直接插入普通的星号或底线，你能够用反斜线：

代码

若是要在代码区段内插入反引号，你能够用多个反引号来开启和结束代码区段：

``There is a literal backtick (`) here.``、

效果：

There is a literal backtick (`) here.、

图片

Markdown 标记图片容许两种样式： 行内式 和 参考式。

行内式的图片语法看起来像是：

![Alt text](/path/to/img.jpg)

![Alt text](/path/to/img.jpg "Optional title")

详细叙述以下：

一个惊叹号 !
接着一个方括号，里面放上图片的替代文字
接着一个普通括号，里面放上图片的网址，最后还能够用引号包住并加上
选择性的 'title' 文字。

参考式的图片语法则长得像这样：

![Alt text][id]

「id」是图片参考的名称，图片参考的定义方式则和连结参考同样：

[id]: url/to/image  "Optional title attribute"

自动连接

Markdown 支持以比较简短的自动连接形式来处理网址和电子邮件信箱，只要是用尖括号包起来， Markdown 就会自动把它转成连接。通常网址的连接文字就和连接地址同样

<http://example.com/>

Markdown 会转为：

<a href="http://example.com/">http://example.com/</a>

电子邮件地址：

<address@example.com>

Markdown 会转成：

<a href="&#x6D;&#x61;i&#x6C;&#x74;&#x6F;:&#x61;&#x64;&#x64;&#x72;&#x65;
&#115;&#115;&#64;&#101;&#120;&#x61;&#109;&#x70;&#x6C;e&#x2E;&#99;&#111;
&#109;">&#x61;&#x64;&#x64;&#x72;&#x65;&#115;&#115;&#64;&#101;&#120;&#x61;
&#109;&#x70;&#x6C;e&#x2E;&#99;&#111;&#109;</a>

在浏览器里面，这段字串（实际上是 <a href="mailto:address@example.com"> address@example.com </a>）会变成一个能够点击的「address@example.com」连接。

GitHub 风格的 Markdown 语法

连接自动识别

传统 Markdown 自动识别连接须要在连接上用一对尖括号闭合，而 GFM 只须要输入连接即自动识别。Email 地址亦是。

围栏式代码块

传统 Markdown 使用 4 个空格缩进将文本转换为代码块，GFM 支持在代码块先后加三个反引号 ```，并且还能够在代码块前加上语言类型标识，Github 会自动识别语言，给语法着色、代码加亮。

例如：

```js
alet("Hello world!");
```

任务清单

列表可被转换为任务清单，只须要为列表项的开头加上 [ ] 或 [x] 便可（分别表示未完成和已完成）。

- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item


- [x] 支持 @提到某人、#引用、[连接]()、**格式化** 和 <del>标签</del> 等语法
- [x] 须要使用列表语法来激活（无序或有序列表都可）
- [x] 这是一个已完成项目
- [ ] 这是一个未完成项目

这个特性会在 Issue 和 Pull Request 的描述和评论中启用。任务清单一样可用于 Gist 的评论和 Markdown 格式的 Gist。在这些场合，任务清单将渲染出复选框，供勾选或清除。

@

按下 @ 符号将弹出一个列表，列出这个项目相关的人或团队,即 @ 提到人名或团队名时的自动补全。这个列表会随着你的输入不断匹配筛选，所以一旦你在列表中发现了你要找的人名或团队名，你就能够用方向键来选中它，而后按回车或 tab 键来补全。对于团队来讲，只须要输入 @组织名/团队名，那么团队内的全部成员都将收到提醒。

列表的匹配范围仅限制在当前仓库的贡献者以及当前讨论的参与者，所以它并非一个全局性的搜索。它和文件查找器使用相同的模糊筛选算法，而且同时适用于用户名和全名。

Emoji

按下 : 将会弹出一个表情符号的建议列表。这个列表会随着你的输入不断匹配筛选，所以一旦你在列表中发现了你要找的表情符号，你就能够按回车或 tab 键来补全当前高亮的那一项。

更多的 emoji 表情能够猛击 EMOJI CHEAT SHEET。

table

你可使用若干列文字并于第一行下面用转折号-分开它们，而后用管道符|隔开每一列：

First Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell

为了看上去美观，你也能够在两端加上额外的管道符：

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

注意顶部的虚线不须要准确匹配表头文本的长度：

| Name | Description          |
| ------------- | ----------- |
| Help      | Display the help window.|
| Close     | Closes a window     |

你也能够在其中包括内联 Markdown 元素，好比连接，加粗，斜体或删除

| Name | Description          |
| ------------- | ----------- |
| Help      | ~~Display the~~ help window.|
| Close     | _Closes_ a window     |

最后，经过在表头行加入冒号:，你能够决定文本是左对齐，右对齐，仍是居中：

| Left-Aligned  | Center Aligned  | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is      | some wordy text | $1600 |
| col 2 is      | centered        |   $12 |
| zebra stripes | are neat        |    $1 |

一个在最左边的冒号表示一个左对齐的列；一个在最右边的冒号表示一个右对齐的列；两边都有的冒号表示一个居中的列。

强调

用在字母中间放一条线来强调文字可以使用

~~this~~

效果为

~~this~~

一些和排版有关的资源

Web 中文字体应用指南
中文排版的最佳实践
Entry.css

Customizable and readable less library for Chinese text. 一个可配置的、更适合阅读的中文文章样式库
typo.css

中文网页重设与排版：一致化浏览器排版效果，构建最适合中文阅读的网页排版
yue.css

A typography stylesheet for readable content
chinese-copywriting-guidelines

Chinese Copywriting Guidelines：中文文案排版指北
Han.css

「漢字標準格式」印刷品般的漢字排版框架 Han.css: the CSS typography framework optimised for Hanzi.

参考文章

本文同步更新于个人博客 paddingme,文章连接为：http://padding.me/blog/2015/01/14/my-markdown-syntax-notes/