VSCode添加插件辅助文档编写工作

梦明姑娘_1403

梦明姑娘_1403

2026-08-28

267人浏览

原创

markdown all in one 和 markdown preview enhanced 是 vs code 编写 markdown 的必备插件:前者补全目录生成、格式化等底层能力,后者支持 mermaid、latex、导出 pdf 等高级预览功能,二者共存无冲突但需正确配置路径、命令与参数。

vscode添加插件辅助文档编写工作

Markdown All in One 必装,不是“可选”而是“默认启用”

它不是锦上添花的插件,而是 VS Code 写 Markdown 时缺失的底层能力补丁。没装它,Create Table of Contents、Format Document、Toggle Bold 这些命令根本不存在——原生编辑器只提供基础语法高亮和简单预览。

安装后立刻生效,无需重启:搜索 Markdown All in One(作者 Yu Zhang),点击安装即可。注意别误装同名但非官方的分支版本,认准 GitHub 仓库地址 https://gitcode.com/gh_mirrors/vs/vscode-markdown。

  • 自动补全触发条件很实际:输入 ## 后按 Tab,不是空格;输入 - [ ] 回车,才识别为任务列表
  • 目录生成默认插入位置是光标所在行,不是文件开头——如果光标在末尾,TOC 就会插到最底下,得手动剪切上去
  • Ctrl+Shift+P 输入命令时,名称带空格,必须输全 Markdown All in One: Create Table of Contents,缩写或漏掉冒号会找不到

Preview Enhanced 补足原生预览的硬伤

VS Code 原生预览不支持 Mermaid 流程图、LaTeX 数学公式、双向滚动同步,也不支持导出 PDF 或 HTML。Markdown Preview Enhanced 是唯一能稳定覆盖这些需求的插件,尤其适合写接口文档、系统设计稿这类含图表和公式的场景。

它和 Markdown All in One 共存无冲突,但需手动启用预览:右键 Markdown 文件 → Open Preview to the Side,或用快捷键 Ctrl+K V(Windows/Linux)/Cmd+K V(macOS)。

  • Mermaid 渲染依赖本地 Node.js 环境,若报错 mermaid not found,需全局安装:npm install -g mermaid-cli
  • 数学公式渲染用的是 KaTeX,不是 MathJax,所以 $$...$$ 和 \[...\] 都支持,但 $...$(行内)必须前后紧贴文字,中间不能有空格,否则不触发
  • 导出 PDF 时中文可能乱码,需在设置里加配置:"markdown-preview-enhanced.enableChineseExport": true

toc.levels 控制目录深度,别让三级标题塞进 TOC

默认 toc.levels 是 1..6,意味着所有 # 到 ###### 都进目录——但实际文档中,### 及以下多为细节说明,放进 TOC 反而干扰导航。建议显式设为 "2..4",只保留二级到四级标题。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

这个配置写在 settings.json 里,作用域可以是用户级,也可以是工作区级(推荐后者):项目根目录下 .vscode/settings.json 中加一行:

"markdown.extension.toc.levels": "2..4"
  • 值必须是字符串格式,写成 2..4,不是数组 [2,3,4],也不是数字 4
  • 修改后不用重启,但已有 TOC 不会自动重刷——得手动运行一次 Update Table of Contents
  • 如果某节标题想彻底排除(比如“致谢”“附录”),在标题上方加注释:<!-- omit from toc -->

图片路径别用拖拽,统一走 assets/ 目录

直接拖图片进编辑器,VS Code 默认生成相对路径如 ![](image.png),但一旦文档挪动位置或换人协作,路径就断。真实项目里应强制走 assets/ 子目录,且路径全部小写、无空格、用连字符分隔。

设置方法:在项目根目录建 assets/ 文件夹,然后在 .vscode/settings.json 加:

"markdown.extension.image.previewPath": "./assets"
  • 插入图片时用 Ctrl+Shift+P → Markdown: Insert Image,路径会自动补全为 ./assets/xxx.png
  • 预览时若图片不显示,先确认 assets/ 和图片文件都在 Git 工作区里,而不是被 .gitignore 忽略了
  • 绝对路径(/assets/)在本地预览能用,但导出 HTML/PDF 会失效,必须用相对路径 ./assets/

真正卡住人的从来不是“有没有插件”,而是插件装了但没配对参数、路径设错、或者混淆了两个插件各自的命令入口。比如 Update Table of Contents 是 Markdown All in One 的命令,Export to PDF 是 Preview Enhanced 的功能——混用就会找不到。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1175

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2332

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1809

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1627

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2507

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1778

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1222

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1076

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

414

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程