## 開發者工作流程
如何在 Mac 上本機預覽 GitHub README.md 檔案
發布於 2026 年 3 月
你修改了 README。現在想在推送之前看看效果。以下是三種方法，從重量級到即時預覽。
## 為什麼要本機預覽
為什麼要在本機預覽？
- 推送前檢查格式。 損壞的表格、失效的連結和錯亂的程式碼區塊在公開儲存庫中很尷尬。在
git push之前發現它們。 - 離線工作。 飛機上、火車上、Wi-Fi 訊號差的咖啡廳。檢視 README 不應該需要網路連線。
- 審查 PR 中的文件變更。 當 Pull Request 更新了 README 時，你希望在程式碼 diff 旁邊看到轉換後的效果。
- 避免提交-推送-檢查的循環。 僅僅為了看 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。