Markdown Navigator
开发者通过文档导航,在复杂代码仓库中找到方向。
简介
Markdown Navigator 是一款 Visual Studio Code 扩展,用于把项目中的 Markdown 文档固定到 VSCode 侧边栏,并将文档中的文件链接转化为稳定的代码导航入口。
你可以用它维护业务说明、排查手册、开发手册等文档。阅读文档时,点击本地代码链接即可在编辑器区域打开目标文件,并跳转到指定行或列。
快速开始
在资源管理器中右键点击 Markdown 文件,选择 Add to the Markdown Navigator,插件会将当前 Markdown 文件追加到工作区配置中。

支持的链接格式
推荐使用标准 Markdown 相对链接:
单行跳转:../src/main.cpp#L120
行范围:../src/main.cpp#L120-L135
指定列:../src/main.cpp#L120C8
历史链接:vscode://file/C:/repo/src/main.cpp:120
默认情况下,插件会阻止打开绑定工作区之外的目标文件。
配置项
| 配置项 |
默认值 |
说明 |
markdownNavigator.documents |
[] |
要渲染的 Markdown 导航文档列表 |
markdownNavigator.openLocation |
active |
打开代码链接时使用的编辑器组,可选 first、active、beside |
markdownNavigator.revealType |
center |
跳转后的滚动方式,可选 default、center、centerIfOutsideViewport、top |
markdownNavigator.highlightTarget |
true |
打开链接后是否选中目标行或行范围 |
markdownNavigator.autoRefresh |
true |
配置的 Markdown 文件变化时是否自动刷新侧边栏 |
markdownNavigator.showOutline |
true |
是否显示标题目录 |
markdownNavigator.allowHtml |
false |
是否允许经过清理的 Markdown 内嵌 HTML |
markdownNavigator.markdownLinksInView |
true |
Markdown 链接是否优先在侧边栏内打开 |
markdownNavigator.validateOnOpen |
false |
打开导航文档时是否自动校验本地链接 |
| |