Markdownの記法はシンプルですが、それでも書いた内容と実際の表示が異なるので書いた後で確認したら思っていた表示と違っていた、なんてことが多々あります。特にGitHubのREADMEで失敗しがちです。 そこで使ってみたいのがGripです。GitHubと同じデザインでMarkdownファイルの表示を確認できます。

Gripの使い方

GripはMarkdownファイルを指定して実行します。そうするとHTTPサーバが立ち上がるので、ブラウザからアクセスします。

まさに表示はGitHub風で、アイコンも再現されています。コミットする前にgripを使って確認すればミスを事前に防げるでしょう。Markdownエディタのプレビューは独自拡張されている場合もあるので、gripで確認する方が実際の表示に近そうです。

GripはPython製のオープンソース・ソフトウェア(MIT License)です。

joeyespo/grip: Preview GitHub Markdown files like Readme locally before committing them.