Markdown 语法基础教程

Markdown 基础教程#

本示例展示了如何编写 Markdown 文件。本文集成了标准 Markdown 语法及 GFM (GitHub Flavored Markdown) 扩展语法。

块级元素#

段落与换行#

段落#

HTML 标签:<p>

由一个或多个空行隔开。(只包含空格或制表符的行均视为空行。)

代码示例:

这是第一段文本。

这是第二段文本。

效果预览:


这是第一段文本。

这是第二段文本。


强制换行#

HTML 标签:<br />

在一行的末尾添加 两个或多个空格 后按回车。

代码示例:

这是不会自动
换行的两行文本。

这是末尾加了两个空格
可以强制换行的文本。

效果预览:


这是末尾加了两个空格
可以强制换行的文本。


标题#

Markdown 支持 Setext 和 atx 两种标题语法。

atx 语法(推荐)#

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

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

代码示例:

# 一级标题 H1
## 二级标题 H2
### 三级标题 H3

效果预览:


一级标题 H1#

二级标题 H2#

三级标题 H3#


引用块#

HTML 标签:<blockquote>

使用类似于电子邮件引用的 > 符号。

代码示例:

> 这是一个引用块段落。落霞与孤鹜齐飞,秋水共长天一色。
>
> 这是引用块中的第二个段落。

效果预览:


这是一个引用块段落。落霞与孤鹜齐飞,秋水共长天一色。

这是引用块中的第二个段落。


列表#

无序列表#

HTML 标签:<ul>

使用 星号 (*)加号 (+)减号 (-) 表示。

代码示例:

- 红色
- 绿色
- 蓝色

效果预览:


  • 红色
  • 绿色
  • 蓝色

有序列表#

HTML 标签:<ol>

数字后跟一个英文句点:

代码示例:

1. 第一项内容
2. 第二项内容
3. 第三项内容

效果预览:


  1. 第一项内容
  2. 第二项内容
  3. 第三项内容

代码块#

HTML 标签:<pre>

围栏代码块 (Fenced Code Blocks)#

使用三个反引号 ``` 包裹代码即可:

function hello() {
  console.log("Hello, Mizuki!");
}

语法高亮 (Syntax Highlighting)#

在反引号后加上语言标识符(如 tspythoncss):

export interface User {
  id: string;
  name: string;
}

分割线#

HTML 标签:<hr />

在独占一行中使用 三个或以上的连字符 (-)、星号 (*) 或下划线 (_)


表格 (Table)#

HTML 标签:<table>

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

代码示例:

| 左对齐 | 居中对齐 | 右对齐 |
| :----- | :------: | -----: |
| 文本A  |  文本B   |  文本C |

效果预览:


左对齐居中对齐右对齐
文本A文本B文本C

行内元素#

超链接#

HTML 标签:<a>

语法格式:[链接文本](URL "可选标题")

例如:查看 Mizuki 官方仓库 或访问 关于我 页面。

文本强调#

使用 *斜体*_斜体_ 渲染 斜体 文本。
使用 **粗体**__粗体__ 渲染 粗体 文本。

行内代码#

使用单个反引号包裹:比如 console.log()

删除线#

使用两个波浪号 ~~ 包裹:这是被删除的文字

行内 HTML#

对于 Markdown 语法未覆盖的特殊格式,您可以直接插入原生的 HTML 标签:

行内 HTML 粗体元素

Markdown 语法基础教程
作者:emn178
Unlicensed出处
相关文章