README.mdがGithub上でどう見えるのかをコミット前に確認する---Gripの紹介

Markdownファイルがウェブブラウザ上でどう見えるかを確認する方法はいろいろありますが、Github上という限定された条件であればGripが一番です。

Sometimes you just want to see the exact readme result before committing and pushing to GitHub.
-- joeyespo/gripより

インストール

pipでインストールできます:

pip install grip

基本的な使い方

ファイルを指定せずに起動すると、今いるディレクトリにあるREADME.mdをhttp://localhost:6419で表示してくれます。また、-bオプションをつければ起動と同時にウェブブラウザを立ち上げてくれます:

grip -b

Gripを立ち上げた後は、ファイルを更新・保存するとそれを検知してブラウザに反映してくれます。

その他のオプション

# ファイルを指定して起動する
grip AUTHORS.md

# ポートを指定して起動する
grip 80

# ファイルとポートを指定する
grip AUTHORS.md 80

# HTMLファイルにエクスポートする
grip --export

# Githubのcommentやissueのフォーマットで起動する
grip --user-content

さらに詳しい情報はGripかgrip -hでご確認下さい。