1. Markdown 语法规范

1.1 常用语法

1.1.1 段落、标题、区块程式码

一个段落是由一个以上的连接的行句组成,而一个以上的空行则会切分出不同的段落(空行的定义是显示上看起来像是空行,就被视為空行,例如有一行只有空白和 tab,那该行也会被视為空行),一般的段落不需要用空白或断行缩排。

Markdown 支援两种标题的语法,[Setext] 1 和 [atx] 2 形式。Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),Atx 形式在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶。

区块引言则使用 email 形式的 ‘>‘ 角括号。

Markdown:

A First Level Header
====================

A Second Level Header
---------------------

Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.

The quick brown fox jumped over the lazy
dog's back.

### Header 3

> This is a blockquote.
> 
> This is the second paragraph in the blockquote.
>
> ## This is an H2 in a blockquote

输出:

<h1>A First Level Header</h1>

<h2>A Second Level Header</h2>

<p>Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.</p>

<p>The quick brown fox jumped over the lazy
dog's back.</p>

<h3>Header 3</h3>

<blockquote>
    <p>This is a blockquote.</p>

    <p>This is the second paragraph in the blockquote.</p>

    <h2>This is an H2 in a blockquote</h2>
</blockquote>

1.1.1.1 修辞和强调

Markdown 使用星号和底线来标记需要强调的区段。

Markdown:

Some of these words *are emphasized*.
Some of these words _are emphasized also_.

Use two asterisks for **strong emphasis**.
Or, if you prefer, __use two underscores instead__.

输出:

<p>Some of these words <em>are emphasized</em>.
Some of these words <em>are emphasized also</em>.</p>

<p>Use two asterisks for <strong>strong emphasis</strong>.
Or, if you prefer, <strong>use two underscores instead</strong>.</p>

1.1.2 清单

无序清单使用星号、加号和减号来做為清单的项目标记,这些符号是都可以使用的,使用星号:

*   Candy.
*   Gum.
*   Booze.

加号:

+   Candy.
+   Gum.
+   Booze.

和减号

-   Candy.
-   Gum.
-   Booze.

都会输出:

<ul>
<li>Candy.</li>
<li>Gum.</li>
<li>Booze.</li>
</ul>

有序的清单则是使用一般的数字接著一个英文句点作為项目标记:

1.  Red
2.  Green
3.  Blue

输出:

<ol>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
</ol>

如果你在项目之间插入空行,那项目的内容会备用 <p> 包起来,你也可以在一个项目内放上多个段落,只要在它前面缩排 4 个空白或 1 个 tab 。

*   A list item.

    With multiple paragraphs.

*   Another item in the list.

输出:

<ul>
<li><p>A list item.</p>
<p>With multiple paragraphs.</p></li>
<li><p>Another item in the list.</p></li>
</ul>

1.1.2.1 连结

Markdown 支援两种形式的连结语法: 行内参考 两种形式,两种都是使用角括号来把文字转成连结。

行内形式形式是直接在后面用括号直接接上连结:

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

输出:

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

你也可以选择性的加上 title 属性:

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

输出:

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

参考形式的连结让你可以為连结定一个名称,之后你可以在文件的其他地方定义该连结的内容:

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"

输出:

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

title 属性是选择性的,连结名称可以用字母、数字和空格,但是不分大小写:

I start my morning with a cup of coffee and
[The New York Times][NY Times].

[ny times]: http://www.nytimes.com/

输出:

<p>I start my morning with a cup of coffee and
<a href="http://www.nytimes.com/">The New York Times</a>.</p>

1.1.2.2 图片

图片的语法和连结很像。

行内形式(title 是选择性的):

![alt text](/path/to/img.jpg "Title")

参考形式:

![alt text][id]

[id]: /path/to/img.jpg "Title"

上面两种方法都会输出:

<img src="/path/to/img.jpg" alt="alt text" title="Title" />

1.1.2.3 程式码

在一般的段落文字中,你可以使用反引号 ` 来标记程式码区段,区段内的 &<> 都会被自动的转换成 HTML 实体,这项特性让你可以很容易的在程式码区段内插入 HTML 码:

I strongly recommend against using any `<blink>` tags.

I wish SmartyPants used named entities like `&mdash;`
instead of decimal-encoded entites like `&#8212;`.

输出:

<p>I strongly recommend against using any
<code>&lt;blink&gt;</code> tags.</p>

<p>I wish SmartyPants used named entities like
<code>&amp;mdash;</code> instead of decimal-encoded
entites like <code>&amp;#8212;</code>.</p>

如果要建立一个已经格式化好的程式码区块,只要每行都缩排 4 个空格或是一个 tab 就可以了,而 &<> 也一样会自动转成 HTML 实体。

Markdown:

If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:

    <blockquote>
        <p>For example.</p>
    </blockquote>

输出:

<p>If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:</p>

<pre><code>&lt;blockquote&gt;
    &lt;p&gt;For example.&lt;/p&gt;
&lt;/blockquote&gt;
</code></pre>

1.2 Markdown 详细语法

目录索引


概述

哲学

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

不过最需要强调的便是它的可读性。一份使用 Markdown 格式撰写的文件应该可以直接以纯文字发布,并且看起来不会像是由许多标籤或是格式指令所构成。Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括 [Setext] 1、[atx] 2、[Textile] 3、[reStructuredText] 4、[Grutatext] 5 和 [EtText] 6,然而最大灵感来源其实是纯文字的电子邮件格式。

因此 Markdown 的语法全由标点符号所组成,并经过严谨慎选,是為了让它们看起来就像所要表达的意思。像是在文字两旁加上星号,看起来就像*强调*。Markdown 的清单看起来,嗯,就是清单。假如你有使用过电子邮件,区块引言看起来就真的像是引用一段文字。

行内 HTML

Markdown 的语法有个主要的目的:用来作為一种网路内容的写作用语言。

Markdown 不是要来取代 HTML,甚至也没有要和它相似,它的语法种类不多,只和 HTML 的一部分有关系,重点不是要创造一种更容易写作 HTML 文件的语法,我认為 HTML 已经很容易写了,Markdown 的重点在於,它能让文件更容易阅读、编写。HTML 是一种发佈的格式,Markdown 是一种编写的格式,因此,Markdown 的格式语法只涵盖纯文字可以涵盖的范围。

不在 Markdown 涵盖范围之外的标籤,都可以直接在文件裡面用 HTML 撰写。不需要额外标註这是 HTML 或是 Markdown;只要直接加标籤就可以了。

只有区块元素──比如 <div><table><pre><p> 等标籤,必须在前后加上空行,以利与内容区隔。而且这些(元素)的开始与结尾标籤,不可以用 tab 或是空白来缩排。Markdown 的產生器有智慧型判断,可以避免在区块标籤前后加上没有必要的 <p> 标籤。

举例来说,在 Markdown 文件裡加上一段 HTML 表格:

This is a regular paragraph.

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

This is another regular paragraph.

请注意,Markdown 语法在 HTML 区块标籤中将不会被进行处理。例如,你无法在 HTML 区块内使用 Markdown 形式的*强调*

HTML 的区段标籤如 <span><cite><del> 则不受限制,可以在 Markdown 的段落、清单或是标题裡任意使用。依照个人习惯,甚至可以不用Markdown 格式,而採用 HTML 标籤来格式化。举例说明:如果比较喜欢 HTML 的 <a><img> 标籤,可以直接使用这些标籤,而不用 Markdown 提供的连结或是影像标示语法。

HTML 区段标籤和区块标籤不同,在区段标籤的范围内, Markdown 的语法是有效的。

特殊字元自动转换

在 HTML 文件中,有两个字元需要特殊处理: <&< 符号用於起始标籤,& 符号则用於标记 HTML 实体,如果你只是想要使用这些符号,你必须要使用实体的形式,像是 &lt;&amp;

& 符号其实很容易让写作网路文件的人感到困扰,如果你要打「AT&T」 ,你必须要写成「AT&amp;T」 ,还得转换网址内的 & 符号,如果你要连结到:

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

你必须要把网址转成:

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

才能放到连结标籤的 href 属性裡。不用说也知道这很容易忘记,这也可能是 HTML 标準检查所检查到的错误中,数量最多的。

Markdown 允许你直接使用这些符号,但是你要小心跳脱字元的使用,如果你是在HTML 实体中使用 & 符号的话,它不会被转换,而在其它情形下,它则会被转换成 &amp;。所以你如果要在文件中插入一个著作权的符号,你可以这样写:

&copy;

Markdown 将不会对这段文字做修改,但是如果你这样写:

AT&T

Markdown 就会将它转為:

AT&amp;T

类似的状况也会发生在 < 符号上,因為 Markdown 支援 行内 HTML ,如果你是使用 < 符号作為 HTML 标籤使用,那 Markdown 也不会对它做任何转换,但是如果你是写:

4 < 5

Markdown 将会把它转换為:

4 &lt; 5

不过需要注意的是,code 范围内,不论是行内还是区块, <& 两个符号都一定会被转换成 HTML 实体,这项特性让你可以很容易地用 Markdown 写 HTML code (和 HTML 相对而言, HTML 语法中,你要把所有的 <& 都转换為 HTML 实体,才能在 HTML 文件裡面写出 HTML code。)


区块元素

段落和换行

一个段落是由一个以上相连接的行句组成,而一个以上的空行则会切分出不同的段落(空行的定义是显示上看起来像是空行,便会被视為空行。比方说,若某一行只包含空白和 tab,则该行也会被视為空行),一般的段落不需要用空白或断行缩排。

「一个以上相连接的行句组成」这句话其实暗示了 Markdown 允许段落内的强迫断行,这个特性和其他大部分的 text-to-HTML 格式不一样(包括 MovableType 的「Convert Line Breaks」选项),其它的格式会把每个断行都转成 <br /> 标籤。

如果你真的想要插入 <br /> 标籤的话,在行尾加上两个以上的空白,然后按 enter。

是的,这确实需要花比较多功夫来插入 <br /> ,但是「每个换行都转换為 <br />」的方法在 Markdown 中并不适合, Markdown 中 email 式的 区块引言 和多段落的 清单 在使用换行来排版的时候,不但更好用,还更好阅读。

Markdown 支援两种标题的语法,[Setext] 1 和 [atx] 2 形式。

Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),例如:

This is an H1
=============

This is an H2
-------------

任何数量的 =- 都可以有效果。

Atx 形式则是在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶,例如:

# This is an H1

## This is an H2

###### This is an H6

你可以选择性地「关闭」atx 样式的标题,这纯粹只是美观用的,若是觉得这样看起来比较舒适,你就可以在行尾加上 #,而行尾的 # 数量也不用和开头一样(行首的井字数量决定标题的阶数):

# This is an H1 #

## This is an H2 ##

### This is an H3 ######

Blockquotes

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 ,你可以选取文字后然后从选单中选择增加引言阶层

清单

Markdown 支援有序清单和无序清单。

无序清单使用星号、加号或是减号作為清单标记:

*   Red
*   Green
*   Blue

等同於:

+   Red
+   Green
+   Blue

也等同於:

-   Red
-   Green
-   Blue

有序清单则使用数字接著一个英文句点:

1.  Bird
2.  McHale
3.  Parish

很重要的一点是,你在清单标记上使用的数字并不会影响输出的 HTML 结果,上面的清单所產生的 HTML 标记為:

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

如果你的清单标记写成:

1.  Bird
1.  McHale
1.  Parish

或甚至是:

3. Bird
1. McHale
8. Parish

你都会得到完全相同的 HTML 输出。重点在於,你可以让 Markdown 文件的清单数字和输出的结果相同,或是你懒一点,你可以完全不用在意数字的正确性。

如果你使用懒惰的写法,建议第一个项目最好还是从 1. 开始,因為 Markdown 未来可能会支援有序清单的 start 属性。

清单项目标记通常是放在最左边,但是其实也可以缩排,最多三个空白,项目标记后面则一定要接著至少一个空白或 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 会把项目的内容在输出时用 <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 个空白或是一个 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 中建立程式码区块很简单,只要简单地缩排 4 个空白或是 1 个 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>

这个每行一阶的缩排(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="footer">
    &copy; 2004 Foo Corporation
</div>

会被转换為:

<pre><code>&lt;div class="footer"&gt;
    &amp;copy; 2004 Foo Corporation
&lt;/div&gt;
</code></pre>

程式码区块中,一般的 Markdown 语法不会被转换,像是星号便只是星号,这表示你可以很容易地以 Markdown 语法撰写 Markdown 语法相关的文件。

分隔线

你可以在一行中用三个或以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号中间插入空白。下面每种写法都可以建立分隔线:

* * *

***

*****

- - -

---------------------------------------

区段元素

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"

连结定义的形式為:

  • 方括号,裡面输入连结的辨识用标籤
  • 接著一个冒号
  • 接著一个以上的空白或 tab
  • 接著连结的网址
  • 选择性地接著 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>,例如:

*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

但是如果你的 *_ 两边都有空白的话,它们就只会被当成普通的符号。

如果要在文字前后直接插入普通的星号或底线,你可以用反斜线:

\*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>&lt;blink&gt;</code> tags.</p>

你也可以这样写:

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

以產生:

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

图片

很明显地,要在纯文字应用中设计一个 「自然」的语法来插入图片是有一定难度的。

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 还没有办法指定图片的宽高,如果你需要的话,你可以使用普通的 <img> 标籤。


其它

Markdown 支援比较简短的自动连结形式来处理网址和电子邮件信箱,只要是用方括号包起来, Markdown 就会自动把它转成连结,连结的文字就和连结位置一样,例如:

<http://example.com/>

Markdown 会转為:

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

自动的邮件连结也很类似,只是 Markdown 会先做一个编码转换的过程,把文字字元转成 16 进位码的 HTML 实体,这样的格式可以混淆一些不好的信箱地址收集机器人,例如:

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

在瀏览器裡面,这段字串会变成一个可以点击的「address@example.com」连结。

(这种作法虽然可以混淆不少的机器人,但并无法全部挡下来,不过这样也比什麼都不做好些。无论如何,公开你的信箱终究会引来广告信件的。)

跳脱字元

Markdown 可以利用反斜线来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果(但不用 <em> 标籤),你可以在星号的前面加上反斜线:

\*literal asterisks\*

Markdown 支援在下面这些符号前面加上反斜线来帮助插入普通的符号:

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

2. Markdown 中文写作规范

2.1 标题

2.1.1 层级

标题分为四级。

  • 一级标题:文章的标题
  • 二级标题:文章主要部分的大标题
  • 三级标题:二级标题下面一级的小标题
  • 四级标题:三级标题下面某一方面的小标题

2.1.2 原则

  • 一级标题下,不能直接出现三级标题。
  • 标题要避免孤立编号(即同级标题只有一个)。
  • 下级标题不重复上一级标题的内容。
  • 谨慎使用四级标题,尽量避免出现,保持层级的简单和防止出现过于复杂的章节。如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。

2.2 文本

2.2.1 字间距

全角中文字符与半角英文字符之间,应有一个半角空格。

1
2
3
错误:本文介绍如何快速启动Windows系统。

正确:本文介绍如何快速启动 Windows 系统。

全角中文字符与半角阿拉伯数字之间,有没有半角空格都可,但必须保证风格统一,不能两种风格混杂。

1
2
3
正确:2011年5月15日,我订购了5台笔记本电脑与10台平板电脑。

正确:2011 年 5 月 15 日,我订购了 5 台笔记本电脑与 10 台平板电脑。

半角的百分号,视同阿拉伯数字。

英文单位若不翻译,单位前的阿拉伯数字与单位间不留空格。

1
2
3
错误:一部容量为 16 GB 的智能手机

正确:一部容量为 16GB 的智能手机

半角英文字符和半角阿拉伯数字,与全角标点符号之间不留空格。

1
2
3
错误:他的电脑是 MacBook Air 。

正确:他的电脑是 MacBook Air。

2.2.2 句子

  • 避免使用长句。一个句子建议不超过 100 字或者正文的 3 行。
  • 尽量使用简单句和并列句,避免使用复合句。

2.2.3 写作风格

尽量不使用被动语态,改为使用主动语态。

1
2
3
错误:假如此软件尚未被安装,

正确:假如尚未安装这个软件,

不使用非正式的语言风格。

1
2
3
错误:Lady Gaga 的演唱会真是酷毙了,从没看过这么给力的表演!!!

正确:无法参加本次活动,我深感遗憾。

用对“的”、“地”、“得”。

1
2
3
4
5
6
7
8
她露出了开心的笑容。
(形容词+的+名词)

她开心地笑了。
(副词+地+动词)

她笑得很开心。
(动词+得+副词)

使用代词时(比如“其”、“该”、“此”、“这”等词),必须明确指代的内容,保证只有一个含义。

1
2
3
错误:从管理系统可以监视中继系统和受其直接控制的分配系统。

正确:从管理系统可以监视两个系统:中继系统和受中继系统直接控制的分配系统。

名词前不要使用过多的形容词。

1
2
3
错误:此设备的使用必须在接受过本公司举办的正式的设备培训的技师的指导下进行。

正确:此设备必须在技师的指导下使用,且指导技师必须接受过由本公司举办的正式设备培训。

单个句子的长度尽量保持在 20 个字以内;20~29 个字的句子,可以接受;30~39 个字的句子,语义必须明确,才能接受;多于 40 个字的句子,在任何情况下都不能接受。

1
2
3
错误:本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。

正确:本产品适用于多种体系结构。无论是由一台服务器(单一节点结构),还是由多台服务器(并行处理结构)进行动作控制,均可以使用本产品。

同样一个意思,尽量使用肯定句表达,不使用否定句表达。

1
2
3
错误:请确认没有接通装置的电源。

正确:请确认装置的电源已关闭。

避免使用双重否定句。

1
2
3
错误:没有删除权限的用户,不能删除此文件。

正确:用户必须拥有删除权限,才能删除此文件。

2.2.4 英文处理

英文原文如果使用了复数形式,翻译成中文时,应该将其还原为单数形式。

1
2
3
英文:⋯information stored in random access memory (RAMs)⋯

中文:……存储在随机存取存储器(RAM)里的信息……

外文缩写可以使用半角圆点(.)表示缩写。

1
2
U.S.A.
Apple, Inc.

表示中文时,英文省略号()应改为中文省略号(……)。

1
2
3
英文:5 minutes later⋯

中文:5 分钟过去了⋯⋯

英文书名或电影名改用中文表达时,双引号应改为书名号。

1
2
3
英文:He published an article entitled "The Future of the Aviation".

中文:他发表了一篇名为《航空业的未来》的文章。

第一次出现英文词汇时,在括号中给出中文标注。此后再次出现时,直接使用英文缩写即可。

1
IOC(International Olympic Committee,国际奥林匹克委员会)。这样定义后,便可以直接使用“IOC”了。

专有名词中每个词第一个字母均应大写,非专有名词则不需要大写。

1
2
3
“American Association of Physicists in Medicine”(美国医学物理学家协会)是专有名词,需要大写。

“online transaction processing”(在线事务处理)不是专有名词,不应大写。

2.3 段落

2.3.1 原则

  • 一个段落只能有一个主题,或一个中心句子。
  • 段落的中心句子放在段首,对全段内容进行概述。后面陈述的句子为核心句服务。
  • 一个段落的长度不能超过七行,最佳段落长度小于等于四行。
  • 段落的句子语气要使用陈述和肯定语气,避免使用感叹语气。
  • 段落之间使用一个空行隔开。
  • 段落开头不要留出空白字符。

2.3.2 引用

引用第三方内容时,应注明出处。

1
One man’s constant is another man’s variable. — Alan Perlis

如果是全篇转载,请在全文开头显著位置注明作者和出处,并链接至原文。

1
本文转载自 WikiQuote

使用外部图片时,必须在图片下方或文末标明来源。

1
本文部分图片来自 Wikipedia

2.4 数值

2.4.1 半角数字

数字一律使用半角形式,不得使用全角形式。

1
2
3
错误: 这件商品的价格是1000元。

正确: 这件商品的价格是 1000 元。

2.4.2 千分号

数值为千位以上,应添加千分号(半角逗号)。

1
XXX 公司的实收资本为 RMB1,258,000。

对于 4 ~ 6 位的数值,千分号是选用的,比如10001,000都可以接受。对于7位及以上的数值,千分号是必须的。

多位小数要从小数点后从左向右添加千分号,比如4.234,345

2.4.3 货币

货币应为阿拉伯数字,并在数字前写出货币符号,或在数字后写出货币中文名称。

1
2
$1,000
1,000 美元

2.4.4 数值范围

表示数值范围时,用连接。参见《标点符号》一节的“连接号”部分。

带有单位或百分号时,两个数字都要加上单位或百分号,不能只加后面一个。

1
2
3
4
5
错误:132~234kg
正确:132kg~234kg

错误:67~89%
正确:67%~89%

2.4.5 变化程度的表示法

数字的增加要使用“增加了”、“增加到”。“了”表示增量,“到”表示定量。

1
2
3
4
5
增加到过去的两倍
(过去为一,现在为二)

增加了两倍
(过去为一,现在为三)

数字的减少要使用“降低了”、“降低到”。“了”表示增量,“到”表示定量。

1
2
3
4
5
降低到百分之八十
(定额是一百,现在是八十)

降低了百分之八十
(原来是一百,现在是二十)

不能用“降低N倍”或“减少N倍”的表示法,要用“降低百分之几”或“减少百分之几”。因为减少(或降低)一倍表示数值原来为一百,现在等于零。

2.5 标点符号

2.5.1 原则

  • 中文语句的标点符号,均应该采取全角符号,这样可以保证视觉的一致。
  • 如果整句为英文,则该句使用英文/半角标点。
  • 句号、问号、叹号、逗号、顿号、分号和冒号不得出现在一行之首。

2.5.2 句号

中文语句中的结尾处应该用全角句号()。

句子末尾用括号加注时,句号应在括号之外。

1
2
3
错误:关于文件的输出,请参照第 1.3 节(见第 26 页。)

正确:关于文件的输出,请参照第 1.3 节(见第 26 页)。

2.5.3 逗号

逗号表示句子内部的一般性停顿。

注意避免“一逗到底”,即整个段落除了结尾,全部停顿都使用逗号。

2.5.4 顿号

句子内部的并列词,应该用全角顿号() 分隔,而不用逗号,即使并列词是英语也是如此。

1
2
3
错误:我最欣赏的科技公司有 Google, Facebook, 腾讯, 阿里和百度等。

正确:我最欣赏的科技公司有 Google、Facebook、腾讯、阿里和百度等。

英文句子中,并列词语之间使用半角逗号(,)分隔。

1
例句:Microsoft Office includes Word, Excel, PowerPoint, Outlook and other components.

2.5.5 分号

分号表示复句内部并列分句之间的停顿。

2.5.6 引号

引用时,应该使用全角双引号(“ ”),注意前后双引号不同。

1
例句:许多人都认为客户服务的核心是“友好”和“专业”。

引号里面还要用引号时,外面一层用双引号,里面一层用单引号(‘ ’),注意前后单引号不同。

1
例句:鲍勃解释道:“我要放音乐,可萨利说,‘不行!’。”

2.5.7 圆括号

补充说明时,使用全角圆括号(),括号前后不加空格。

1
例句:请确认所有的连接(电缆和接插件)均安装牢固。

2.5.8 冒号

全角冒号()常用在需要解释的词语后边,引出解释和说明。

1
例句:请确认以下几项内容:时间、地点、活动名称,以及来宾数量。

表示时间时,应使用半角冒号(:)。

1
例句:早上 8:00

2.5.9 省略号

省略号……表示语句未完、或者语气的不连续。它占两个汉字空间、包含六个省略点,不要使用。。。...等非标准形式。

省略号不应与“等”这个词一起使用。

1
2
3
4
5
错误:我们为会餐准备了香蕉、苹果、梨…等各色水果。

正确:我们为会餐准备了各色水果,有香蕉、苹果、梨……

正确:我们为会餐准备了香蕉、苹果、梨等各色水果。

2.5.10 感叹号

应该使用平静的语气叙述,尽量避免使用感叹号

不得多个感叹号连用,比如!!!!!

2.5.11 破折号

破折号————一般用于做进一步解释。破折号应占两个汉字的位置。

1
例句:直觉————尽管它并不总是可靠的————告诉我,这事可能出了些问题。

2.5.12 连接号

连接号用于连接两个类似的词。

以下场合应该使用直线连接号(-),占一个半角字符的位置。

  • 两个名词的复合
  • 图表编号
1
2
3
例句:氧化-还原反应

例句:图 1-1

以下场合应该使用波浪连接号(),占一个全角字符的位置。

  • 数值范围(例如日期、时间或数字)
1
例句:2009 年~2011 年

注意,波浪连接号前后两个值都应该加上单位。

波浪连接号也可以用汉字“至”代替。

1
例句:周围温度:-20°C 至 -10°C

2.6 文档体系

2.6.1 结构

软件手册是一部完整的书,建议采用下面的结构。

  • 简介(Introduction): [必备] [文件] 提供对产品和文档本身的总体的、扼要的说明
  • 快速上手(Getting Started):[可选] [文件] 如何最快速地使用产品
  • 入门篇(Basics): [必备] [目录] 又称”使用篇“,提供初级的使用教程
    • 环境准备(Prerequisite):[必备] [文件] 软件使用需要满足的前置条件
    • 安装(Installation):[可选] [文件] 软件的安装方法
    • 设置(Configuration):[必备] [文件] 软件的设置
  • 进阶篇(Advanced):[可选] [目录] 又称”开发篇“,提供中高级的开发教程
  • API(Reference):[可选] [目录|文件] 软件 API 的逐一介绍
  • FAQ:[可选] [文件] 常见问题解答
  • 附录(Appendix):[可选] [目录] 不属于教程本身、但对阅读教程有帮助的内容
    • Glossary:[可选] [文件] 名词解释
    • Recipes:[可选] [文件] 最佳实践
    • Troubleshooting:[可选] [文件] 故障处理
    • ChangeLog:[可选] [文件] 版本说明
    • Feedback:[可选] [文件] 反馈方式

下面是两个真实范例,可参考。

2.6.2 文件名

文档的文件名不得含有空格。

文件名必须使用半角字符,不得使用全角字符。这也意味着,中文不能用于文件名。

1
2
3
错误: 名词解释.md

正确: glossary.md

文件名建议只使用小写字母,不使用大写字母。

1
2
3
错误:TroubleShooting.md

正确:troubleshooting.md

为了醒目,某些说明文件的文件名,可以使用大写字母,比如READMELICENSE

文件名包含多个单词时,单词之间建议使用半角的连词线(-)分隔。

1
2
3
不佳:advanced_usage.md

正确:advanced-usage.md