1. 为什么我还在 VS Code 里折腾 .md 预览

如果你平时写技术文档、README、博客草稿,或者维护项目里的 CHANGELOG,大概率会遇到一个尴尬:VS Code 自带的 Markdown 预览够用,但不够“顺手”。自带预览是只读的,想改内容得切回源码窗口;表格、任务列表、代码块高亮在预览里虽然能看,但排版和真实渲染总有偏差。更麻烦的是,当你需要边写边看最终效果时,左右分屏滚动同步经常对不齐,写着写着就烦了。

我试过不少 Markdown 插件,有的偏重导出 PDF,有的偏重语法检查,真正把“编辑 + 预览”做成一体化体验的并不多。MD Human Review 这个插件吸引我的点在于:它把 .md 文件的编辑和预览做成了更接近“所见即所得”的交互,右键就能触发,配置也不复杂。它适合谁?适合每天要写大量 Markdown、又不想在多个窗口之间反复横跳的人;适合需要快速校验表格、列表、代码块渲染效果的人;也适合刚接触 VS Code、想找一个轻量 Markdown 增强工具的新手。

这篇内容我会按实际动手的顺序来:先讲清楚这个插件解决什么问题,再给出 settings.json 里可复制的配置骨架,然后演示打开 .md 文件后怎么触发预览、怎么验证渲染效果,最后把常见的报错和坑列出来。你跟着做,基本能在十分钟内跑通。

2. 前置准备:TaoToken 与 VS Code 环境

在开始配置插件之前,先把两个前置条件确认一下。第一是 VS Code 本身,建议版本在 1.80 以上,插件市场能正常访问。第二是如果你后续想让 AI 辅助生成或审查 Markdown 内容,可以先把 TaoToken 的 API Key 准备好。TaoToken 是一个大模型 API 聚合平台,兼容 OpenAI 风格的接口,适合用来做文档摘要、内容润色、代码块解释这类任务。它的官网是 https://taotoken.net/?utm_source=taotoken_aicg_blog_end&utm_medium=csdn&utm_campaign=rewrite&utm_content= ,API 地址是 https://taotoken.net/api 。

为什么写 Markdown 插件要提 TaoToken?因为很多人的实际工作流是:用 MD Human Review 编辑和预览 .md 文件,同时用 AI 帮忙检查文档结构、生成目录、翻译段落。如果你打算把这两件事串起来,提前把 Key 建好会省事。你可以直接访问 API Keys 页面创建密钥:https://taotoken.net/api-keys?utm_source=taotoken_aicg_blog_end&utm_content=api_keys&utm_campaign=rewrite 。创建后复制保存,后面配置环境变量或插件参数时会用到。

如果你只是想先跑通 MD Human Review 的编辑预览,不接 AI 也完全没问题,这一章可以快速跳过。但如果你想让 .md 文件的编辑体验更完整,建议把 Key 准备好。另外,TaoToken 的模型对话入口在 https://taotoken.net/models?utm_source=taotoken_aicg_blog_end&utm_content=models&utm_campaign=rewrite ,接入文档在 https://taotoken.net/doc?utm_source=taotoken_aicg_blog_end&utm_content=doc&utm_campaign=rewrite ,需要查参数的时候可以直接看。

3. 安装 MD Human Review 插件

安装本身不复杂,但有几个细节容易忽略。打开 VS Code,左侧活动栏点击扩展图标,或者用快捷键 Ctrl+Shift+X(macOS 是 Cmd+Shift+X)。在搜索框里输入 MD Human Review,注意大小写不敏感,但建议完整输入,避免搜到一堆名字相似的插件。

搜索结果里找到对应插件后,点击 Install。安装完成后,VS Code 可能会提示你 Reload Required,点一下重启窗口。重启后,插件才算真正生效。这里有个小坑:有些插件安装后不会自动激活,需要你打开一个 .md 文件才会触发激活。所以如果你装完发现右键菜单里没有相关选项,先别急着卸载,打开一个 Markdown 文件试试。

安装完成后,你可以在扩展面板的已安装列表里看到它。如果状态显示 Enabled,说明没问题。如果显示 Disabled,检查一下是不是被工作区禁用了。另外,如果你用的是 Remote-SSH 或 Dev Container 环境,插件需要安装在远程端,而不是本地端。这个区别很关键,很多人本地装了但远程连不上,就是因为装错了位置。

4. settings.json 可复制配置骨架

插件装好后,建议把配置写进 settings.json,而不是只靠默认值。这样换机器、同步配置、团队共享都方便。打开 VS Code 的设置,可以用 Ctrl+, 打开图形界面,然后点右上角的“打开设置(JSON)”图标;也可以直接 Ctrl+Shift+P,输入 Preferences: Open User Settings (JSON)。

下面是一份可复制的配置骨架,你可以直接粘进去。注意,如果你的 settings.json 里已经有其他配置,把这段合并进去,不要整个覆盖。

{
  "mdHumanReview.enable": true,
  "mdHumanReview.previewMode": "sideBySide",
  "mdHumanReview.autoRefresh": true,
  "mdHumanReview.refreshDelay": 300,
  "mdHumanReview.syncScroll": true,
  "mdHumanReview.codeBlockHighlight": true,
  "mdHumanReview.tableRender": true,
  "mdHumanReview.taskListRender": true,
  "mdHumanReview.fontSize": 14,
  "mdHumanReview.lineHeight": 1.6,
  "mdHumanReview.theme": "auto",
  "mdHumanReview.showOutline": true,
  "mdHumanReview.outlinePosition": "right",
  "mdHumanReview.exportOnSave": false,
  "mdHumanReview.ignorePatterns": [
    "**/node_modules/**",
    "**/.git/**",
    "**/dist/**"
  ]
}

逐项说明一下关键参数。previewMode 控制预览布局,可选 sideBySide、tab、current。sideBySide 是左右分屏,适合宽屏;tab 是新标签页打开预览;current 是当前窗口替换。autoRefresh 和 refreshDelay 配合使用,控制编辑后多久刷新预览,300 毫秒是比较跟手的值,太低会频繁重绘,太高会有延迟感。syncScroll 是滚动同步,写长文档时很有用。codeBlockHighlight 和 tableRender 分别控制代码块高亮和表格渲染,建议都开着。

theme 设为 auto 会跟随 VS Code 主题,如果你想要固定浅色或深色,可以改成 light 或 dark。showOutline 和 outlinePosition 控制大纲显示,写长文档时能快速跳转章节。ignorePatterns 用来排除不需要预览的目录,避免在大仓库里卡顿。

如果你要把配置放到工作区级别,可以在项目根目录建 .vscode/settings.json,内容一样,但只对当前项目生效。团队协作时,把这份配置提交到仓库,大家体验一致。

5. 打开 .md 文件并触发预览

配置写好后,新建或打开一个 .md 文件。你可以直接新建一个 test.md,输入一些内容来测试。比如:

# 测试文档

这是一个用于验证 MD Human Review 的示例。

## 表格测试

| 参数 | 说明 | 默认值 |
| --- | --- | --- |
| previewMode | 预览布局 | sideBySide |
| autoRefresh | 自动刷新 | true |

## 代码块测试

```python
def hello():
    print("hello md human review")

任务列表

  • [x] 安装插件
  • [ ] 配置 settings.json
  • [ ] 验证预览效果

写完后,触发预览的方式有几种。第一种是右键菜单:在 .md 文件编辑区域右键,找到 MD Human Review 相关的选项,点击预览。第二种是命令面板:Ctrl+Shift+P,输入 `MD Human Review: Open Preview`,回车。第三种是快捷键,如果你在配置里绑定了快捷键,可以直接按。默认情况下,插件可能没有绑定快捷键,你可以自己在 keybindings.json 里加一条。

触发后,你应该能看到预览窗口。如果是 `sideBySide` 模式,编辑区和预览区左右排列。试着修改表格里的某个单元格,比如把 `sideBySide` 改成 `tab`,观察预览区是否在 300 毫秒左右更新。再滚动编辑区,看预览区是否同步滚动。如果都正常,说明配置生效了。

## 6. 验证渲染效果与常见错排查

验证渲染效果,重点看几个容易出问题的地方。第一是表格:检查表头、对齐、单元格内容是否正常显示,特别是包含中文和英文混排时,列宽是否合理。第二是代码块:检查语言标注是否触发高亮,比如 `python`、`json`、`bash` 这些常见语言。如果代码块没有高亮,检查 `codeBlockHighlight` 是否设为 true,以及语言标识是否写对。第三是任务列表:检查 `- [x]` 和 `- [ ]` 是否渲染成复选框,而不是纯文本。

如果你遇到预览空白,先检查文件是否已保存。有些插件对未保存的临时文件支持不好,Ctrl+S 保存后再看。如果还是空白,打开命令面板,运行 `Developer: Toggle Developer Tools`,看 Console 里有没有报错。常见报错之一是插件激活失败,通常是因为 VS Code 版本过低,升级到 1.80 以上即可。

另一个常见问题是滚动不同步。检查 `syncScroll` 是否为 true,以及预览模式是否为 `sideBySide`。在 `tab` 模式下,滚动同步可能不生效,这是正常的。如果刷新延迟太高,把 `refreshDelay` 从 300 降到 150 试试,但不要低于 100,否则可能卡顿。

还有用户反馈右键菜单里找不到插件选项。这种情况多半是插件没有激活。打开一个 .md 文件后,等几秒,再看右键菜单。如果仍然没有,检查扩展面板里插件是否被禁用,或者是否安装在了错误的远程环境。Remote-SSH 场景下,插件要装在远程端,本地端装了没用。

如果你在配置里加了 `ignorePatterns`,但发现某些文件还是不预览,检查 glob 写法是否正确。`**/node_modules/**` 这种写法是排除 node_modules 下所有文件,如果你写成了 `node_modules`,可能不生效。

## 7. 把 AI 审查接进 Markdown 工作流

MD Human Review 解决了编辑和预览的问题,但如果你想让 .md 文件的内容质量更高,可以再接一步 AI 审查。比如写完一篇技术文档后,用 TaoToken 的模型对话能力检查语法、优化表达、生成摘要。模型对话入口在 https://taotoken.net/models?utm_source=taotoken_aicg_blog_end&utm_content=models&utm_campaign=rewrite ,你可以直接在网页上试。

如果你更习惯在命令行或脚本里调用,可以用 API。API 地址是 https://taotoken.net/api ,兼容 OpenAI 风格。下面是一个用 curl 调用聊天补全的示例,把 `YOUR_API_KEY` 换成你在 API Keys 页面创建的密钥:

```bash
curl https://taotoken.net/api/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      {"role": "system", "content": "你是一个技术文档审查助手,检查 Markdown 文档的结构和表达。"},
      {"role": "user", "content": "请检查以下 Markdown 文档的标题层级是否合理,并指出表格和代码块的问题。"}
    ],
    "temperature": 0.3
  }'

返回结果里会包含模型对文档的审查意见。你可以把这个流程写成一个脚本,在保存 .md 文件后自动触发。不过要注意,不要把生产环境的敏感文档直接发给模型,先脱敏或只发结构部分。

如果你长期做编码和 Agent 相关的工作,可以考虑 TaoToken 的 Coding Plan:https://taotoken.net/coding-plan?utm_source=taotoken_aicg_blog_end&utm_content=coding_plan&utm_campaign=rewrite 。它更适合需要频繁调用模型、做代码审查和文档生成的场景。接入文档在 https://taotoken.net/doc?utm_source=taotoken_aicg_blog_end&utm_content=doc&utm_campaign=rewrite ,里面有详细的参数说明和示例。

回到 MD Human Review 本身,它的定位是编辑和预览工具,不是 AI 工具。两者结合的方式是:用插件保证 .md 文件的渲染正确、编辑流畅,用 TaoToken 保证内容质量。这样一套下来,写技术文档的效率会明显提升。最后提醒一句,配置写完后记得保存并重启 VS Code,很多“不生效”的问题重启就能解决。

更多推荐