mobile wallpaper 1mobile wallpaper 2mobile wallpaper 3mobile wallpaper 4
Profile Image of the Author
Kniff::ffe
GitHub
公告
初次跳转会遇到格式问题，请刷新网页
标签
2351 字
7 分钟
Markdown 教程
2025-01-20
Examples
Markdown

Markdown 教程#

一个 Markdown 示例，展示如何编写 Markdown 文件。本文档整合了核心语法与扩展语法（GMF）。

块元素#

段落与换行#

段落#

HTML 标签：<p>

一个或多个空行。（空行是指只包含空格或制表符的行，也算作空行。）

代码：

This will be
inline.


This is second paragraph.

预览：

This will be inline.

This is second paragraph.

换行#

HTML 标签：<br />

在行尾加上两个或更多空格。

代码：

This will be not
inline.

预览：

This will be not
inline.

标题#

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

Setext#

HTML 标签：<h1>、<h2>

使用等号 (=) 作为 <h1> 的下划线，使用连字符 (-) 作为 <h2> 的下划线，数量不限。

代码：

This is an H1
=============
This is an H2
-------------

预览：

This is an H1#

This is an H2#

atx#

HTML 标签：<h1>、<h2>、<h3>、<h4>、<h5>、<h6>

在行首使用 1-6 个井号 (#)，分别对应 <h1> 到 <h6>。

代码：

# This is an H1
## This is an H2
###### This is an H6

预览：

This is an H1#

This is an H2#

This is an H6#

你也可以选择”闭合” atx 样式的标题。结尾的井号不需要与开头标题的井号数量匹配。

代码：

# This is an H1 #
## This is an H2 ##
### This is an H3 ######

预览：

This is an H1#

This is an H2#

This is an H3#

引用块#

HTML 标签：<blockquote>

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

预览：

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

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

代码：

> ## This is a header.
>
> 1.   This is the first list item.
> 2.   This is the second list item.
>
> Here's some example code:
>
>     return shell_exec("echo $input | $markdown_script");

预览：

This is a header.#

  1. This is the first list item.
  2. This is the second list item.

Here’s some example code:

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

列表#

Markdown 支持有序（编号）和无序（项目符号）列表。

无序列表#

HTML 标签：<ul>

无序列表使用星号 (*)、加号 (+) 和连字符 (-)。

代码：

*   Red
*   Green
*   Blue

预览：

  • Red
  • Green
  • Blue

等价于：

代码：

+   Red
+   Green
+   Blue

以及：

代码：

-   Red
-   Green
-   Blue

有序列表#

HTML 标签：<ol>

有序列表使用数字后跟句点：

代码：

1.  Bird
2.  McHale
3.  Parish

预览：

  1. Bird
  2. McHale
  3. Parish

可能会意外触发有序列表，例如这样写：

代码：

1986. What a great season.

预览：

  1. What a great season.

你可以使用反斜杠转义 (\) 句点：

代码：

1986\. What a great season.

预览：

1986. What a great season.

缩进#

引用块#

要在列表项中放入引用块，引用块的 > 分隔符需要缩进：

代码：

*   A list item with a blockquote:


    > This is a blockquote
    > inside a list item.

预览：

  • A list item with a blockquote:

    This is a blockquote inside a list item.

代码块#

要在列表项中放入代码块，代码块需要缩进两次——8 个空格或两个制表符：

代码：

*   A list item with a code block:


        <code goes here>

预览：

  • A list item with a code block:

    <code goes here>
嵌套列表#

代码：

* A
  * A1
  * A2
* B
* C

预览：

  • A
    • A1
    • A2
  • B
  • C

代码块#

HTML 标签：<pre>

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

代码：

This is a normal paragraph:


    This is a code block.

预览：

This is a normal paragraph:

This is a code block.

代码块会一直持续到遇到没有缩进的那一行（或文章结束）。

在代码块中，与号 (&) 和尖括号 (< 和 >) 会自动转换为 HTML 实体。

代码：

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

预览：

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

以下章节「围栏代码块」和「语法高亮」是扩展语法，你可以使用另一种方式来编写代码块。

围栏代码块#

只需将代码包裹在 ``` 中（如下所示），就不需要缩进四个空格。

代码：

Here's an example:


```
function test() {
  console.log("notice the blank line before this function?");
}
```

预览：

Here’s an example:

function test() {
  console.log("notice the blank line before this function?");
}

语法高亮#

在围栏代码块中，添加一个可选的语言标识符，我们将对其进行语法高亮处理（支持的语言）。

代码：

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

预览：

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

水平分割线#

HTML 标签：<hr /> 在单独一行中放置三个或更多连字符 (-)、星号 (*) 或下划线 (_)。你可以在连字符或星号之间使用空格。

代码：

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

预览：

表格#

HTML 标签：<table>

这是扩展语法。

使用竖线 (|) 分隔列，使用连字符 (-) 分隔表头，并使用冒号 (:) 设置对齐方式。

外层的竖线 (|) 和对齐设置是可选的。每个单元格至少需要 3 个分隔符来分隔表头。

代码：

| Left | Center | Right |
|:-----|:------:|------:|
|aaa   |bbb     |ccc    |
|ddd   |eee     |fff    |


 A | B
---|---
123|456




A |B
--|--
12|45

预览：

LeftCenterRight
aaabbbccc
dddeeefff
AB
123456
AB
1245

行内元素#

链接#

HTML 标签：<a>

Markdown 支持两种链接样式：行内和引用。

行内链接#

行内链接格式如下：[链接文本](URL "标题")

标题是可选的。

代码：

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


[This link](http://example.net/) has no title attribute.

预览：

This is an example inline link.

This link has no title attribute.

如果你引用的是同一服务器上的本地资源，可以使用相对路径：

代码：

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

预览：

See my About page for details.

引用链接#

你可以预定义链接引用。格式如下：[id]: URL "标题"

标题也是可选的。然后引用链接时，格式如下：[链接文本][id]

代码：

[id]: http://example.com/  "Optional Title Here"
This is [an example][id] reference-style link.

预览：

This is an example reference-style link.

即：

  • 方括号中包含链接标识符（不区分大小写，可以选择从左边界缩进最多三个空格）；
  • 后跟一个冒号；
  • 后跟一个或多个空格（或制表符）；
  • 后跟链接的 URL；
  • 链接 URL 可以选择性地用尖括号括起来。
  • 可选地后跟链接的标题属性，用双引号、单引号或括号括起来。

以下三个链接定义是等价的：

代码：

[foo]: http://example.com/  "Optional Title Here"
[foo]: http://example.com/  'Optional Title Here'
[foo]: http://example.com/  (Optional Title Here)
[foo]: <http://example.com/>  "Optional Title Here"

使用空的方括号，链接文本本身会作为名称使用。

代码：

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

预览：

Google

强调#

HTML 标签：<em>、<strong>

Markdown 将星号 (*) 和下划线 (_) 视为强调的标记。单个分隔符表示 <em>；*双分隔符 表示 <strong>。

代码：

*single asterisks*


_single underscores_


**double asterisks**


__double underscores__

预览：

single asterisks

single underscores

double asterisks

double underscores

但如果 * 或 _ 周围有空格，它将被视为字面星号或下划线。

你可以使用反斜杠转义：

代码：

\*this text is surrounded by literal asterisks\*

预览：

*this text is surrounded by literal asterisks*

行内代码#

HTML 标签：<code>

用反引号 (`) 包裹。

代码：

Use the `printf()` function.

预览：

Use the printf() function.

要在代码片段中包含字面反引号字符，你可以使用多个反引号作为开头和结尾的分隔符：

代码：

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

预览：

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 标签：<img />

Markdown 使用的图片语法与链接语法类似，支持两种样式：行内和引用。

行内图片#

行内图片语法如下：![替代文本](URL "标题")

标题是可选的。

代码：

![Alt text](/path/to/img.jpg)


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

预览：

Alt text

Alt text

即：

  • 一个感叹号：!；
  • 后跟一组方括号，包含图片的 alt 属性文本；
  • 后跟一组圆括号，包含图片的 URL 或路径，以及可选的用双引号或单引号括起来的标题属性。

引用图片#

引用式图片语法如下：![替代文本][id]

代码：

[img id]: https://s2.loli.net/2024/08/20/5fszgXeOxmL3Wdv.webp  "Optional title attribute"
![Alt text][img id]

预览：

Alt text

删除线#

HTML 标签：<del>

这是扩展语法。

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

代码：

~~Mistaken text.~~

预览：

Mistaken text.

其他#

自动链接#

Markdown 支持一种快捷方式，用于为 URL 和电子邮件地址创建”自动”链接：只需将 URL 或电子邮件地址用尖括号括起来。

代码：

<http://example.com/>


<address@example.com>

预览：

http://example.com/

address@example.com

GFM 会自动链接标准 URL。

代码：

https://github.com/emn178/markdown

预览：

https://github.com/emn178/markdown

反斜杠转义#

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

代码：

\*literal asterisks\*

预览：

*literal asterisks*

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

代码：

\   反斜杠
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  圆括号
#   井号
+   加号
-   减号（连字符）
.   句点
!   感叹号

内联 HTML#

对于 Markdown 语法未涵盖的任何标记，你可以直接使用 HTML 本身。无需为其添加前缀或分隔符来表明你正在从 Markdown 切换到 HTML；直接使用标签即可。

代码：

This is a regular paragraph.


<table>
    <tr>
        <td>Foo</td>
    </tr>
</table>


This is another regular paragraph.

预览：

This is a regular paragraph.

Foo

This is another regular paragraph.

请注意，Markdown 格式化语法在块级 HTML 标签内部不会被处理。

与块级 HTML 标签不同，Markdown 语法在行内级标签内部会被处理。

代码：

<span>**Work**</span>


<div>
    **No Work**
</div>

预览：

Work

**No Work**
---
分享

如果这篇文章对你有帮助，欢迎分享给更多人！

Markdown 教程
https://github.com/emn178/markdown
作者
emn178
发布于
2025-01-20
许可协议
Unlicensed

部分信息可能已经过时

HTTP状态码
相关文章 智能推荐
1
星辰恋曲的白色永恒 攻略
Galgame 星辰恋曲的白色永恒 攻略
2
南京半日游
Daily 在南京耍了半天
3
sqlmap使用实例
CTF sqlmap部分功能使用
4
LOST:SMILE攻略
Galgame LOST:SMILE攻略
5
HTTP状态码
HTTP HTTP状态码分类及列表
随机文章 随机推荐
1
sqlmap使用实例
CTF 2026-09-17
2
星辰恋曲的白色永恒 攻略
Galgame 2026-09-13
3
南京半日游
Daily 2026-09-22
4
LOST:SMILE攻略
Galgame 2026-08-24
5
HTTP状态码
HTTP 2026-08-22
© 2026 Kniff::ffe. All Rights Reserved. / RSS / Atom / Sitemap
Powered by Astro & Mizuki  Version 9.0

目录