thiagokokada/gh-gfm-preview

これは何？

主な機能

• 01goldmarkの拡張機能を使ってGFMをローカルで描画し、オフラインでも動作
• 02Mermaid図、MathJax、アラート、シンタックスハイライト付きコードブロックに対応
• 03プレビュー中のファイルが変更されるとブラウザーをライブリロード
• 04ファイルパス、標準入力、自動検出したREADMEを受け付ける
• 05ディレクトリ一覧モードで複数ファイルを参照・プレビュー
• 06単体バイナリまたはGitHub CLI拡張機能として実行

ユースケース

• GitHubにpushする前にREADMEやドキュメントの草稿をプレビュー
• キーマップを使い、NeovimなどのエディターからMarkdownをプレビュー
• 安定したインターネット接続がない環境でMarkdownを執筆

クイックスタート

1. 1

   GitHub CLI拡張機能としてインストールする

   gh extension install thiagokokada/gh-gfm-preview
2. 2

   ブラウザーでMarkdownファイルをプレビューする

   gh gfm-preview README.md

使う前に知っておきたいこと

• !GeoJSON/TopoJSONの図や地図機能にはインターネット接続が必要です。STLの3D図には対応していません。
• !メンション、IssueやPull Requestへの参照など、GitHubに依存する機能は利用できません。
• !レンダリングはエミュレーションのため、GitHubの出力に近いものの、完全には一致しません。

トピック

よくある質問

gh-gfm-preview とは？

GitHub Flavored Markdownをオフラインでもプレビューできる、ローカルWebサーバーを起動するGo製CLI／GitHub CLI拡張機能。 gh-gfm-previewは、MarkdownファイルをGitHubの表示に近い形でブラウザーに描画するローカルWebサーバーを起動します。yuin/goldmarkとその拡張機能を使ってローカルで描画するため、ほとんどの機能はインターネット接続なしで利用できます。

gh-gfm-preview は無料で使えますか？ライセンスは？

gh-gfm-preview は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

gh-gfm-preview は今もメンテナンスされていますか？

半年以内に更新あり。gh-gfm-preview の最終コミットは 2026年7月24日 です。

gh-gfm-preview は何に使えますか？

GitHubにpushする前にREADMEやドキュメントの草稿をプレビュー キーマップを使い、NeovimなどのエディターからMarkdownをプレビュー 安定したインターネット接続がない環境でMarkdownを執筆

gh-gfm-preview のインストール方法は？

GitHub CLI拡張機能としてインストールする: gh extension install thiagokokada/gh-gfm-preview ブラウザーでMarkdownファイルをプレビューする: gh gfm-preview README.md

gh-gfm-preview はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/thiagokokada/gh-gfm-preview