Markdown 教程

[隐藏]

《Markdown 教程》

Markdown 教程

概述

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

可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括 Setext、atx、Textile、reStructuredText、Grutatext 和 EtText,而最大灵感来源其实是纯文本电子邮件的格式。

总之, Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然。比如:在文字两旁加上星号,看起来就像强调。Markdown 的列表看起来,嗯,就是列表。Markdown 的区块引用看起来就真的像是引用一段文字,就像你曾在电子邮件中见过的那样。

使用 Markdown 的优点

  • 专注你的文字内容而不是排版样式,安心写作。
  • 轻松的导出 HTML、PDF 和本身的 .md 文件。
  • 纯文本内容,兼容所有的文本编辑器与字处理软件。
  • 随时修改你的文章版本,不必像字处理软件生成若干文件版本导致混乱。
  • 可读、直观、学习成本低。

Markdown 语法的规则

段落

一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。

换行

输入两个以上的空格然后回车 (Return)。

  • This two-line bullet
    won’t break

  • This two-line bullet
    will break

例子如下:

* This two-line bullet 
won't break

* This two-line bullet  
will break

粗体与斜体

Markdown 的粗体和斜体非常简单,用两个 * 包含一段文本就是粗体,用一个 * 包含一段文本就是斜体或者两个 __ 包含一段文本就是粗体,用一个 _ 包含一段文本就是斜体。

粗体: **粗体** or __粗体__
斜体: *斜体* or _斜体_

例如:
这是 粗体粗体 ;
这是 斜体斜体

你可以随便用你喜欢的样式,唯一的限制是,你用什么符号开启标签,就要用什么符号结束。
强调也可以直接插在文字中间:

un*frigging*believable

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

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

\*this text is surrounded by literal asterisks\*

标题

Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。

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

# 标题 1
## 标题 2
### 标题 3
#### 标题 4
##### 标题 5
###### 标题 6

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

# 标题 1 #
## 标题 2 ##
### 标题 3 ###
#### 标题 4 ####
##### 标题 5 ####
###### 标题 6 ####

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

标题 1
========

标题 2
--------    

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

链接和邮件

Markdown 支持两种形式的链接语法: 行内式(Inline)和参考式(Reference style)两种形式。 无论哪种方式,链接文字都是用 [方括号] 来标记。

行内式的链接

方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来,例如:

这是 [iHero`s](http://www.heguagnzhi.com "iHero's") 行内式链接。
这是 [iHero`s](http://www.heguagnzhi.com/) 没有 ***title*** 的链接。

效果如下:

这是 iHero`s行内式链接。

这是 iHero`s 没有 title 行内式链接。

Markdown 会转为:

<p>这是 <a href="http://www.heguagnzhi.com" title="iHero's">
iHero`s</a> 行内式链接。</p>
<p><a href="http://www.heguagnzhi.com">iHero`s</a> 没有 ***title*** 行内式链接。</p>

Markdown 支持短链接形式来处理链接和电子邮件地址,只要是用方括号包起来, Markdown 就会自动把它转成链接。链接文字就和链接地址一样,例如:

<http://www.heguangzhi.com/>

显示内容如下:

http://www.heguangzhi.com/

Markdown 会转为:

<a href="http://www.heguangzhi.com">http://www.heguangzhi.com</a>

邮件地址类似,只是 Markdown 会先做一个编码转换的过程,把文字字符转成 16 进位码的 HTML 实体,这样的格式可以糊弄一些不好的邮址收集机器人,例如:

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

在浏览器里面,这段字串(其实是 heguangzhi@heguangzhi.com)会变成一个可以点击的「heguangzhi@heguangzhi.com」邮件链接。

如果链接地址在同一个服务器上,可以使用相对路径:

请看 [关于](/2018/09/03/启用我自己的blog/) 我的站点。

Markdown 显示内容如下:
请看 关于 我的站点。

参考式链接

参考式的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记:

这是一个 [例子][id] 参考式的链接。

文件的任意处(一般放在文件底部),可以把这个标记的链接内容定义出来:

[id]: http://www.heguangzhi.com/  "iHero's" 

链接内容定义的形式为:

  • 方括号(前面可以选择性地加上至多三个空格来缩进),里面输入链接文字;
  • 接着一个冒号;
  • 接着一个以上的空格或制表符;
  • 接着链接的网址;
  • 选择性地接着 title 内容,可以用单引号、双引号或是括弧包着;

下面这三种链接的定义都是相同:

[foo]: http://heguangzhi.com/  "我的标题"  
[foo]: http://heguangzhi.com/  '我的标题'  
[foo]: http://heguangzhi.com/  (我的标题)  

链接网址也可以用方括号包起来:
[id]: http://www.heguangzhi.com/ “我的标题”

若网址太长,可以把 title 属性放到下一行,也可以加一些缩进,容易查看:

[id]: https://www.heguangzhi.com/2018/09/30/lets-encrypt-zhengshu-ssltongyongzhengshu-peizhiyuzidongxuqi/  
"Let's Encrypt 证书 SSL通用证书 配置与自动续期"

网址定义只有在产生链接的时候用到,并不会直接出现在文件之中。
链接辨别标签可以有字母、数字、空白和标点符号,但是并不区分大小写,因此下面两个链接是一样的:

[link text][a]
[link text][A]

隐式链接 ID 功能让你可以省略指定链接 ID,这种情形下,链接 ID 会视为等同于链接文字,要用隐式链接 ID 只要在链接文字后面加上一个空的方括号,如果你要让 “Google” 链接到 google.com,你可以简化成:

[Google][]

然后定义链接内容:

[Google]: http://google.com/

由于链接文字可能包含空白,所以这种简化型的 ID 内也许包含多个单词:

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"

下面是用行内式写的同样一段内容的 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 的参考式链接,可以让文件更像是浏览器最后产生的结果,让你可以把一些标记相关的元数据移到段落文字之外,你就可以增加链接而不让文章的阅读感觉被打断。

列表

熟悉 HTML 的同学肯定知道有序列表与无序列表的区别,在 Markdown 下,列表的显示只需要在文字前加上 – 或 * 即可变为无序列表,有序列表则直接在文字前加1. 2. 3. 符号要和文字之间加上一个字符的空格。

无序列表使用星号、加号或是减号作为列表标记:

*   Red
*   Green
*   Blue

等同于:

+   Red
+   Green
+   Blue

也等同于:

-   Red
-   Green
-   Blue

有序列表则使用数字接着一个英文句点:

1.  Bird
2.  McHale
3.  Parish

列表项目标记通常是放在最左边,但是其实也可以缩进,最多 3 个空格,项目标记后面则一定要接着至少一个空格或制表符。
要让列表看起来更漂亮,你可以把内容用固定的缩进整理好:

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

列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符:

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 个空格或是 2 个制表符:

*   一列表项包含一个列表区块:

        <代码写在这>

引用

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 语法,包括标题、列表、代码区块等:

> ## 这是一个标题。
> 
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
> 
> 给出一些例子代码:
> 
>     return shell_exec("echo input | markdown_script");

图片与链接

很明显地,要在纯文字应用中设计一个「自然」的语法来插入图片是有一定难度的。
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 比较累人的地方,例子如下:

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | 1600 | | col 2 is      | centered      |   12 |
| zebra stripes | are neat      |    $1 |

这种语法生成的表格如下:

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

代码块

行内代码块

如果要标记一小段行内代码,你可以用反引号把它包起来(`),例如:

Use the `printf()` function.

如果要在代码区段内插入反引号,你可以用多个反引号来开启和结束代码区段:

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

代码区段的起始和结束端都可以放入一个空白,起始端后面一个,结束端前面一个,这样你就可以在区段的一开始就插入反引号:

A single backtick in a code span: `` ` ``

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

结果显示为:

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

在代码区段内,& 和方括号都会被自动地转成 HTML 编码,这使得插入 HTML 原始码变得很容易,Markdown 会把下面这段:

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

结果显示为:

Please don’t use any <blink> tags.

代码块

和程序相关的写作或是标签语言原始码通常会有已经排版好的代码区块,通常这些区块我们并不希望它以一般段落文件的方式去排版,而是照原来的样子显示,Markdown 会用 <pre><code> 标签来把代码区块包起来。

要在 Markdown 中建立代码区块很简单,只要简单地缩进 4 个空格或是 1 个制表符就可以,例如,下面的输入:

这是一个普通段落:

    这是一个代码区块。

这个每行一阶的缩进(4 个空格或是 1 个制表符),都会被移除,例如:

Here is an example of AppleScript:

    tell application "Foo"
        beep
    end tell

可以使用反引号 (`) 生成代码块:

print('Hello world!');
print('Hello world!');

也可以使用波浪线 (~) 代替反引号 (`):

print('Hello world!')

分割线

在一行中用三个以上的 *-_ 来建立一个分隔线,行内不能有其他内容。可以在 * 或是 - 中间插入空格。下面写法都可以建立分隔线:

* * *
***
*****
- - -
---
___

转义反斜杠

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

\*literal asterisks\*

效果如下:

*literal asterisks*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

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

参考内容:

Markdown 语法说明 (简体中文版)

点赞

发表评论

电子邮件地址不会被公开。 必填项已用*标注