怎样使用VSCode的Markdown预览编写文档【教程】

9次阅读

vscodemarkdown 预览是内置功能,需用 Ctrl+Shift+V(或 Cmd+Shift+V)内联启动;图片路径须相对于当前文件、数学公式需启用 markdown.preview.math 设置并重启预览;自定义 css 路径须为相对路径且依赖工作区配置。

怎样使用VSCode的Markdown预览编写文档【教程】

VSCode 的 Markdown 预览不是“编辑器插件”,而是内置功能,开箱即用——但默认行为和常见协作场景下,它容易让你写到一半发现格式错乱、图片不显示、数学公式不渲染,甚至误以为是自己语法写错了。

如何正确触发实时预览

别右键 → “Open Preview”——这会打开一个只读的独立窗口,改源码后不会自动刷新。正确做法是:

  • 打开 .md 文件后,按 Ctrl+Shift+Vwindows/linux)或 Cmd+Shift+VmacOS),在编辑器右侧内联启动预览
  • 或者点击编辑器右上角的 → 选择 Open Preview to the Side
  • 预览窗格支持滚动同步:编辑器光标移到某段,预览会自动定位;反之亦然(需开启设置:markdown.preview.scrollEditorWithPreview 设为 true

为什么本地图片路径不显示

VSCode 默认预览只解析相对路径,且以当前打开的文件为基准,不是以工作区根目录。比如你文档在 docs/guide.md,想引用 assets/logo.png,不能写 ![](assets/logo.png),而要写:

![](../assets/logo.png)

常见陷阱:

  • ![](./assets/logo.png) —— 错,. 指向的是 docs/ 目录,不是工作区根
  • 使用绝对路径(如 file:///...)会被预览器忽略,安全策略禁止加载
  • 如果图片在 gitHub 仓库里,且你希望预览和 github 渲染一致,建议统一用相对于仓库根的路径,并开启设置:markdown.preview.preferredMdEngine 保持默认(vscode 引擎)即可

怎样让数学公式(LaTeX)正常渲染

VSCode 内置预览默认关闭 LaTeX 支持。必须手动启用:

  • 打开设置(Ctrl+,),搜索 markdown.preview.math
  • 勾选 Markdown > Preview: Math
  • 重启预览(关闭再打开,或按 Ctrl+Shift+V 重载)

之后即可使用:

行内公式:$E = mc^2$   块级公式:   $$ int_0^infty e^{-x^2}dx = frac{sqrt{pi}}{2} $$

注意:$$ 块公式在 VSCode 预览中要求前后空行,否则可能被当作文本渲染。

预览样式难看?自定义 CSS 很简单

VSCode 不提供图形化主题切换,但支持注入自定义 CSS。只需两步:

  • 新建一个 CSS 文件,例如 .vscode/markdown.css,写入你的样式(如调整字体、代码块背景)
  • 在设置中搜索 markdown.preview.styles,添加该路径:["./.vscode/markdown.css"]

路径必须是**相对路径**,且相对于当前打开的 Markdown 文件所在目录。如果想全局生效,建议把 CSS 放在工作区根目录,并用 ["./.vscode/markdown.css"](前提是工作区已打开)。

真正麻烦的不是怎么加样式,而是每次换工作区就得重新配置路径——没人提醒你这点,直到你复制了一份文档到新文件夹,预览又变回默认丑样式。

text=ZqhQzanResources