请通过邮件订阅网站，随时获取最新动态！

Markdown 语法

  • 最后更新: 8 个月前

# Markdown 语法

Markdown 是一个轻量级且易于阅读和编写的语法，致力于使文档创作变得更简单。

# 标题

要创建标题，请在标题文本前添加一至六个 # 符号。使用的 # 数量将决定标题的大小。

# 一级标题
## 二级标题
###### 六级标题

# 样式文本

你可以使用粗体、斜体或删除线文本来表示强调。

样式 语法 示例 输出
粗体 ** ** 或 __ __ **这是粗体文本** 这是粗体文本
斜体 * * 或 _ _ *这是斜体文本* 这是斜体文本
删除体 ~~ ~~ ~~这是错误文本~~ 这是错误文本
粗体和嵌入的斜体 ** ** 和 _ _ **此文本 _非常_ 重要** 此文本 非常 重要
全部粗体和斜体 *** *** ***所有这些文本都很重要*** 所有这些文本都很重要

# 段落

通过在文本行之间留一个空白行，可创建新段落。

# 引用文本

你可以使用 > 来引用文本。

琵琶乐在白居易诗中的艺术表现：

> 大弦嘈嘈如急雨，小弦切切如私语。嘈嘈切切错杂弹，大珠小珠落玉盘。

> 琵琶乐在白居易诗中的艺术表现：

大弦嘈嘈如急雨，小弦切切如私语。嘈嘈切切错杂弹，大珠小珠落玉盘。

# 引用代码

使用单反引号可标注句子中的代码或命令，反引号 `` 中的文本不会被格式化。

使用 `git status` 列出尚未提交的所有新文件或已修改文件。

> 使用 git status 列出尚未提交的所有新文件或已修改文件。

# 代码围栏

要将代码或文本格式化为各自的不同块，请使用三反引号 ```。

一些基本的 Git 命令为：
```
git status
git add
git commit
```

> 一些基本的 Git 命令为：

git status
git add
git commit

我们建议在代码块的前后各留一个空白行，使原始格式更易辨读。

# 语法突出

你可以添加可选的语言标识符，以在代码围栏中启用语法突显。

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

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

GitHub 使用 Linguist (opens new window) 来执行语言检测并选择第三方语法进行语法突显。请参阅：语言 YAML 文件 (opens new window)

# 链接

通过将链接文本包含在方括号 [ ] 内，然后将 URL 包含在括号 ( ) 内，可创建内联链接。

本站点是使用 [VuePress](https://vuepress.vuejs.org/zh/) 构建的。

> 本站点是使用 VuePress (opens new window) 构建的。

# 章节链接

你可以直接链接到渲染文件中的某个部分，方法是将鼠标悬停在该部分标题上以显示链接。

# 相对链接

你可以在渲染的文件中定义相对链接和图像路径，以帮助读者导航到仓库中的其他文件。

相对链接是相对于当前文件的链接。例如，如果在仓库根目录下有一个自述文件，而在 .github/CONTRIBUTING.md 中有另一个文件，则自述文件中的 CONTRIBUTING.md 的相关链接如下所示：

[此项目的参与指南](.github/CONTRIBUTING.md)

建议使用相对链接引用仓库中的其他文件。你可以使用所有相对链接操作符，如 ./ 和 ../ 。

# 列表

# 无序列表

通过在一行或多行文本前面添加 - 或 * 可创建无序列表。

- Vue
- React
- Angular
  • Vue
  • React
  • Angular

# 有序列表

要对列表排序，请在每行前面添加一个编号。

1. 🏆 刘翔（中国）12秒91
2. 🥈 特拉梅尔（美国）13秒18
3. 🥉 加西亚（古巴）13秒20
  1. 🏆 刘翔（中国）12秒91
  2. 🥈 特拉梅尔（美国）13秒18
  3. 🥉 加西亚（古巴）13秒20

# 嵌套列表

通过在一个列表项下面缩进一个或多个其他列表项，可创建嵌套列表。

1. 第一个列表项
    -  第一个嵌套列表项
        - 第二个嵌套列表项
  1. 第一个列表项
    • 第一个嵌套列表项
      • 第二个嵌套列表项

# 任务列表

要创建任务列表，在列表项目前面加一个常规空格字符，后接 [ ]。要将任务标记为已完成，请使用 [x]。

- [x] 完成更改
- [ ] 提交代码
- [ ] 拉取请求
  • [x] 完成更改
  • [ ] 提交代码
  • [ ] 拉取请求

# 表格内容

你可以用竖线 | 和横线 - 创建表格。横线用于创建每列的标题，而竖线用于分隔每列。必须在表格前包含空白链接，以便其正确呈现。

| 第一个表头  | 第二个表头 |
| --------- | --------- |
| 单元格内容  | 单元格内容  |
| 单元格内容  | 单元格内容  |
第一个表头 第二个表头
单元格内容 单元格内容
单元格内容 单元格内容

单元格的宽度可以不同，无需在列内准确对齐。标题行的第一列中必须至少有三个横线，表格末尾的竖线可选。

| 命令 | 描述
| --- | ---
| git status | 显示所有新增或修改的文件
| git commit | 将暂存区里的改动给提交到本地的版本库
命令 描述
git status 显示所有新增或修改的文件
git commit 将暂存区里的改动给提交到本地的版本库

最后，你还可以在表格中使用格式，如链接、内联代码块和文本样式。

# 忽略格式

通过在 Markdown 字符前面输入 \，可以忽略（或规避）Markdown 格式。

让我们将 \*one-product\* 重命名为 \*next-product\*。

> 让我们将 *one-product* 重命名为 *next-product*。

图片引入 书写规范