让本地 Agent 也能预览 Markdown:这个工具很实用

本地 Markdown 预览,内行人都在用这个

写代码的人天天和 Markdown 打交道。README、文档、博客草稿——全靠这玩意儿。但 Markdown 写完只能看原文,那个渲染效果……说实话,眼睛挺受罪的。

以前要预览,得开 VS Code 装插件,或者丢到 GitHub Pages 上等构建。这些操作对 AI 编程 Agent 来说更是噩梦——它们跑在纯文本环境里,根本没有图形界面。

render-markdown 就是来解决这个问题的。

它能做什么

这个开源工具把 Markdown 文件直接渲染成精美的 HTML 预览,支持两种模式:

  • 一次性预览:渲染成单个 HTML 文件,保存到 /tmp/preview.html,直接浏览器打开。完全自包含,不依赖任何网络。
  • 实时编辑:启动一个本地服务器,带 CodeMirror 编辑器(阅读模式 / 原始模式,Cmd-E 切换)。边写边保存,预览自动热更新。

支持的格式很全:GFM 任务列表、脚注、表格、Mermaid 流程图、语法高亮代码块。亮色 / 暖色暗色主题,sun/system/moon 切换,主题偏好存 localStorage。

技术细节

底层管线是这样的:

input.md ──▶ marked + hljs + mermaid ──┬──▶ /tmp/preview.html(一次性)
                                         └──▶ localhost:7780(实时,CodeMirror 编辑器)

marked 做 Markdown 解析,highlight.js 做代码高亮,Mermaid 渲染图表。一次性模式输出的是完全自包含的单文件 HTML,传给任何人都能正常显示。

怎么安装用

一行命令搞定:

npx skills add smithery-ai/render-markdown

装完在 Agent 里直接打 /render-markdown 就能唤起。AI 编程工具里那些纯文本 Agent 现在也能”看见” Markdown 文档长什么样了——这对检查 README 文档、审查代码注释、验证生成的文档格式特别有用。

什么场景用得上

  • 本地写 README.md,想看最终效果,不用开任何 GUI
  • AI Agent 需要检查项目文档格式是否正确
  • 把 Markdown 文档分享给非技术同事,发一个 HTML 文件即可
  • CI 流水线里自动生成文档预览,用于 Code Review

小结

这个小工具解决的是一个很具体的问题:让纯文本环境里的 Agent 和开发者也能预览 Markdown。管线清晰,依赖少,输出自包含。对于天天和文档打交道的工程师来说,值得备着。

GitHubsmithery-ai/render-markdown


GitHub: https://github.com/smithery-ai/render-markdown

评论区

0 条评论

登录后可评论。

江望 15 阅读