Markdown: Basics （快速入门）

末蓝、 2022-08-21 01:21 128阅读 0赞

声明： 这份文档派生(fork)于[繁体中文版][Link 1]，在此基础上进行了繁体转简体工作，并进行了适当的润色。此文档用 Markdown 语法编写，你可以到这里[查看它的源文件][Link 2]。「繁体中文版的原始文件可以[查看这里][Link 3]」--By @[riku][] / 本项目托管于 [GitCafe][]

注： 本项目同时也托管于 [Github][]上，请通过 fork＋pull request 方式来帮忙改进本项目。

# Markdown: Basics （快速入门） / ([点击查看完整语法说明][Link 4]) #

## Getting the Gist of Markdown's Formatting Syntax ##

此页提供了 Markdown 的简单概念， [语法说明][Link 5] 页提供了完整详细的文档，说明了每项功能。但是 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>
 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.
 <h3>Header 3</h3>
 <blockquote>
 This is a blockquote.
 This is the second paragraph in the blockquote.
 <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 为:

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.

## 列表 ##

无序列表使用星号、加号和减号来做为列表的项目标记，这些符号是都可以使用的，使用星号：

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

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

* A list item.
    With multiple paragraphs.
    
    * Another item in the list.

输出 HTML 为：

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

### 链接 ###

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

行内形式是直接在后面用括号直接接上链接：

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

输出 HTML 为：

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

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

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

输出 HTML 为：

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

参考形式的链接让你可以为链接定一个名称，之后你可以在文件的其他地方定义该链接的内容：

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

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

title 属性是选择性的，链接名称可以用字母、数字和空格，但是不分大小写：

I start my morning with a cup of coffee and
    [The New York Times][NY Times].
    
    [ny times]: http://www.nytimes.com/

输出 HTML 为：

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

### 图片 ###

图片的语法和链接很像。

行内形式（title 是选择性的）：

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

参考形式：

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

上面两种方法都会输出 HTML 为：

### 代码 ###

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

I strongly recommend against using any `<blink>` tags.
 
 I wish SmartyPants used named entities like `—`
 instead of decimal-encoded entites like `—`.

输出 HTML 为：

I strongly recommend against using any
 <code><blink></code> tags.
 I wish SmartyPants used named entities like
 <code>&mdash;</code> instead of decimal-encoded
 entites like <code>&#8212;</code>.

如果要建立一个已经格式化好的代码区块，只要每行都缩进 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>
 For example.
 </blockquote>

输出 HTML 为：

If you want your page to validate under XHTML 1.0 Strict,
 you've got to put paragraph tags in your blockquotes:
 <pre><code><blockquote>
 For example.
 </blockquote>
 </code></pre>

id="dsq-app2" name="dsq-app2" allowtransparency="true" frameborder="0" scrolling="no" tabindex="0" title="Disqus" width="100%" src="http://disqus.com/embed/comments/?base=default&version=1c1d25d4bf3edc025e85622d55848bbf&f=wowubuntu&t\_u=http%3A%2F%2Fwww.appinn.com%2Fmarkdown%2Fbasic.html&t\_d=Markdown%20%E8%AF%AD%E6%B3%95%E8%AF%B4%E6%98%8E(%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87%E7%89%88)&t\_t=Markdown%20%E8%AF%AD%E6%B3%95%E8%AF%B4%E6%98%8E(%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87%E7%89%88)&s\_o=default" horizontalscrolling="no" verticalscrolling="no" style="vertical-align: baseline; margin: 0px; padding: 0px; min-width: 100%; border-style: none !important; width: 1px !important; overflow: hidden !important; height: 995px !important; background: transparent;">

[Link 1]: http://markdown.tw/
[Link 2]: http://gitcafe.com/riku/Markdown-Syntax-CN/blob/master/basics.md
[Link 3]: https://github.com/othree/markdown-syntax-zhtw/blob/master/basics.md
[riku]: http://twitter.com/riku
[GitCafe]: http://gitcafe.com/riku/Markdown-Syntax-CN
[Github]: https://github.com/riku/Markdown-Syntax-CN
[Link 4]: http://www.appinn.com/markdown/index.html
[Link 5]: http://gitcafe.com/riku/Markdown-Syntax-CN/blob/master/syntax.md
[Dingus]: http://daringfireball.net/projects/markdown/dingus
[Setext]: http://docutils.sourceforge.net/mirror/setext.html
[atx]: http://www.aaronsw.com/2002/atx/