UStackUStack
showmd icon

showmd

showmd 是免费的 macOS Quick Look 扩展,支持 Markdown 渲染与渲染/源代码切换,并将 YAML 前置元数据折叠显示,无需云上传。

showmd

showmd 是什么?

showmd 是 macOS 的免费 Quick Look 扩展,能以比 Finder 默认行为更易读的方式预览 Markdown 文件(.md 及相关扩展)。其核心目的是渲染带格式的 Markdown,同时保留对源内容的访问。

在 Finder 中按空格键查看 .md 文件时,showmd 会渲染 Markdown,并提供渲染/源代码切换。它还会将 YAML frontmatter 解析为可折叠的元数据表格,支持依赖 Markdown 结构的常见文档和 AI 提示工作流。

主要功能

  • Finder 中 Markdown 的 Quick Look 预览:在 Markdown 文件上按空格键,即可查看格式化输出,无需打开浏览器或编辑器。
  • 渲染 ↔ 源代码切换:一键在渲染 Markdown 和原始 Markdown 源代码间切换。
  • YAML frontmatter 作为可折叠元数据表格:检测 frontmatter 中的“键值”,默认折叠显示为表格。
  • 通过 Markdown 解析器支持 Markdown 功能:支持 GitHub Flavored Markdown 元素,如表格、任务列表、删除线、自动链接、脚注等。
  • 代码和特殊内容的语法感知渲染:代码块使用语言感知高亮(190+ 语言),内联和块级 LaTeX 数学公式通过 KaTeX 渲染,Mermaid 图表从代码块渲染。
  • AI 导向的标签渲染:AI 提示中常见的类 XML 标签(如 )渲染为带标签的边框块,而非原始尖括号。
  • 无云或后台上传:页面声明“No cloud. No uploads. No telemetry”,表示默认本地预览文件。
  • Quick Look 中的内联图像处理:相对图像路径正确解析,本地截图/图表可在预览中显示。

如何使用 showmd

  1. 下载 macOS 版 showmd 并打开一次。
  2. 系统设置 → 隐私与安全性 → 扩展 → Quick Look 中启用 showmd(页面描述为单次切换)。
  3. 在 Finder 中选择 Markdown 文件并按空格键使用 showmd 预览。
  4. 使用渲染/源代码切换在格式化输出和底层 Markdown 间切换。页面还提到可复制为 HTML 的选项。

使用场景

  • 阅读以 Markdown 存储的文档:预览 README 文件的格式化标题、列表、链接和表格,无需离开 Finder。
  • 检查以 Markdown 编写的 AI 提示/配置文件:查看包含类 XML 标签的 AI 代理指令文件,标签渲染为标签块,便于快速扫描。
  • 审查静态站点内容的 YAML frontmatter:需要时展开 frontmatter 表格检查标题或配置键,平时保持折叠。
  • 检查包含代码、数学或图表的的技术内容:查看语法高亮的代码块、LaTeX 表达式和 Mermaid 流程图的内联渲染,而非原始文本。
  • 验证本地笔记/仓库文档中的相对图像:确认相对路径引用的图像在 Quick Look 预览中正确显示。

常见问题

如何在 Finder 中启用 showmd?
下载 showmd,打开一次,然后转到 系统设置 → 隐私与安全性 → 扩展 → Quick Look 启用扩展。首次启动时,macOS 可能提示允许访问其他应用数据;点击允许

showmd 是否取代打开浏览器的需求?
页面将 showmd 定位为在 macOS Quick Look 中直接预览 Markdown,而非需打开浏览器查看渲染输出。

能否在渲染输出和原始 Markdown 间切换?
可以。showmd 提供渲染与源代码切换,一键完成。

showmd 如何处理 YAML frontmatter?
它将 YAML frontmatter 解析为可折叠表格,默认折叠,可展开查看元数据。

是否有云组件?
页面声明“No cloud. No uploads. No telemetry”,表示默认本地处理预览。

替代方案

  • 在专用 Markdown 查看器/编辑器中打开 Markdown 文件:使用专为 Markdown 渲染和导出设计应用。这些选项通常包含更多编辑工具,而 showmd 专为 Quick Look 预览设计。
  • 使用基于浏览器的 Markdown 渲染器:将内容上传或粘贴到在线查看器以获取渲染输出。与 showmd 相比,这增加了浏览器步骤,且可能无法严格保持文件本地。
  • 依赖 macOS Quick Look 默认预览:Finder 的 Space 预览将显示原始 Markdown 源代码。这最简单,但对表格、图表和数学公式等格式化内容可读性较差。
  • 使用文档/静态站点工具链预览内容:本地开发服务器可渲染 Markdown 并应用完整站点样式,但通常比 Quick Look 预览流程更重型。