段落与换行#

1
这将会在
2
同一行.
3

4
这是第二个段落.

1
这将不会在
2
同一行.

标题#

Markdown 支持两种标题样式：Setext 和 atx.

1
这是一级标题
2
=============
3
这是二级标题
4
-------------

atx#

HTML 标签: <h1>, <h2>, <h3>, <h4>, <h5>, <h6>

在首行使用1-6个 井号 (#) 对应 <h1> - <h6>.

代码:

1
# 这是一级标题
2
## 这是二级标题
3
###### 这是六级标题

预览:

这是六级标题#

你也可以选择在 atx 样式标题的末尾添加关闭的井号,结尾的井号数量不需要与开头的井号数量一致.

代码:

1
# 这是一级标题 #
2
## 这是二级标题 ##
3
### 这是六级标题 ######:

预览:

这是三级标题#

引用#

HTML 标签: <blockquote>

Markdown 使用类似电子邮件的 > 字符来表示引用.最佳效果是将文本进行硬换行,并在每一行前加上一个 >.

代码:

1
> 这是一个包含两个段落的引用. 请君子安坐,静心阅读,
2
> 引用的文字通常用于强调或引用他人言论.
3
> 你可以在这里写下需要引用的内容.
4
>
5
> 这是第二个段落.引用也可以包含多行文字,
6
> 并且每一行都需要在前面加上 > 符号.

预览:

这是一个包含两个段落的引用.请君子安坐,静心阅读, 引用的文字通常用于强调或引用他人言论. 你可以在这里写下需要引用的内容.

这是第二个段落.引用也可以包含多行文字 并且每一行都需要在前面加上 > 符号.

Markdown 允许你偷懒，只在硬换行段落的第一行前加上 > ，后续行即使没有 > 也会被视为同一个引用段落.

代码:

1
> 这是包含两个段落的引用. Lorem ipsum dolor sit amet,
2
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
3
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
4

5
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
6
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.

引用可以嵌套(即引用中的引用),通过添加额外层级的 > 来实现.

代码:

1
> 这是第一层引用.
2
>
3
> > 这是嵌套引用.
4
>
5
> 回到第一层.

预览:

这是第一层引用.

这是嵌套引用.

回到第一层.

引用可以包含其他 Markdown 元素,包括标题,列表和代码块.

代码:

1
> ## 这是一个标题.
2
>
3
> 1.   这是第一个列表项.
4
> 2.   这是第二个列表项.
5
>
6
> 这里有一些示例代码:
7
>
8
>     return shell_exec("echo $input | $markdown_script");

预览:

这是一个标题.#

1. 这是第一个列表项.
2. 这是第二个列表项.

这里有一些示例代码:

1
return shell_exec("echo $input | $markdown_script");

列表#

Markdown 支持有序(编号) 列表和**无序(项目符号)列表.

1
*   红色
2
*   绿色
3
*   蓝色

1
+   红色
2
+   绿色
3
+   蓝色

1
-   红色
2
-   绿色
3
-   蓝色

1
1.  鸟
2
2.  麦克海尔
3
3.  帕里什

1
1986. 多么美好的赛季.

1
1986\. 多么美好的赛季.

1
*   一个包含引用的列表项:
2

3
    > 这是一个在
4
    > 列表项中的引用.

1
*   一个包含代码块的列表项:
2

3
        <代码放这里>

1
* A
2
  * A1
3
  * A2
4
* B
5
* C

代码块#

HTML 标签: <pre>

将代码块的每一行缩进至少4个空格或1个制表符.

代码:

1
这是一个普通段落:
2

3
    这是一个代码块.

预览:

这是一个普通段落:

1
这是一个代码块.

代码块会一直持续,直到遇到没有缩进的行(或文章结尾).

在代码块内, &符号(&) 和尖括号(< 和 >) 会自动转换为 HTML 实体.

代码:

1
    <div class="footer">
2
        &copy; 2004 Foo Corporation
3
    </div>

预览:

1
<div class="footer">
2
    &copy; 2004 Foo Corporation
3
</div>

以下部分”围栏代码块”和”语法高亮”是扩展功能,你可以使用另一种方式编写代码块.

1
这是一个例子:
2

3
```
4
function test() {
5
  console.log("注意到这个函数前的空行了吗?");
6
}
7
```

1
function test() {
2
  console.log("注意到这个函数前的空行了吗?");
3
}

1
```ruby
2
require 'redcarpet'
3
markdown = Redcarpet.new("Hello World!")
4
puts markdown.to_html
5
```

1
require 'redcarpet'
2
markdown = Redcarpet.new("Hello World!")
3
puts markdown.to_html

分割线#

HTML 标签: <hr /> 将三个或更多短横线 (-), 星号(*), 或 下划线(_) 单独放一行. 你可以在短横线或星号之间使用空格.

代码:

1
* * *
2
***
3
*****
4
- - -
5
---------------------------------------
6
___

预览:

表格#

HTML 标签: <table>

这是一个扩展.

用竖线 (|) 分割列,用短横线 (-) 分割表头,并用 冒号 (:) 进行对齐.

外层的竖线 (|) 和对齐方式是可选的.每个单元格至少有3 个定界符用于分隔表头.

代码:

1
| 左对齐 | 居中 | 右对齐 |
2
|:-----|:------:|------:|
3
|aaa   |bbb     |ccc    |
4
|ddd   |eee     |fff    |
5

6
 A | B
7
---|---
8
123|456
9

10

11
A |B
12
--|--
13
12|45

预览:

链接#

HTML 标签: <a>

Markdown 支持两种样式的链接: 行内式和参考式.

1
这是一个 [例子](http://example.com/ "标题") 行内链接.
2

3
[链接](http://example.net/) 没有标题属性.

1
查看我的 [关于](/about/)页面获取详情.

1
[id]: http://example.com/  "可选标题在这里"
2
这是一个 [例子][id] 参考式链接.

1
[foo]: http://example.com/  "可选标题在这里"
2
[foo]: http://example.com/  '可选标题在这里'
3
[foo]: http://example.com/  (可选标题在这里)
4
[foo]: <http://example.com/>  "可选标题在这里"

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

强调#

HTML 标签: <em>, <strong>

Markdown 将星号 (*) 和下划线 (_) 视为强调指示符.一个定界符将是  <strong>；两个定界符 *_将是  <strong>

代码:

1
*单星号*
2

3
_单下划线_
4

5
**双星号**
6

7
__双下划线__

预览:

单星号

单下划线

双星号

双下划线

但是如果你用空格包围 * 或 _,它将被视为字面量的星号或下划线.

你可以用反斜杠转义它:

代码:

1
\*这段文字被字面量星号包围\*

预览:

*这段文字被字面量星号包围*

行内代码#

HTML 标签: <code>

用 反引号 ( ` ) 包裹它.

代码:

1
使用 `printf()` 函数.

预览:

使用 printf() 函数.

要在代码跨度中包含一个字面量反引号字符,可以使用多个反引号作为开头和结尾的定界符:

代码:

1
``这里有一个字面量反引号 (`).``

预览:

这里面有一个字面量反引号 (`).

包围代码跨度的反引号定界符可以包含空格—开头后一个,结尾前一个.这允许你在代码跨度的开头或结尾放置字面量反引号字符:

代码:

1
代码跨度中的单个反引号: `` ` ``
2

3
代码跨度中由反引号分隔的字符串: `` `foo` ``

预览:

代码跨度中的单个反引号: `

代码跨度中由反引号分隔的字符串: `foo`

图片#

HTML 标签: <img />

Markdown 使用一种旨在类似于链接语法的图片语法,允许两种样式:行内式和参考式.

1
![替代文本](/path/to/img.jpg)
2

3
![替代文本](/path/to/img.jpg "可选标题")

1
[img id]: https://s2.loli.net/2024/08/20/5fszgXeOxmL3Wdv.webp  "可选的标题属性"
2
![替代文本][img id]

删除线#

HTML 标签: <del>

这是一个扩展功能.

GFM 添加了删除线文本的语法.

代码:

1
~~错误的文本.~~

预览:

错误的文本.

自动链接#

Markdown 支持创建 URL 和电子邮件地址”自动”链接的快捷方式:只需用尖括号将 URL 或电子邮件地址括起来.

代码:

1
<http://example.com/>
2

3
<address@example.com>

预览:

http://example.com/

address@example.com

GFM 会自动链接标准 URL.

代码:

1
https://github.com/emn178/markdown

预览:

https://github.com/emn178/markdown

反斜杠转义#

Markdown 允许你使用反斜杠转义来生成原本在 Markdown 格式化语法中具有特殊含义的字面量字符.

代码:

1
\*字面量星号\*

预览:

*字面量星号*

Markdown 为以下字符提供反斜杠转义:

代码:

1
\   反斜杠
2
`   反引号
3
*   星号
4
_   下划线
5
{}  花括号
6
[]  方括号
7
()  圆括号
8
#   井号
9
+   加号
10
-   减号 (连字符)
11
.   点
12
!   感叹号