ローカルで GitHub の Markdown の見た目を確認できるツール「Grip」を使ってみた

GitHub の Wiki は「プロジェクト名.wiki」というリポジトリで管理されており、clone することでローカルでも編集できる。
ただ、編集後の見栄えを確認するために、毎度 commit & push しないといけないのも結構面倒。
便利な方法は無いかググってみたところ、Grip というローカルで GitHub の Markdown 形式のファイルの見栄えを確認できるツールが MOONGIFT で紹介されていたので、導入してみた。

Python 製のツールなので pip でインストールできるが、macOS であれば homebrew からもインストールできる。
自分は homebrew でインストールした。
$ brew install grip
インストール後、見栄えを確認したい md ファイルを引数として grip を起動する。
$ grip Features.md
すると、ローカルで HTTP サーバ(デフォルトでポート6419)が立ち上がる。
スクリーンショット 2019-05-14 7.17.12.png
Web ブラウザを立ち上げ、 http://localhost:6419 にアクセスすると、md ファイルが表示される。
スクリーンショット 2019-05-14 7.19.22.png
詳細な使用方法は Usage を参照されたい。

なお、Grip は GitHub の API を使ってレンダリングを行っているのだが、GitHub の API は1時間60回まで、という呼び出し制限があり、これを超えるとエラーになってしまう。
自分もしょっちゅうアクセスしていたらその制限に達してしまったようで、以下のような画面が表示された。
スクリーンショット 2019-05-14 0.36.22.png
これを回避するには、Grip の引数に GitHub のユーザー名及びパスワードを指定して起動することで、リミットが1時間5,000回まで緩和されるようだ。
$ grip --user {ユーザー名} --pass {パスワード} readme.md
小一時間ほど使ってみたが、特にバグらしいバグも無く、非常に便利なので、今後も活用していきたい。

この記事へのコメント