mobile wallpaper 1mobile wallpaper 2mobile wallpaper 3mobile wallpaper 4mobile wallpaper 5mobile wallpaper 6
Profile Image of the Author
Rinhon
在干嘛？
偷偷学习中...
标签
站点统计
文章
14
分类
10
标签
24
总字数
14,875
运行时长
0 天
最后活动
0 天前
2623 字
13 分钟
Markdown 教程
2025-01-20
示例
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 使用一种旨在类似于链接语法的图片语法，允许两种风格：行内和引用。

行内#

行内图片语法如下：![Alt text](URL "标题")

标题是可选的。

代码：

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


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

预览：

Alt text

Alt text

也就是：

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

引用#

引用风格的图片语法如下：![Alt text][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 为以下字符提供反斜杠转义：

代码：

\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
-   minus sign (hyphen)
.   dot
!   exclamation mark

行内 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
作者
Rinhon
发布于
2025-01-20
许可协议
Unlicensed

部分信息可能已经过时

docker
Markdown 扩展功能
© 2026 Rinhon. All Rights Reserved. / RSS / Atom / Sitemap
Powered by Astro & Mizuki  Version 7.6.5
封面
Sample Song
Sample Artist
封面
Sample Song
Sample Artist
0:00 / 0:00