Markdown 扩展

Markdown 扩展允许您扩展和增强 Visual Studio Code 的内置 Markdown 预览功能。这包括更改预览的外观或添加对新 Markdown 语法的支持。

使用CSS改变Markdown预览的外观

扩展可以贡献CSS来改变Markdown预览的外观或布局。样式表是通过在扩展的package.json中使用markdown.previewStyles 贡献点来注册的：

"contributes": {
    "markdown.previewStyles": [
        "./style.css"
    ]
}

"markdown.previewStyles" 是相对于扩展根文件夹的文件列表。

贡献的样式在内置的Markdown预览样式之后添加，但在用户的"markdown.styles"之前。

Markdown Preview GitHub Styling 扩展是一个很好的例子，展示了如何使用样式表使Markdown预览看起来像GitHub渲染的Markdown。您可以在GitHub上查看该扩展的源代码。

使用 markdown-it 插件添加对新语法的支持

VS Code 的 Markdown 预览支持 CommonMark 规范。扩展可以通过贡献一个 markdown-it 插件来添加对额外 Markdown 语法的支持。

要贡献一个markdown-it插件，首先在你的扩展的package.json中添加一个"markdown.markdownItPlugins"贡献：

"contributes": {
    "markdown.markdownItPlugins": true
}

然后，在扩展的主activation函数中，返回一个包含名为extendMarkdownIt函数的对象。该函数接收当前的markdown-it实例，并且必须返回一个新的markdown-it实例：

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  return {
    extendMarkdownIt(md: any) {
      return md.use(require('markdown-it-emoji'));
    }
  };
}

要贡献多个markdown-it插件，返回多个链接在一起的use语句：

return md.use(require('markdown-it-emoji')).use(require('markdown-it-hashtag'));

当首次显示Markdown预览时，贡献markdown-it插件的扩展会被延迟激活。

markdown-emoji 扩展展示了如何使用 markdown-it 插件为 markdown 预览添加表情符号支持。您可以在 GitHub 上查看 Emoji 扩展的源代码。

您可能还想查看：

Guidelines 适用于 markdown-it 插件开发者的指南
现有的 markdown-it 插件

使用脚本添加高级功能

对于高级功能，扩展可以贡献在Markdown预览中执行的脚本。

"contributes": {
    "markdown.previewScripts": [
        "./main.js"
    ]
}

贡献的脚本是异步加载的，并且在每次内容更改时重新加载。

Markdown Preview Mermaid Support 扩展展示了如何使用脚本来为 markdown 预览添加 Mermaid 图表和流程图支持。您可以在 GitHub 上查看 Mermaid 扩展的源代码。

12/11/2024