## 開発者ワークフロー

GitHub README.mdを Macでローカルプレビューする方法

2026年3月公開

READMEを編集しました。プッシュする前にどう見えるか確認したい。 ヘビーウェイトから即座にできる方法まで、3つの方法をご紹介します。


## なぜローカルプレビューするのか

なぜローカルプレビューするのか?

  • プッシュ前にフォーマットを確認。 壊れたテーブル、リンク切れ、崩れたコードブロックは公開リポジトリ では恥ずかしい。 git push の前にキャッチしましょう。
  • オフラインで作業。 飛行機、電車、Wi-Fiの悪いカフェ。READMEの確認にインターネット 接続は不要であるべきです。
  • PRドキュメントの変更をレビュー。 プルリクエストがREADMEを更新する場合、コードdiffと一緒にレンダリング 結果を確認したいものです。
  • コミット-プッシュ-確認サイクルの回避。 READMEのレンダリングを確認するためだけにコミットをプッシュすると、 gitの履歴が汚れ、時間の無駄です。

## 方法 1

grip(CLIツール)

pip install grip
grip README.md

gripはGitHub APIを使ってMarkdownをレンダリングするため、ブラウザの localhost:6419 でピクセルパーフェクトなGitHubレンダリングが得られます。

メリット

  • 正確なGitHubレンダリング(APIを使用)

デメリット

  • Pythonのインストールが必要
  • 大量使用時はGitHub APIトークンが必要(それ以外はレート制限あり)
  • 起動・停止が必要なローカルサーバーを実行
  • オフラインでは使用不可(GitHub APIを呼び出すため)

## 方法 2

VS Code 内蔵プレビュー

Open README.md in VS Code
Cmd + Shift + V → preview pane

VS Codeには内蔵のMarkdownプレビューがあります。ファイルを開き、 キーボードショートカットを押すと、サイドパネルにレンダリング結果が 表示されます。

メリット

  • ほとんどの開発者に既にインストール済み
  • オフラインで動作

デメリット

  • READMEをプレビューするためにフルIDEを起動するのは大げさ
  • プレビューのレンダリングはGitHubと正確に一致しない (calloutサポートなし、テーブルスタイルが異なる)
  • エディタに紐付き — ファイルをダブルクリックするだけでは使えない

## 方法 3(おすすめ)

ShowMeMyMD — ダブルクリックするだけ

git clone <repo>
Double-click README.md
Done.

ShowMeMyMDはネイティブmacOS Markdownビューアーです。 .md ファイルのデフォルトアプリに設定すると、すべてのREADMEが即座に レンダリングプレビューとして開きます。CLI不要。サーバー不要。 セットアップ不要。

完全なGitHub-Flavored Markdownサポート:

  • 配置付きテーブル
  • チェックボックス付きタスクリスト
  • シンタックスハイライト付きfencedコードブロック
  • GitHub形式のcallout: NOTE TIP WARNING IMPORTANT CAUTION

Clone、README.mdをダブルクリック、完了。


## 比較

並べて比較

ツールセットアップGFM精度速度オフライン
gripPython + pip install正確(GitHub API)遅い(ネットワーク)不可
VS Codeインストール済み部分的速い
ShowMeMyMDMac App Storeから一度だけインストール完全GFM + callout即座

## 関連記事

Mac用Markdownビューアーとしての ShowMeMyMD について詳しく。 開発者ワークフロー への組み込み方をご覧ください。または GitHub形式calloutのガイド もどうぞ。


READMEの確認のためにプッシュするのをやめよう

任意の .md ファイルをダブルクリックして即座にレンダリング表示。GitHub-Flavored Markdown、シンタックスハイライト、4つのテーマ。Mac App Storeで$2.99。

で入手Mac App Store