markdown语法

概述

哲学

Markdown 的目标是易读易写。html

Markdown强调可读性高于一切。一份Markdown格式的文档应该能直接以纯文本方式发布,而不致一眼看过去满眼都是标签和格式化指令。Markdown的语法确实受了几种现有的text转HTML过滤器影响--包括 SetextatxTextilereStructuredText,Grutatext, 和 EtText -- 其中对Markdown语法影响最大的单一来源是纯文本的Email格式。shell

为实现这一目标,Markdown的语法几乎所有由标点符号构成,这些标点符号都是精心挑选而来,尽可能作到能望文生义。如星号括着一个单词(Markdown中表示强调)看上去就像 *强调*。Markdown的列表看上去就像列表;Markdown的引文就象引文,和你使用email时的感受同样。编程

内嵌HTML

Markdown的语法为“方便地在网上写做”这一目标而生。浏览器

Markdown不是HTML替代品,也不是为了终接HTML。它的语法很是简单,只至关于HTML标签的一个很是很是小的子集。它并不是是为了更容易输入HTML标签而创造一种新语法。在我看来,HTML标签已经够容易书写的了。Markdown的目标是让(在网上)让读文章、写文章、修改文章更容易。HTML是一种适合发表的格式;而Markdown是一种书写格式。正因如此,Markdown的格式化语法仅需解决用纯文本表达的问题。markdown

对Markdown语法没法支持的格式,你能够直接用HTML。你不须要事先声明或者使用什么定界符来告诉Markdown要写HTML了,你直接写就是了。app

惟一的限制是那些块级HTML元素 -- 如 <div>,<table><pre><p>等等 -- 必须使用空行与相邻内容分开,而且块元素的开始和结束标签以前不要留有空格或TAB。Markdown足够聪明不会添加额外的(也是没必要要的)<p>标签包住这些块元素标签。编辑器

下面这个例子,在一篇Markdown文章中添加了一个HTML表格:ide

这是一个普通的段落。 <table> <tr> <td>Foo</td> </tr> </table> 这是另外一个普通的段落。

注意一点,不要在块级HTML元素内使用Markdown格式化命令,Markdown不会处理它们。好比你不要在一个HTML块中使用 *emphasis* 这样的Markdown格式化命令。ui

行内HTML标签 -- 如 <span><cite>, 或 <del> -- 在一个Markdown段落里、列表中、或者标题中--随便用。 若是须要,你甚至能够用HTML标签代替Markdown格式化命令。比方你能够直接用HTML标签 <a> 或 <img> 而不使用Markdown的连接和图片语法,随你的便。this

不一样于这些块级HTML元素,在HTML行内元素内的Markdown语法标记会被正确处理。

自动转换特殊字符

在HTML中,有两个字符须要特殊对待:<和 &<用于标签开始,&用于标识HTML实体。若是打算把它们当成普通字符,你必须使用反引号转义它们,如<&

对一些互联网做家来讲,&符号特别令人烦恼。若是你打算写'AT&T',你就得写 'AT&amp;T'。甚至在URL中也得想着转义&符号。比方你打算写:

http://images.google.com/images?num=30&q=larry+bird

你就得在A标签中把href属性中的URL编码成:

http://images.google.com/images?num=30&amp;q=larry+bird

不用说,这很容易忘。这每每是那些良构HTML站点中最容易出错的地方。

在Markdown中,你尽管天然的使用这些字符,只须要关心那些必要的转义。若是使用在HTML实体中使用&符号,它会保持不变;而在其它场合,它会转换成&

因此,若是你打算在文章中书写版权符号,你能够这样写:

&copy;

Markdown不会碰它。然而若是你书写

AT&T

Markdown就会把它翻译成:

AT&amp;T

相似的,既然Markdown支持内嵌HTML,若是你使用<做为HTML标签订界符,Markdown就会把它们当成HTML标签订界符。但是若是你书写:

4 < 5

Markdown就会把它翻译成:

4 &lt; 5

然而,在Mardown代码行内标记和块级标记之中,<&始终会被自动编码。这使得在Markdown文件中书写HTML代码更容易.(相对于纯HTML。若是想在纯在纯HTML里贴一段HTML代码,那才是糟糕透顶,必须对代码中的每个<&都转义才成。)

块级元素

段落和换行

一个段落由一行或多个相关文本行构成。段落之间用一个或多个空行分隔。(一个空行就是一个看上去什么也没有的行--若是一行什么也没有或者只有空格和TAB都会被视为空行)正常的段落不要以空白或TAB字符开始。

一行或多个相关文本行意味着Markdown支持“硬折行”。这一点与其它text转HTML的程序彻底不一样(包括Moveable Type的“Convert Line Breaks”选项),它们会将段落中的每个换行符转换成<br />标签。

若是你确实须要使用Markdown插入一个<br />换行符,只须要在每一行的末尾以两个或更多个空格符号结束,而后再打回车键。

没错,在Markdown里生成一个<br />稍稍有一点麻烦,但那种简单的“把每个换行符都转换成<br />规则”并不适用于Markdown。Markdown Email风格的 blockquoting 和 multi-paragraph list items更好用 -- 而且更美观 -- 在你用换行符对其格式化时。

标题

Markdown 支持两种风格的标题,Setext 和 atx.

Setext-风格的一级标题下面一行使用等号符号,二级标题下面使用连字符符号,例如:

这是一个一级标题 ============= 这是一个二级标题 -------------

至少有一个=-就能正常工做。

Atx-风格的标题在每行的开头使用1-6个井号字符,分别对应标题级别1-6。例如:

# 这是一级标题 ## 这是二级标题 ###### 这是六级标题

若是愿意, 你也能够 "结束" atx-风格的标题。这纯粹是美观考虑--若是你以为这样会看上更舒服些的话。结束用的井号个数随便,没必要与起始井号数量相同 (起始井号的数量决定标题级别):

# 这是一级标题 # ## 这是二级标题 ## ### 这是三级标题 ######

引用块

Markdown使用Email风格的 > 字符引用块。若是你熟悉Email中的引用块,你就知道在Markdown中如何使用引用块。若是每一行你都使用硬换行并在行首放一个>符号,看上去会很美观:

> 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.

(若是以为每行写一个>太累,)Markdown容许你偷懒,你只需在硬换行段落的第一行以前放一个>号:

> 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.

引用块中可包含其它Markdown元素,如标题、列表和代码块:

> ## This is a header. > > 1. This is the first list item. > 2. This is the second list item. > > Here's some example code: > > return shell_exec("echo $input | $markdown_script");

是个象样的文本编辑器都能实现Email风格的引用。好比在BBEdit里,你就能够选中一些文字以后从Text菜单里选择引用级别。

列表

Markdown 支持有序列表和无序列表

无序列表可以使用星号、加号和连字符(这几个符号是等价的,你喜欢哪一个就用哪一个)做为列表标记:

* Red * Green * Blue

等同于:

+ Red + Green + Blue

也等同于:

- Red - Green - Blue

有序列表则使用数字加英文句点:

1. Bird 2. McHale 3. Parish

有一点须要注意,你在列表中输入的标记数字并不会反映到Markdown输出的HTML之中。上面这个列表Markdown会输出为:

<ol> <li>Bird</li> <li>McHale</li> <li>Parish</li> </ol>

即便你写成下面这样:

1. Bird 1. McHale 1. Parish

甚至这样:

3. Bird 1. McHale 8. Parish

都会获得如出一辙(但正确的)输出。要点在于,若是你愿意,就在你的Markdown有序列表里顺序使用数字(这样源代码里的顺序和生成的顺序会一致),若是你但愿省点儿事,你就不用费心(去手工编号)。

若是你打算偷懒,记住列表的第一行使用数字 1。之后Markdown或许会支持有序列表从任意数字开始(译者注:这儿和前面的例子有点矛盾,原文如此)。

列表标记一般从左边界开始,至多能够有三个空格的缩进。列表标记以后至少要跟一个空格或TAB。

为了让列表看起来美观,你可使用TAB缩进列表项内容,使其整齐:

* 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.

不过若是你很懒,下面这样也行:

* 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.

若是列表项之间用空行分隔,Markdown就会在HTML输出中使用<p>标签包裹列表项。好比:

* Bird * Magic

生成的HTML以下:

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

而这个:

* Bird * Magic

生成的HTML是这样:

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

列表项有可能由多个段落组成,列表项的每一个后续段落必须缩进至少4个空格或者一个TAB:

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.

像上面这样缩进后续段落的每一行看起来很美观(但稍有些麻烦),若是你比较懒(和我同样),没问题,Markdown支持你:

* This is a list item with two paragraphs. This is the second paragraph in the list item. You're only required to indent the first line. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. * Another item in the same list.

要在列表项中使用引用,引用定界符 > 须要缩进:

* A list item with a blockquote: > This is a blockquote > inside a list item.

要在列表项中使用代码块,代码块须要缩进两次 -- 8个空格或者两个TAB:

* A list item with a code block: <code goes here>

有时候不当心会触发一个有序列表,比方在写相似下面这样的东西时:

1986. What a great season.

换言之, 以数字+句点+空格 序列起始的行会触发有序列表。为避免此状况,要对句点符号进行转义:

1986\. What a great season.

代码块

咱们常常在写有关编程或标记语言源代码时用到预格式化的代码块。不像格式化普通段落,代码块中的行会按字面进行解释。Markdown对代码块同时使用<pre> 和 <code>标签包裹:

在Markdown中要生成一个代码块,只须要在代码块内容的每一行缩进至少四个空格或者一个TAB。好比:

This is a normal paragraph: This is a code block.

Markdown会生成:

<p>This is a normal paragraph:</p> <pre><code>This is a code block.</code></pre>

Markdown会从生成的代码块中删除一级缩进 -- 4个空格或者1个TAB。看下面这个例子:

Here is an example of AppleScript: tell application "Foo" beep end tell

会获得:

<p>Here is an example of AppleScript:</p> <pre><code>tell application "Foo" beep end tell</code></pre>

代码块在遇到没有缩进的一行,或者文件末尾时自动结束。

在代码块中,&符号和<>会自动转换成HTML实体。所以在Markdown中包含HTML源代码只是小菜一碟--粘贴进去,缩进一下。剩下的脏活累活Markdown自会处理。看下面这个例子:

 <div class="sample_footer"> &copy; 2004 Foo Corporation </div>

Markdown会生成:

 
 

Markdown不会解析代码块中的Markdown标记。如代码块中的星号就是星号,失去了它原来的Markdown含义。这意味着你可以使用Markdown编写Markdown本身的语法教程。(就象这篇文章同样)。

水平线

若是在一行里只放三个或更多个连字符,或星号或下划线,你就会获得一个水平线标记(<hr />)。下面每一行都会获得一个水平线:

* * * *** ***** - - - ---------------------------------------

行内元素

连接

Markdown 支持两种风格的连接: 行内连接 和 引用连接.

两种风格的连接,连接文本都放在中括号以内[square brackets]。

要生成一个行内连接,在连接文本以后紧跟用一对小括号。小括号里放连接地址和可选的的连接title。若是提供连接title的话,连接title要用引号包起来。例如:

这是一个 [an example](http://example.com/ "Title") 行内连接。 [这个连接](http://example.net/) 没有title属性。

Markdown会生成:

<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>

若是你打算引用一个本地资源或者同一站点的资源,可使用相对路径:

若是想进一步了解我,请参阅个人 [关于我](/about/) 页。

引用风格的连接,在连接文本以后紧跟又一对中括号。这对中括号里放的是该连接的标识符(能够理解为别名):

这是一个引用型连接 [示例][id]。

若是你嫌弃两对中括号过于亲密,Markdown容许你在两对中括号之间放一个空格:

这是一个引用型连接 [示例] [id]。

而后,咱们能够在文档的任意位置,像下面这样定义连接标识与连接的对应关系(一行一个连接):

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

即:

  • 中括号内放连接标识符(行前可选缩进,至多不超过三个空格);
  • 以后紧跟一个冒号;
  • 再后面是一个或多个空格(TAB也行);
  • 接下来是连接URL;
  • 最后面是可选的用双引号或单引号或小括号括起来的连接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 版本有一个已知的bug,用单引号做为连接title的定界符会出问题。

至于连接URL,还支持使用一对可选的尖括号包裹起来:

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

你也能够将连接的title属性放在下一行并使用额外的空格或TAB填充,这样较长的URL会比较美观:

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

链妆定义仅供Markdown解析器使用。最终输出的HTML当中不会包含连接定义。

连接标识符能够由字母、数字、空格和标点符号组成--不区分大小写。下面这两个连接:

[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/

连接定义可放于Markdown文档的任意位置。我建议把它们就近放到最早使用它的段落以后。不过若是你更喜欢放到文档末尾,当成某种形式的尾注,随你的便。

下面是一些引用连接的例子:

I get 10 times more traffic from [Google] [11] than from [Yahoo] [12] or [MSN] [13]. [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容许将标记有关的元数据移到段落以外,你尽管添加连接,而没必要担忧打断文件的故事情节。

强调

Markdown使用星号(*)和下划线(_)做为表示强调。用一个 * 或 _ 包裹的文本会使用 HTML<em> 标签包裹; 用两个 * 或 _包裹的文本会使用HTML<strong> 标签包裹。如:

*single asterisks* _single underscores_**double asterisks** __double underscores__

将会输出为:

<em>single asterisks</em> <em>single underscores</em> <strong>double asterisks</strong> <strong>double underscores</strong>

你喜欢哪种风格就用哪种,惟一的限制就是起始字符与关闭字符必须一致。

强调符号可用于一个单词的一部分:

un*frigging*believable

不过若是你用空格包裹单独的 * 或 _,它们就失去了强调的含义,而成为字面上的星号或下划线。

若是不想让Markdown解释这两个元字符,就转义它:

\*this text is surrounded by literal asterisks\*

代码

要在行内表示部分代码,用反引号(`)包住它。与预格式代码块不一样和,行内代码用于段落以内。例如:

Use the `printf()` function.

会生成:

<p>Use the <code>printf()</code> function.</p>

要在一个行内代码中使用反引号(`)自己,用多个反引号做为定界符包住它:

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

这样就会获得:

<p><code>There is a literal backtick (`) here.</code></p>

包住行内代码的反引号定界符能够包括空格--即在起始反引号以后,结束反引号以前能够有一个空格。这使得咱们可以在行内代码的开始或结束处使用反引号:

A single backtick in a code span: `` ` `` A backtick-delimited string in a code span: `` `foo` ``

会生成:

<p>A single backtick in a code span: <code>`</code></p> <p>A backtick-delimited string in a code span: <code>`foo`</code></p>

在行内代码中,&<>会自动编码为HTML实体,以方便包含HTML标签。Markdown会把下面这行:

Please don't use any `<blink>` tags.

转换为:

<p>Please don't use any <code><blink></code> tags.</p>

你也能够这样写:

`&#8212;` is the decimal-encoded equivalent of `&mdash;`.

会获得:

<p><code>&#8212;</code> is the decimal-encoded equivalent of <code>&mdash;</code>.</p>

图片

必须认可,要以“天然的”语法把一个图片放到一个纯文本文档之中,确实是一个挑战。

Markdown使用了相似连接语法来表示图片,一样有两种风格:行内图片引用图片

行内图片语法示例:

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

即:

  • 一个感叹号!开头;
  • 其后紧跟一对中括号,中括号内存放图片的alt`属性;
  • 其后紧跟一对小括号,小括号内存放图片的URL或路径,及可选的用双引号或单引号或小括号括起来的图片title

引用图片语法以下:

![Alt text][id]

这里 "id" 是图片引用标识。图片引用定义的语法与连接定义彻底相同:

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

在写这篇文章时,Markdown尚未语法指定图片的大小,若是这一点对你特别重要,你能够直接使用<img>标签。

杂七杂八

自动连接

Markdown提供了一种快捷方式"自动地"定义连接和Email地址:直接用一对尖括号把URL或Email地址包住。这表示连接文本就是URL自己,Email文本就是Email自己。这样你就获得了一个可点击的连接,如:

<http://example.com/>

Markdown会将它转换为:

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

自动Email地址工做方式类似,只有一点不一样。Markdown自动的用一些十进制和十六进制数字表示你的Email,以防止遭遇垃圾邮件袭击。 例如:

<address@example.com>

会被转换为:

<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>

浏览器会将它渲染为一个可点击的连接,并正确显示 "address@example.com"。

(这种实体编码的小方法能够骗过一些收集邮件地址的机器人,不过它确实没法骗过全部的机器人。有总比没有强,聊胜于无。能阻止一点就阻止一点好了。)

反斜线转义

Markdown容许你使用反斜线转义那些Markdown元字符,让它们失去原有的“魔力”。举个例子,若是你确实想用星号包住一个词组(而不是想获得<em>标签),就能够在星号以前使用反斜线将其转义。即:

\*literal asterisks\*

Markdown中,如下字符支持使用反斜线转义:

\ 反斜线 ` 反引号 * 星号 _ 下划线 {} 大括号 [] 中括号 () 小括号 # 井号 + 加号 - 减号(连字符) . 句点 ! 感叹号
相关文章
相关标签/搜索