Markdown 和 Visual Studio Code

在 Visual Studio Code 中使用 Markdown 文件非常简单、直接且有趣。除了 VS Code 的基本编辑功能外，还有一些 Markdown 特有的功能可以帮助您提高工作效率。

注意：为了帮助您开始编辑 Markdown 文件，您可以使用文档编写器配置文件模板来安装有用的扩展（拼写检查器、Markdown 代码检查器）并配置适当的设置值。

编辑 Markdown

文档大纲

“大纲”视图是文件资源管理器底部的单独部分。展开后，它会显示当前活动编辑器的符号树。对于 Markdown 文件，符号树是 Markdown 文件的标题层级结构。

“大纲”视图是查看文档的标题结构和轮廓的好方法。

Markdown 代码片段

VS Code 包含一些有用的代码片段，可以加快编写 Markdown 的速度。这包括用于代码块、图像等的代码片段。在编辑时按 ⌃Space (Windows, Linux Ctrl+Space)（触发建议）以查看建议的 Markdown 代码片段列表。您还可以通过在命令面板中选择“插入代码片段”来使用专用的代码片段选择器。

提示： 您可以为 Markdown 添加自己的用户定义代码片段。请查看用户定义代码片段以了解如何操作。

转到文件中的标题

使用 ⇧⌘O (Windows, Linux Ctrl+Shift+O) 以快速跳转到当前文件中的标题。

您可以浏览文件中的所有标题，或开始键入标题名称以查找您想要的标题。找到您想要的标题后，按 Enter 将光标移动到该标题。按 Esc 取消跳转到标题。

转到工作区中的标题

使用 ⌘T (Windows, Linux Ctrl+T) 在当前工作区中的所有 Markdown 文件中搜索标题。

开始键入标题名称以筛选列表并找到您想要的标题。

路径补全

路径补全有助于创建指向文件和图像的链接。当您键入图像或链接的路径时，这些路径会自动由IntelliSense显示，也可以使用 ⌃Space (Windows, Linux Ctrl+Space) 手动请求。

以 / 开头的路径相对于当前工作区根目录解析，而以 ./ 开头或没有任何前缀的路径相对于当前文件解析。当您键入 / 时，会自动显示路径建议，也可以使用 ⌃Space (Windows, Linux Ctrl+Space) 手动调用。

路径 IntelliSense 还可以帮助您链接到当前文件或另一个 Markdown 文件中的标题。以 # 开头路径以查看文件中所有标题的补全（根据您的设置，您可能需要使用 ⌃Space (Windows, Linux Ctrl+Space) 才能看到这些）

您可以使用 "markdown.suggest.paths.enabled": false 禁用路径 IntelliSense。

创建指向另一个文件中标题的链接

需要链接到另一个 Markdown 文档中的标题，但不记得或不想键入完整的文件路径？尝试使用工作区标题补全！首先，只需在 Markdown 链接中键入 ##，即可查看当前工作区中所有 Markdown 标题的列表

接受其中一个补全以插入指向该标题的完整链接，即使它在另一个文件中

您可以使用 markdown.suggest.paths.includeWorkspaceHeaderCompletions 设置配置何时/是否显示工作区标题补全。有效设置值包括

• onDoubleHash（默认）— 仅在您键入 ## 后才显示工作区标题补全。
• onSingleOrDoubleHash— 在您键入 # 或 ## 后显示工作区标题补全。
• never— 永不显示工作区标题补全。

请记住，查找当前工作区中的所有标题可能很耗费资源，因此首次请求时可能会有轻微延迟，尤其是在包含大量 Markdown 文件的工作区中。

插入图像和文件链接

除了路径补全之外，VS Code 还支持其他几种将图像和文件链接插入到 Markdown 文档中的方法

您可以将文件从 VS Code 的资源管理器或操作系统拖放到 Markdown 编辑器中。首先从 VS Code 的资源管理器中拖动文件到 Markdown 代码上，然后按住 Shift 开始将其拖放到文件中。预览光标显示拖放时文件将插入的位置。

如果您更喜欢使用键盘，您也可以将文件或图像数据复制并粘贴到 Markdown 编辑器中。当您粘贴文件、文件链接或 URL 时，您可以选择插入 Markdown 链接或将链接作为纯文本包含在内。

或者，您可以使用“Markdown：从工作区插入图像”命令插入图像，使用“Markdown：插入到工作区中文件的链接”命令插入文件链接。

插入的图像使用 Markdown 图像语法 ![](path/to/image.png)。链接插入普通的 Markdown 链接 [](path/to/file.md)。

默认情况下，VS Code 会自动将工作区外部拖放或粘贴的图像复制到您的工作区中。markdown.copyFiles.destination 设置控制应在何处创建新的图像文件。此设置将匹配当前 Markdown 文档的 glob 映射到图像目标位置。图像目标位置也可以使用一些简单的变量。有关可用变量的信息，请参阅 markdown.copyFiles.destination 设置描述。

例如，如果您希望工作区中 /docs 下的每个 Markdown 文件都将新的媒体文件放入特定于当前文件的 images 目录中，则可以编写

"markdown.copyFiles.destination": {
  "/docs/**/*": "images/${documentBaseName}/"
}

现在，当新文件粘贴到 /docs/api/readme.md 中时，图像文件将在 /docs/api/images/readme/image.png 中创建。

您甚至可以使用简单的正则表达式来转换变量，方式与 代码片段 类似。例如，此转换在创建媒体文件时仅使用文档文件名的首字母

"markdown.copyFiles.destination": {
  "/docs/**/*": "images/${documentBaseName/(.).*/$1/}/"
}

当新文件粘贴到 /docs/api/readme.md 中时，图像现在在 /docs/api/images/r/image.png 下创建。

智能选择

智能选择使您可以快速扩展和缩小 Markdown 文档中的选择范围。这可以用于快速选择整个块元素（例如代码块或表格），以及选择 Markdown 文件中标题部分的全部内容。

智能选择使用以下命令

• 扩展：⌃⇧⌘→ (Windows, Linux Shift+Alt+Right)
• 缩小：⌃⇧⌘← (Windows, Linux Shift+Alt+Left)

选择适用于以下各项，并遵循传统的层级模式

• 标题
• 列表
• 块引用
• 围栏代码块
• Html 代码块
• 段落

链接验证

链接验证检查 Markdown 代码中的本地链接，以确保它们有效。这可以捕获常见错误，例如链接到已重命名的标题或磁盘上不再存在的文件。

链接验证默认处于关闭状态。要启用它，请设置 "markdown.validate.enabled": true。然后，VS Code 会分析 Markdown 链接到标题、图像和其他本地文件的链接。无效链接将报告为警告或错误。所有链接验证都在本地进行，并且不检查外部 http(s) 链接。

您可以使用一些设置来自定义链接验证

• markdown.validate.fileLinks.enabled - 启用/禁用本地文件链接的验证：[link](/path/to/file.md)
• markdown.validate.fragmentLinks.enabled - 启用/禁用当前文件中标题链接的验证：[link](#_some-header)
• markdown.validate.fileLinks.markdownFragmentLinks - 启用/禁用其他 markdown 文件中标题链接的验证：[link](other-file.md#some-header)
• markdown.validate.referenceLinks.enabled - 启用/禁用引用链接的验证：[link][ref]。
• markdown.validate.ignoredLinks - 跳过验证的链接 glob 列表。如果您链接到磁盘上不存在但在 Markdown 发布后存在的文件，这将很有用。

查找对标题和链接的所有引用

使用“查找所有引用”(⇧⌥F12 (Windows, Linux Shift+Alt+F12)) 命令查找当前工作区中引用 Markdown 标题或链接的所有位置

“查找所有引用”支持

• 标题：# My Header。显示指向 #my-header 的所有链接。
• 外部链接：[text](http://example.com)。显示指向 http://example.com 的所有链接。
• 内部链接：[text](./path/to/file.md)。显示指向 ./path/to/file.md 的所有链接
• 链接中的片段：[text](./path/to/file.md#my-header)。显示指向 ./path/to/file.md 中 #my-header 的所有链接

重命名标题和链接

是否厌倦了在更改 Markdown 标题时意外破坏链接？尝试使用“重命名符号”(F2) 代替。在您键入新的标题名称并按 Enter 后，VS Code 会更新标题并自动更新指向该标题的所有链接

您也可以在以下项上使用 F2

• 标题：# My Header。这将更新指向 #my-header 的所有链接。
• 外部链接：[text](http://example.com/page)。这将更新所有链接到 http://example.com/page 的位置
• 内部链接：[text](./path/to/file.md)。这将重命名文件 ./path/to/file.md，并更新指向它的所有链接。
• 链接中的片段：[text](./path/to/file.md#my-header)。这将重命名 ./path/to/file.md 中的标题，并更新指向它的所有链接。

在文件移动或重命名时自动更新链接

通过自动 Markdown 链接更新，每当链接到的文件移动或重命名时，VS Code 都会自动更新 Markdown 链接。您可以使用 markdown.updateLinksOnFileMove.enabled 设置启用此功能。有效设置值包括

• never（默认）— 不尝试自动更新链接。
• prompt — 在更新链接之前进行确认。
• always — 自动更新链接，无需确认。

自动链接更新检测 Markdown 文件、图像和目录的重命名。您可以使用 markdown.updateLinksOnFileMove.include 为其他文件类型启用它。

Markdown 预览

VS Code 开箱即用地支持 Markdown 文件。您只需开始编写 Markdown 文本，使用 .md 扩展名保存文件，然后您就可以在编辑器的代码和 Markdown 文件的预览之间切换可视化；显然，您也可以打开现有的 Markdown 文件并开始使用它。要在视图之间切换，请在编辑器中按 ⇧⌘V (Windows, Linux Ctrl+Shift+V)。您可以并排查看预览 (⌘K V (Windows, Linux Ctrl+K V)) 和您正在编辑的文件，并在您编辑时实时查看更改反映。

这是一个简单文件的示例。

提示： 您也可以右键单击编辑器选项卡并选择“打开预览”(⇧⌘V (Windows, Linux Ctrl+Shift+V)) 或使用命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 来运行“Markdown：在侧边打开预览”命令 (⌘K V (Windows, Linux Ctrl+K V))。

动态预览和预览锁定

默认情况下，Markdown 预览会自动更新以预览当前活动的 Markdown 文件

您可以使用“Markdown：切换预览锁定”命令锁定 Markdown 预览，以将其锁定到当前的 Markdown 文档。锁定的预览在标题中以 [预览] 表示

注意： 只有当 Markdown 预览是活动选项卡时，“Markdown：切换预览锁定”命令才可用。

编辑器和预览同步

VS Code 会自动同步 Markdown 编辑器和预览窗格。滚动 Markdown 预览，编辑器也会滚动以匹配预览的视口。滚动 Markdown 编辑器，预览也会滚动以匹配其视口

您可以使用 markdown.preview.scrollPreviewWithEditor 和 markdown.preview.scrollEditorWithPreview 设置禁用滚动同步。

编辑器中当前选定的行在 Markdown 预览中以左边距的浅灰色条指示

此外，双击 Markdown 预览中的元素将自动打开该文件的编辑器并滚动到最靠近单击元素的行。

数学公式渲染

VS Code 的内置 Markdown 预览使用 KaTeX 渲染数学方程式。

内联数学方程式用单美元符号括起来

Inline math: $x^2$

您可以使用双美元符号创建数学方程式块

Math block:

$$
\displaystyle
\left( \sum_{k=1}^n a_k b_k \right)^2
\leq
\left( \sum_{k=1}^n a_k^2 \right)
\left( \sum_{k=1}^n b_k^2 \right)
$$

您可以设置 "markdown.math.enabled": false 以禁用 Markdown 文件中数学公式的渲染。

扩展 Markdown 预览

扩展可以为 Markdown 预览贡献自定义样式和脚本，以更改其外观并添加新功能。这是一组自定义预览的示例扩展

使用您自己的 CSS

您还可以使用您自己的 CSS 在 Markdown 预览中使用 "markdown.styles": [] 设置。这将列出要在 Markdown 预览中加载的样式表的 URL。这些样式表可以是 https URL，也可以是当前工作区中本地文件的相对路径。

例如，要加载当前工作区根目录中名为 Style.css 的样式表，请使用文件 > 首选项 > 设置打开工作区 settings.json 文件并进行此更新

// Place your settings in this file to overwrite default and user settings.
{
  "markdown.styles": ["Style.css"]
}

保留尾随空格以创建换行符

要创建硬换行符，Markdown 要求在一行末尾有两个或多个空格。根据您的用户或工作区设置，VS Code 可能会配置为删除尾随空格。为了仅在 Markdown 文件中保留尾随空格，您可以将以下行添加到您的 settings.json

{
  "[markdown]": {
    "files.trimTrailingWhitespace": false
  }
}

Markdown 预览安全性

出于安全原因，VS Code 限制了 Markdown 预览中显示的内容。这包括禁用脚本执行，并且仅允许通过 https 加载资源。

当 Markdown 预览阻止页面上的内容时，预览窗口的右上角会显示一个警报弹出窗口

您可以通过单击此弹出窗口或在任何 Markdown 文件中运行“Markdown：更改预览安全设置”命令来更改 Markdown 预览中允许的内容

Markdown 预览安全设置适用于工作区中的所有文件。

以下是有关每个安全级别的详细信息

严格

这是默认设置。仅加载受信任的内容并禁用脚本执行。阻止 http 图像。

我们建议您保持启用“严格”安全设置，除非您有非常充分的理由更改它，并且您信任工作区中的所有 Markdown 文件。

允许不安全内容

保持脚本禁用，但允许通过 http 加载内容。

禁用

禁用预览窗口中的其他安全性。这允许脚本执行，并且还允许通过 http 加载内容。

文档编写器配置文件模板

配置文件让您可以根据当前项目或任务快速切换您的扩展、设置和 UI 布局。为了帮助您开始编辑 Markdown，您可以使用文档编写器配置文件模板，这是一个精选的配置文件，其中包含有用的扩展和设置。您可以按原样使用配置文件模板，也可以将其用作起点，进一步自定义以适应您自己的工作流程。

您可以通过“配置文件”>“创建配置文件...”下拉列表选择配置文件模板

选择配置文件模板后，您可以查看设置和扩展，并删除您不想包含在新配置文件中的各个项目。在基于模板创建新配置文件后，对设置、扩展或 UI 所做的更改将保留在您的配置文件中。

Markdown 扩展

除了 VS Code 开箱即用的功能外，您还可以安装扩展以获得更多功能。

提示：选择扩展磁贴以阅读说明和评论，以决定哪个扩展最适合您。在Marketplace中查看更多信息。

后续步骤

请继续阅读以了解有关以下内容的信息

• CSS、SCSS 和 Less - 想要编辑您的 CSS？VS Code 对 CSS、SCSS 和 Less 编辑提供出色的支持。

常见问题

是否有拼写检查？

VS Code 未安装，但有拼写检查扩展。查看 VS Code Marketplace 以查找有助于您的工作流程的有用扩展。

VS Code 是否支持 GitHub Flavored Markdown？

否，VS Code 使用 markdown-it 库以 CommonMark Markdown 规范为目标。GitHub 正在朝着 CommonMark 规范发展，您可以在此更新中阅读相关内容。