Markdown 简要语法说明
简述
此页提供了Markdown的简单概念,语法说明页提供了完整详细的文档,说明了每项功能。但是Markdown其实很简单就可以上手,此页文档提供了一些范例,并且每个范例都会提供输出的HTML结果。
其实直接试试看也是一个很不错的方法,Dingus是一个网页应用程序,你可以把自已编写的Markdown文档转成XHTML。
段落、标题、区块代码
一个段落是由一个以上的连接的行句组成,而一个以上的空行则会划分出不同的段落(空行的定义是显示上看起来像是空行,就被视为空行,例如有一行只有空白和tab,那该行也会被视为空行),一般的段落不需要用空白或换行缩进。
Markdown支持两种标题的语法,Setext和atx形式。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
输出HTML为:
<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>
修辞和强调
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__.
输出HTML 为:
<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>
列表
无序列表使用星号、加号和减号来做为列表的项目标记,这些符号是都可以使用的,使用星号:
* Candy.
* Gum.
* Booze.
加号:
+ Candy.
+ Gum.
+ Booze.
和减号:
- Candy.
- Gum.
- Booze.
都会输出HTML为:
<ul>
<li>Candy.</li>
<li>Gum.</li>
<li>Booze.</li>
</ul>
有序的列表则是使用一般的数字接着一个英文句点作为项目标记:
1. Red
2. Green
3. Blue
输出HTML为:
<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.
输出 HTML 为:
<ul>
<li><p>A list item.</p>
<p>With multiple paragraphs.</p></li>
<li><p>Another item in the list.</p></li>
</ul>
链接
Markdown支援两种形式的链接语法:行内和参考两种形式,两种都是使用角括号来把文字转成连结。
行内形式是直接在后面用括号直接接上链接:
This is an [example link](http://example.com/).
输出HTML为:
<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").
输出HTML为:
<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"
输出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>
title属性是选择性的,链接名称可以用字母、数字和空格,但是不分大小写:
I start my morning with a cup of coffee and [The New York Times][NY Times].
[ny times]: http://www.nytimes.com/
输出 HTML 为:
<p>I start my morning with a cup of coffee and <a href="http://www.nytimes.com/">The New York Times</a>.</p>
图片
图片的语法和链接很像。
行内形式(title是选择性的):
![alt text](/path/to/img.jpg "Title")
参考形式:
![alt text][id]
[id]: /path/to/img.jpg "Title"
上面两种方法都会输出 HTML 为:
<img src="/path/to/img.jpg" alt="alt text" title="Title" />
代码
在一般的段落文字中,你可以使用反引号`
来标记代码区段,区段内的&
、<
和>
都会被自动的转换成HTML实体,这项特性让你可以很容易的在代码区段内插入HTML码:
I strongly recommend against using any `<blink>` tags.
I wish SmartyPants used named entities like `—` instead of decimal-encoded entites like `—`.
输出HTML为:
<p>I strongly recommend against using any<code><blink></code> tags.</p>
<p>I wish SmartyPants used named entities like<code>&mdash;</code> instead of decimal-encoded entites like <code>&#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>
输出HTML为:
<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><blockquote>
<p>For example.</p>
</blockquote>
</code></pre>