## 开发者工作流程
如何在 Mac 上本地预览 GitHub README.md 文件
发布于 2026 年 3 月
你编辑了 README。现在想在推送之前看看效果。以下是三种方法，从重量级到即时预览。
## 为什么要本地预览
为什么要本地预览？
- 推送前检查格式。 损坏的表格、失效的链接和混乱的代码块在公开仓库中很尴尬。在
git push之前发现它们。 - 离线工作。 飞机上、火车上、WiFi 信号差的咖啡馆。查看 README 不应该需要网络连接。
- 审查 PR 文档变更。 当拉取请求更新了 README 时，你需要在代码差异旁边查看渲染结果。
- 避免提交-推送-检查的循环。 仅仅为了看看 README 在 GitHub 上的渲染效果就推送提交，会污染你的 git 历史并浪费时间。
## 方法 1
grip（命令行工具）
pip install grip grip README.md
grip 使用 GitHub API 渲染你的 Markdown，因此你可以在浏览器中通过 localhost:6419 获得像素级精确的 GitHub 渲染效果。
优点
- 精确的 GitHub 渲染（使用其 API）
缺点
- 需要安装 Python
- 频繁使用需要 GitHub API 令牌（否则会被限流）
- 运行一个需要手动启动和停止的本地服务器
- 不适合离线使用（调用 GitHub API）
## 方法 2
VS Code 内置预览
在 VS Code 中打开 README.md Cmd + Shift + V → 预览面板
VS Code 有内置的 Markdown 预览。打开文件，按下快捷键，侧面板显示渲染输出。
优点
- 大多数开发者已经安装
- 支持离线使用
缺点
- 为了预览 README 启动一个完整的 IDE 太重了
- 预览渲染与 GitHub 不完全一致（不支持提示框，表格样式不同）
- 依赖编辑器 -- 不能直接双击文件
## 方法 3（推荐）
ShowMeMyMD -- 双击即可
git clone <repo> 双击 README.md 完成。
ShowMeMyMD 是一款原生 macOS Markdown 查看器。将其设为 .md 文件的默认应用，每个 README 都会即时以渲染预览方式打开。无需命令行。无需服务器。无需配置。
完全支持 GitHub 风格 Markdown：
- 带对齐的表格
- 带复选框的任务列表
- 带语法高亮的围栏代码块
- GitHub 风格提示框：
NOTE、TIP、WARNING、IMPORTANT、CAUTION
克隆，双击 README.md，完成。
## 对比
并排对比
| 工具 | 安装 | GFM 准确度 | 速度 | 离线 |
|---|---|---|---|---|
| grip | Python + pip 安装 | 精确（GitHub API） | 慢（网络） | 否 |
| VS Code | 已安装 | 部分支持 | 快 | 是 |
| ShowMeMyMD | 从 Mac App Store 安装一次 | 完整 GFM + 提示框 | 即时 | 是 |
## 继续阅读
了解更多关于 ShowMeMyMD 作为 Mac 上的 Markdown 查看器。看看它如何融入 开发者工作流程。或阅读我们关于 GitHub 风格提示框的指南。
不要再推送只为检查 README
双击任何 .md 文件即可即时查看渲染效果。GitHub 风格 Markdown、语法高亮、四种主题。Mac App Store 售价 $2.99。