Markdown Navigator

开发者通过文档导航，在复杂代码仓库中找到方向。

简介

Markdown Navigator 是一款 Visual Studio Code 扩展，用于把项目中的 Markdown 文档固定到 VSCode 侧边栏，并将文档中的文件链接转化为稳定的代码导航入口。

你可以用它维护业务说明、排查手册、开发手册等文档。阅读文档时，点击本地代码链接即可在编辑器区域打开目标文件，并跳转到指定行或列。

快速开始

在工作区设置中配置一份或多份 Markdown 文档：

{
  "markdownNavigator.documents": [
    {
      "title": "Guide",
      "path": "doc/guide.md"
    }
  ]
}

然后执行命令：

Markdown Navigator: Open Navigation

也可以点击 VS Code Activity Bar 中的 Markdown Navigator 图标打开侧边栏。

支持的链接格式

推荐使用标准 Markdown 相对链接：

单行跳转：../src/main.cpp#L120
行范围：../src/main.cpp#L120-L135
指定列：../src/main.cpp#L120C8
历史链接：vscode://file/C:/repo/src/main.cpp:120

默认情况下，插件会阻止打开绑定工作区之外的目标文件。

配置项

命令

• Markdown Navigator: Open Navigation
• Markdown Navigator: Add Current Markdown File
• Markdown Navigator: Remove Current Markdown File
• Markdown Navigator: Select Document
• Markdown Navigator: Refresh
• Markdown Navigator: Open Settings
• Markdown Navigator: Validate Links