Markdown Buddy › 在 Xcode 中预览 Markdown

在 Xcode 中预览 Markdown

Xcode 把 Markdown 文件当作纯源码显示。面对 README、CHANGELOG 或架构说明时，这意味着你读到的是标记而不是文档。Markdown Buddy 附带一个原生 Source Editor 扩展：从 Editor 菜单出发，你正在查看的文件会以渲染后的样子打开，无需离开项目。

安装扩展

1. 从 Mac App Store 安装 Markdown Buddy 并先运行一次，让 macOS 注册它附带的扩展。
2. 打开系统设置，进入通用，再进入登录项与扩展，在 Xcode Source Editor 下启用 Markdown Buddy。
3. 重新启动 Xcode。扩展只在启动时读取，已经开着的 Xcode 看不到你刚刚启用的那一个。
4. 打开一个 .md 文件，然后选择 Editor 菜单中的 Markdown Buddy。你可以在 Xcode 设置的 Key Bindings 里为它指定快捷键。

为什么这在仓库里很重要

项目文档就放在代码旁边，而把它显示得最糟糕的，恰恰是代码编辑器：

• 带表格和徽章的 README，以纯源码形式根本读不下去
• CHANGELOG 是一份长长的嵌套列表，缩进承载着含义
• 架构说明常常包含 Mermaid 图表，而 Xcode 只会把它显示为一段围起来的文字
• 文档之间的相对链接，在源码视图里无法跳转

不止于扩展

同一个应用可以把整个文件夹作为工作区打开，搜索其中所有 .md 文件，并把文档之间的链接画成图，同时标出失效的链接。对于文档已经长大的仓库，这往往比预览本身更有用。

如果 Editor 菜单里没有这个命令

• 在系统设置的通用、登录项与扩展、Xcode Source Editor 一栏中，确认扩展已启用。
• 完全退出 Xcode 再重新启动。扩展列表只在启动时读取。
• 从应用程序文件夹里运行一次 Markdown Buddy，然后再试。
• 只有当前最前面的文稿是 Markdown 文件时，命令才会出现。在 .swift 文件上它会保持隐藏。