Markdown 基础

掌握 Markdown 语法的要旨

这篇文章对 Markdown 进行了简单的概述。语法篇 对 Markdown 的每一个功能进行了完整、详细的说明,通过浏览一些例子就可以很轻松的掌握 Markdown 语法。这篇文章中的实例采用了 前/后 风格来展示实例中的语法和其对应生成的 HTML。

你可以轻松地在线体验 Markdown; Dingus 是一个可以在线编辑 Markdown 文档并转换成 XHTML 格式的一个 Web 应用。

段落、标题、引用

一个段落是简单的一行或多行的连续文字,段落之间通过一个或多个空行分隔。 (任何看起来像空行的都是空行 —— 只包含空格或者制表符行也被视为空行。) 正常的段落不因用空格或者制表符缩进。

Markdown 提供了两种风格的标题: Setextatx
Setext 风格的标题的分别使用等号 (=) 和连字符 (-) 用作 "下划线" 来产生 <h1><h2>
而使用 atx 风格的标题,你需要在行首输入 1-6 个井号 (#) —— 井号的个数等价于 HTML 标题的级数。

引用使用 email 风格的 '>' 尖括号来表示。

Markdown:

一级标题
=======

二级标题
-------

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.

### 三级标题

> 这是一个引用。
>
> 这是这个引用中的第二段。
>
> ## 这是这个引用中的二级标题

Output:

<h1>一级标题</h1>

<h2>二级标题</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>三级标题</h3>

<blockquote>
    <p>这是一个引用。</p>

    <p>这是这个引用中的第二段。</p>

    <h2>这是这个引用中的二级标题</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__.

Output:

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

都产生相同的输出:

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

有序 (编号) 列表使用常规数字加上逗点符号作为列表的标记:

1.  Red
2.  Green
3.  Blue

Output:

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

如果你在列表元素之间插入空行的话,每个列表元素都会包裹进 <p> 标记。你可以用 4 个空格或者一个制表符缩进段落来创建一个多段落的列表元素:

*   A list item.

    With multiple paragraphs.

*   Another item in the list.

Output:

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

Output:

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

Optionally, you may include a title attribute in the parentheses:

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

Output:

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

Output:

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

Output:

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

图片

图片的语法与超链接的语法很相似。

内联风格 (标题可选):

![替换文字](/path/to/img.jpg "Title")

引用风格:

![替换文字][id]

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

以上两个实例都产生相同的输:

<img src="/path/to/img.jpg" alt="替换文字" title="Title" />

代码

在一个常规的段落中,你可以将文字包裹在反引号中来创建行内代码。任何的 (&) 符号和尖括号 (< 或者
>) 会被自动的转换成 HTML 的实体符号。这使得 Markdown 能更轻松的书写 HTML 示例代码:

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

I wish SmartyPants used named entities like `—`
instead of decimal-encoded entites like `—`.

Output:

<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 个空格或 1 个制表符缩进区块内的每一行。 与行内代码一样,&<,和 > 符号会自动转义。

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>

Output:

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

本文翻译自 daringfireball,转载请注明出处。

原文链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341

推荐阅读更多精彩内容

  • 本文转自@younghz 主要内容 Markdown是什么?谁发明了这么个东西?为什么要使用它?怎么使用?都谁在用...
    Wynter_Wang阅读 436评论 0 1
  • "https://en.wikipedia.org/wiki/Markdown#Example 区块元素 段落和换...
    杰舞阅读 267评论 0 0
  • * 更新说明 2015.11.14更新 在区段元素的强调栏增加删除线和空格的标记方法将表格、流程图和时序图等不常用...
    黄学涛阅读 61,002评论 2 53
  • 目录 区块元素标题列表区块引用代码区块分隔线段落和换行 区段元素链接强调代码图片转义 标题 类SetextTh...
    ting723阅读 28,111评论 2 32
  • 我让他
    Lydiawm阅读 94评论 0 0