VS Code Markdown 插件推荐
Markdown 已经成为程序员最常用的文档格式之一。
无论是:
- 写技术博客
- 编写 README
- 记录项目文档
- 输出接口说明
- 做知识库整理
Markdown 都已经成为事实标准。
而在众多编辑器中,Visual Studio Code + Markdown 插件,几乎是目前体验最好的组合之一。
本文介绍几个我日常使用频率最高的 VS Code Markdown 插件,以及它们的实际使用方法。
一、为什么用 VS Code 写 Markdown
相比 Typora、Obsidian 等专用 Markdown 工具,VS Code 的优势在于:
1. 开发与文档一体化
代码和文档放在同一个工程里:
project/
├── src/
├── docs/
├── README.md
修改代码时同步维护文档非常方便。
2. Git 集成优秀
Markdown 文件天然适合 Git:
- diff 清晰
- 支持版本回滚
- 方便多人协作
尤其写技术方案时,非常适合团队协同。
3. 插件生态强大
VS Code 最大优势其实是插件生态。
Markdown 相关插件已经非常成熟:
- 实时预览
- Mermaid 流程图
- LaTeX 数学公式
- 导出 PDF
- TOC 自动生成
- 图片管理
- Markdown lint
基本都能覆盖。
二、VS Code 自带 Markdown 功能
其实即使不安装插件,VS Code 也已经支持:
1. Markdown 预览
快捷键:
Ctrl + Shift + V
或者:
右键 -> Open Preview
效果:
- 左边编辑
- 右边实时渲染
非常适合阅读。
2. 分栏预览
快捷键:
Ctrl + K V
会自动打开侧边预览。
这是我最常用的模式。
三、最推荐的 Markdown 插件
1. Markdown Preview Enhanced
这是我最推荐的插件。
功能极其强大。
安装
插件市场搜索:
Markdown Preview Enhanced
作者:
Yiyi Wang
核心功能
(1)增强渲染
支持:
- Mermaid
- PlantUML
- 数学公式
- 流程图
- 时序图
- 表格增强
例如:
```mermaid
graph TD
A --> B
```
直接渲染成流程图。
(2)导出 PDF / HTML
支持:
- HTML
- PNG
- JPEG
写博客或技术方案非常方便。
(3)支持 TOC
自动生成目录:
@[toc]
对于长文档非常实用。
(4)支持代码执行
甚至可以执行:
- Python
- Shell
- JavaScript
适合做技术文档演示。
2. Markdown All in One
这是另一个必装插件。
功能
自动目录
快捷键:
Ctrl + Shift + P
-> Create Table of Contents
快捷键增强
例如:
Ctrl + B
自动插入:
****
列表自动补全
输入:
1.
会自动续编号。
体验很好。
3. markdownlint
写 Markdown 时间长以后,格式会越来越乱。
这个插件负责:
- 格式规范
- 标题检查
- 空格检查
- 列表规范
类似代码里的 ESLint。
4. Paste Image
技术博客经常需要截图。
这个插件可以:
- 直接粘贴剪贴板图片
- 自动保存到目录
- 自动生成 Markdown 链接
快捷键:
Ctrl + Alt + V
非常高效。
四、远程 Linux 下使用 Markdown
很多人不知道:
VS Code Remote SSH 下,Markdown 插件依然能正常工作。
例如:
Windows
↓
VS Code Remote SSH
↓
Linux Server
即使 Markdown 文件在远程 Linux:
/home/project/docs/test.md
依然可以:
- 实时预览
- 渲染 Mermaid
- 导出文档
一个常见问题
很多人会发现:
插件装了,但远程环境不能用。
原因通常是:
插件只安装在本地。
需要:
Install in SSH: xxx
安装到 Remote 环境。
五、我目前的 Markdown 工作流
我现在基本这样使用:
技术方案
Markdown Preview Enhanced
用于:
- 流程图
- 时序图
- PDF 导出
日常 README
Markdown All in One
用于:
- 自动 TOC
- 快捷编辑
博客写作
Paste Image
markdownlint
用于:
- 图片管理
- 格式规范
六、推荐组合
如果只装一套,我建议:
| 插件 | 用途 |
|---|---|
| Markdown Preview Enhanced | 核心渲染 |
| Markdown All in One | 编辑增强 |
| markdownlint | 格式规范 |
| Paste Image | 图片管理 |
基本已经足够。
七、总结
VS Code 现在已经不仅仅是代码编辑器。
对于技术写作来说,它实际上已经是一个非常强大的 Markdown 工作平台。
尤其结合:
- Git
- Remote SSH
- Mermaid
- PDF 导出
之后,完全可以替代很多专业文档工具。
如果你平时:
- 写博客
- 写技术方案
- 做知识库
- 维护 README
非常值得认真配置一套 Markdown 工作流。
AtomGit 是由开放原子开源基金会联合 CSDN 等生态伙伴共同推出的新一代开源与人工智能协作平台。平台坚持“开放、中立、公益”的理念,把代码托管、模型共享、数据集托管、智能体开发体验和算力服务整合在一起,为开发者提供从开发、训练到部署的一站式体验。
更多推荐



所有评论(0)