它不是又一个“能打开 Markdown 的页面”。它更像一间安静的工作室:左手边放着所有文档,右手边摆着接口调试台,中间是一张干净的阅读桌。你不需要在编辑器、浏览器、接口工具和文件夹之间来回切换,只需要打开一篇文档,然后顺着它继续工作。
从“看文档”到“使用文档”
很多 Markdown 预览工具都能把 # 标题、表格和代码块渲染得很好看。
但在真实工作里,我们看文档往往不是为了“欣赏排版”,而是为了继续完成下一件事:
- 找到某个接口在哪里;
- 理解参数是什么意思;
- 复制一个文档链接发给同事;
- 打开相邻章节核对上下文;
- 按文档里的请求体试一次接口;
- 在一堆本地
.md文件里找一句话; - 看完预览后,还想回到原文确认格式。
这个 Markdown 预览功能解决的正是这些“阅读之后马上要做”的动作。
它把文档从静态文本变成了一个可操作的工作台。
打开之后,首先看到的是秩序
进入页面后,左侧是一棵 Markdown 文件树。
它会从当前工作目录里扫描 .md 文件,把散落在不同文件夹里的文档整理成层级结构。文件夹可以展开、收起,当前正在阅读的文档会被高亮;如果文件很多,也可以直接搜索文件名。
这种设计的重点不是炫技,而是减少迷路。
你不需要先在系统文件夹里找到文档,再拖进工具;也不需要在多个浏览器标签里凭记忆判断哪篇是当前内容。文档的位置、层级、上下文关系,都在左侧保持可见。
当你读到一半忘记这篇文档在哪个目录里,还可以一键定位当前文件。它会把文件树展开到对应位置,并把当前文件重新带回视野。
这是一种很小的体验,但在大量文档中工作时,它会显得非常重要。
中间是一张干净的阅读桌
页面中央是 Markdown 正文区域。
标题、段落、表格、列表、任务列表、引用、代码块都会被渲染成适合阅读的样式。代码块使用高亮展示,表格保持结构化,标题会生成稳定锚点,方便跳转和定位。
如果某些行使用了 /change 标记,页面还会把这些变化行突出显示。对于接口文档、变更说明、迭代记录这类内容来说,这能让读者迅速看到“哪里发生了变化”。
预览不是唯一模式。
工具栏里还有“原文本”切换。点击后,页面会直接读取 Markdown 原文,让你看到文档真实的写法。预览与原文之间可以来回切换:适合阅读时看预览,适合核对格式时看原文。
这种切换让文档同时保留两种身份:
- 给人读的时候,它是排版后的文章;
- 给维护者看的时候,它仍然是干净的 Markdown 源文件。
左侧目录,让长文不再像隧道
一篇长 Markdown 文档最容易出现的问题,是读着读着不知道自己在哪。
所以页面右侧提供了文章目录。
它会从标题中自动生成层级导航。你可以点击目录跳到某一节,也可以在滚动时看到当前阅读位置的高亮变化。多级标题可以折叠,目录状态会被记住,下一次打开时仍然保持你熟悉的样子。
它像一本书的页边目录,也像代码编辑器里的 outline。
这对接口文档尤其有帮助。一个接口集合文档里可能有几十个接口,每个接口又包含请求参数、请求体、响应示例。没有目录时,你只能靠滚动条猜位置;有了目录后,文档重新变得可导航。
多标签页:读文档也需要上下文
真实阅读很少是线性的。
你可能从总览文档跳到接口文档,又从接口文档跳到配置说明,再回到总览文档核对一句话。传统预览页面通常只展示一篇文档,来回切换时上下文很容易丢失。
这里的预览页内置了多标签页。
打开过的文档会形成标签。你可以切换、关闭,也可以保留几篇常看的文档作为工作上下文。它更接近编辑器体验,而不是普通网页体验。
这种设计让“本地知识库”更像一个可以长时间停留的工作空间。
搜索不是附加功能,而是入口
文档系统是否好用,搜索通常比排版更关键。
这里提供了几层搜索能力:
- 左侧文件树搜索,用来快速找文件;
- 当前文档搜索,用来在正在阅读的内容中找关键词;
- 全局文档搜索,用来跨 Markdown 文件查找内容。
全局搜索会遍历当前工作目录下的 Markdown 文件,读取内容并展示匹配结果。它适合回答那些很实际的问题:
“这个字段在哪篇文档里提到过?”
“这个接口是不是还有旧版本说明?”
“某个配置项到底写在哪?”
搜索结果不是孤立的文本片段,而是可以继续进入文档的线索。你从搜索开始,再回到阅读,再继续调试接口,整个过程都在同一个页面完成。
最特别的部分:文档可以“唤起”接口调试(beta)
这套 Markdown 预览功能最有价值的地方,不是它把 Markdown 渲染成 HTML,而是它理解了一类常见文档:接口文档。
如果文档里按约定写了这些信息:
- **接口名称**: 获取用户详情
- **接口路径**: /api/users/{id}
- **请求方式**: GET
并在下面提供:
#### 请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| id | 是 | string | 用户 ID |
| includeProfile | 否 | boolean | 是否返回用户资料 |
页面就能识别出这是一个接口。
它会提取接口名称、请求路径、请求方法、路径参数、查询参数和请求体示例,然后把这些信息送到右侧接口调试面板。
这意味着文档不再只是“描述接口”,它可以直接成为“使用接口”的入口。
你读到某个接口,右侧就可以出现这个接口的请求配置。你填上 Base URL,补全参数,点击发送,就能看到真实响应。
这个体验减少了一个很常见的断裂:
看文档 → 复制路径 → 打开接口工具 → 新建请求 → 粘贴 URL → 复制参数 → 手动拼接 → 发送请求
现在它变成:
看文档 → 填参数 → 发送请求
文档和调试之间的距离被明显缩短。
接口调试面板:不是复杂,而是顺手
右侧调试面板并不试图取代专业接口工具。
它更像是文档旁边的一支笔:当你读到接口时,可以顺手试一下。
它支持:
- 设置 API Base URL;
- 自动带入请求方法;
- 自动识别路径中的
{id}这类参数; - 编辑 Query 参数;
- 编辑请求体 JSON;
- 发送请求;
- 格式化 JSON 响应;
- 查看原始响应文本;
- 保留请求配置状态。
对于接口文档维护者来说,这个能力还有另一层意义:文档写得越规范,调试面板就越好用。
也就是说,它会反过来鼓励团队把接口文档写成结构化、可识别、可验证的形式。
工作目录可以被切换
文档并不一定永远放在同一个项目里。
页面提供了工作目录配置能力。你可以输入一个 Markdown 工作目录,也可以在支持图形界面的环境中调用系统目录选择器。目录保存后,后续打开页面会继续使用这个位置。
如果配置目录不存在,系统会回退到桌面目录,避免页面直接不可用。
这让它更适合作为一个本地工具,而不只是某个固定项目里的静态页面。
性能上的克制感
好用的本地工具,不能每次点击都让人等。
这个功能在加载上做了拆分:
- 侧边栏数据可以单独加载;
- 文档内容可以单独加载;
- 文件树扫描结果会短时间缓存;
- 文档渲染结果会根据文件修改时间和大小缓存;
- 快速切换文件时,会避免旧请求覆盖新内容。
这种实现不会在界面上显得“宏大”,但会在使用中减少卡顿和闪烁。
尤其是在文档数量较多、接口文档较长时,缓存和局部刷新会让页面更像一个应用,而不是一张每次都重新打开的网页。
它适合谁
这套 Markdown 预览工作台适合几类人:
1. 写接口文档的人
你可以边写边看,边看边试。
当文档格式符合约定时,接口调试面板会自动识别内容。文档是否写清楚,不再只靠人工阅读判断,也可以通过“能不能顺利填入请求”来验证。
2. 读项目文档的人
你可以把一个项目的所有 Markdown 文档放在工作目录里,通过文件树、目录、多标签页和搜索快速建立上下文。
这比在系统文件夹和普通预览器之间切换更自然。
3. 做联调的人
你不必离开文档就能试接口。
当接口路径、参数和请求体都写在文档里时,右侧调试面板能把这些文字变成可发送的请求。
4. 维护本地知识库的人
它可以作为一个轻量的本地知识库入口。文档仍然是普通 Markdown 文件,不被锁进某个数据库或私有格式里;工具只是帮你更好地浏览、搜索和使用它们。
一个更理想的文档体验
传统文档工具常常把重点放在“展示”。
但对研发文档来说,展示只是第一步。真正重要的是:读者能不能快速找到信息,能不能理解上下文,能不能根据文档继续完成操作。
这套 Markdown 预览功能的设计思路,可以概括成一句话:
让文档停留在 Markdown 的简单形态里,但拥有接近工作台的使用体验。
文件还是文件。
内容还是 Markdown。
但当它们进入这个页面后,会获得目录、搜索、标签页、接口识别、请求调试和工作目录管理这些能力。
这是一种很实用的增强:不改变文档的存储方式,却改变了文档被使用的方式。
效果截图
如果要把这篇文章发布成图文版,建议补充以下截图:
整体界面截图:展示左侧文件树、中间预览、右侧目录和接口调试面板。**
接口文档识别截图:展示 Markdown 中的接口说明和右侧自动填充的请求面板。**
搜索截图:展示当前文档搜索或全局搜索结果。**
多标签页截图:展示同时打开多篇 Markdown 文档的状态。**
工作目录配置截图:展示切换 Markdown 工作目录的入口和状态提示。**
结语
以上文章由AI生成 欢迎大佬们 关注 github 项目持续更新