Markdown 教程

发表于 更新于 分类于

概览

Markdown 是一种标记语言（轻量级的、可用纯文本编写）;
Markdown 诞生于2004年，由约翰·格鲁伯（John Gruber）创建；
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式。
Markdown 编写的文档后缀为 .md, .markdown。

宗旨

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

应用

Markdown 能被使用来撰写电子书，如：Gitbook。

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如：GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。

编辑器

Markdown编辑器目前颇多，可参考以下链接进行选择。

[传送门] https://blog.csdn.net/qq_36759224/article/details/82229243

区块元素

段落和换行

Markdown段落由一个或多个连续的文本行组成。
Markdown换行由两个及已上的空格加回车实现。

标题

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

使用 = 和 - 标记一级和二级标题（类Setext）

1
2
3
4
5
我展示的是一级标题
=================

我展示的是二级标题
-----------------

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

使用 # 号标记 1-6 级标题（类Atx）

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

区块引用 Blockquotes

Markdown 标记区块引用是在每行的最前面加上 > ，如下：

1
2
3
4
5
6
> 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.

或在整个段落的第一行最前面加上 > ：

1
2
3
4
5
6
> 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.

区块引用可以嵌套（例如：引用内的引用），只要根据层次加上不同数量的 > ：

1
2
3
4
5
 This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

引用的区块内也可以使用其他的 Markdown 语法，包括标题、列表、代码区块等：

1
2
3
4
5
6
7
8
> ## 这是一个标题。
> 
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
> 
> 给出一些例子代码：
> 
>     return shell_exec("echo $input | $markdown_script");

列表

Markdown支持有序列表和无序列表。

无序列表

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

1
2
3
* 无序列表
+ 无序列表
- 无序列表

有序列表

有序列表则使用数字接着一个英文句点，然后加至少一个空格：

1
2
3
1.  Bird
2.  McHale
3.  Parish

注：列表上的数字不会影响输出的 HTML 结果

代码区块

Markdown 实现代码区块只要简单地缩进 4 个空格或是 1 个制表符就可以；

一个代码区块会一直持续到没有缩进的那一行（或是文件结尾）。

在代码区块里面， & 、 < 和 > 会自动转成 HTML 实体。

代码区块中，一般的 Markdown 语法不会被转换，像是星号便只是星号。

分割线

在一行中用三个以上的星号、减号、底线来建立一个分隔线，行内不能有其他东西。

1
2
3
***
---
___

区段元素

链接

Markdown 支持两种形式的链接语法： 行内式和参考式两种形式。

不管是哪一种，链接文字都是用 [方括号] 来标记。

行内式

建立一个行内式的链接，只要在方块括号后面紧接着圆括号并插入网址链接即可，如果你还想要加上链接的title文字，只要在网址后面，用双引号把title文字包起来即可

1
2
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.

如果你是要链接到同样主机的资源，你可以使用相对路径：

1
See my [About](/about/) page for details.

参考式

在链接文字的括号后面再接上另一个方括号，而在第二个方括号里面要填入用以辨识链接的标记：

1
This is [an example][id] reference-style link.

你也可以选择性地在两个方括号中间加上一个空格：

1
This is [an example] [id] reference-style link.

接着，在文件的任意处，你可以把这个标记的链接内容定义出来：

1
[id]: http://example.com/  "Optional Title Here"

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

1
[Google][]

然后定义链接内容：

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

注：链接辨别标签可以有字母、数字、空白和标点符号，但是并不区分大小写，链接的定义可以放在文件中的任何一个地方，我比较偏好直接放在链接出现段落的后面，你也可以把它放在文件最后面，就像是注解一样。

强调

Markdown 使用星号（*）和底线（_）作为标记强调字词的符号。

1
2
3
4
*single asterisks*
_single underscores_
**double asterisks**
__double underscores__

注：用什么符号开启标签，就要用什么符号结束，强调可以出现在文字中间，但如果*和_两边都有空白的话，它们将被当成普通的符号。

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

1
\*this text is surrounded by literal asterisks\*

代码

如果要标记一小段行内代码，你可以用反引号把它包起来（`），例如：

1
Use the `printf()` function.

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

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

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

1
2
3
A single backtick in a code span: `` ` ``

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

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

图片

Markdown 使用一种和链接很相似的语法来标记图片，同样也允许两种样式：行内式和参考式。

行内式:

1
2
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")

详细叙述如下：

  • 一个惊叹号 !
  • 接着一个方括号，里面放上图片的替代文字
  • 接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上 选择性的 ‘title’ 文字。

参考式:

1
![Alt text][id]

「id」是图片参考的名称，图片参考的定义方式则和连结参考一样：

1
[id]: url/to/image  "Optional title attribute"

到目前为止， Markdown 还没有办法指定图片的宽高，如果你需要的话，你可以使用普通的<img> 标签。

其它

反斜杠

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

1
\*literal asterisks\*

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

1
2
3
4
5
6
7
8
9
10
11
12
\   反斜线
`   反引号
*   星号
_   底线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号

自动链接

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱，只要是用方括号包起来， Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样，例如：

1
<http://example.com/>

Markdown 会转为：

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

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

1
<address@example.com>

Markdown 会转成：

1
2
3
4
<a href="mailto:addre
ss@example.co
m">address@exa
mple.com</a>

在浏览器里面，这段字串（其实是 <a href="mailto:address@example.com">address@example.com</a>）会变成一个可以点击的「address@example.com」链接。

感谢

http://www.markdown.cn/#acknowledgement

-------------本文结束感谢您的阅读-------------