Markdown 教程

Created: March 4, 2022, Jingyu Liu

Last update: Sept 9, 2024

Markdown 是一种轻量级的标记语言，可用于在纯文本文档中添加格式化元素。事实上，本篇教程就是用 Markdown 写成的。我们推荐使用 VS Code 写 Markdown，请注意，Markdown 文件的后缀是 .md。

在这里，我们列出一些常用的 Markdown 语法供查阅，并加以简单的说明。

• 在文字前面添加 # 即可创建标题，# 的数量 (1-6) 代表了标题的级别，级别越小，标题的字体越大。

• 使用空白行将一行或多行文本进行分隔。

• 在一行的末尾添加两个或多个空格，然后按回车键，即可换行。

• 加粗：在文字前后各添加2个星号 ** 或下划线 __，可以使文字加粗。

  示例：**这是一段加粗的文本** 显示为 这是一段加粗的文本。

• 斜体：在文字前后各添加1个星号 * 或下划线 _，可以使文字斜体。

  示例：*这是一段斜体的文本* 显示为 这是一段斜体的文本。

• 斜粗体：在文字前后各添加3个星号 *** 或下划线 ___，可以使文字同时为斜体和加粗。

• 在段落前添加一个 > 符号可以创建引用。对于多个段落的引用，请记得在空白行也添加 >。引用可以嵌套，在要嵌套的段落前添加一个 >> 符号。

• 有序列表：在每个列表项前添加数字并紧跟一个英文句点可以创建有序列表。数字不必按顺序排列，Markdown 会自动为您排序。我们建议在每一项前都使用 1.，Markdown 会自动排序。

• 无序列表：在每个列表项前添加破折号 -、星号 * 或加号 + 可以创建无序列表。

• 代码块：
  • 使用单个反引号 ` 包裹单行代码。例如：`print("Hello World")` 显示为 print("Hello World")。
  • 使用三个反引号 ``` 包裹多行代码块，反引号后可以加上语言标识来启用语法高亮。例如：

    ```python
    print("Hello World")
    ```
    

  • 如果代码中需要使用反引号，可以用更多的反引号包裹代码块。

• 将代码块的每一行缩进至少四个空格或一个制表符，也可以创建代码块，但使用三个反引号是更常见的方式。

• 在单独一行上使用三个或多个星号 ***、破折号 --- 或下划线 ___ 可以创建分割线。

• 超链接：使用 [<显示文本>](<链接> "<标题>") 创建超链接。例如：

  [点击这里](https://advancedsolver.com) 显示为 点击这里。

• 用尖括号 <> 添加网址。例如：https://advancedsolver.com。

• 图片：![<替代文字>](<图片链接> "图片标题")，替代文字在图片无法显示时会显示出来，图片标题是可选项，当鼠标悬停在图片上时会显示标题。

• Markdown 的转义字符是 \，如果你想要在 Markdown 中显示特殊字符（例如 * 或 _），可以在前面添加 \。

• 使用 [//]: <> (这是注释) 在 Markdown 文档中添加注释，注释不会显示在渲染的页面中。

• 我们特别推荐使用插件 markdownlint，它可以自动指出 Markdown 中的错误，帮助保持文档的一致性。你可以在 VS Code 插件市场中安装它，实时检测并修复文档中的错误。

---