【GitHub】Markdown形式のREADME.mdをプレビューしながら編集する




GitHubを使うとき、プログラムの説明を書くREADME.mdを書いている方がほとんどかと思います。このREADME.mdですがMarkdownという形式でしてエディターやブラウザで完成形を確認することが出来ません。

一応、GitHubのウェブサイトでプレビューの機能があるのですが、ローカルのワーキングツリーにあるREADME.mdを編集してからリモートにプッシュしたいという人も多いと思います。

そこで、今回はMarkdown形式のファイルをプレビューしながら編集する手順を紹介します。超簡単です。

僕の使っているOSはMacOS Mojave 10.14.5です。pipが必要なので、ご自分のOSに適した手順でインストールしておいてください。

インストール方法

pipを使ってgripというパッケージをインストールします。

使用方法

まずターミナルを立ち上げます。

使えるオプション

詳細はGitHubの公式ページをご確認ください。

プレビューしてみる

プレビューしたいファイルを相対パスか絶対パスで指定します。

するとこのような表示が出ます。

ここに書いてあるローカルパスhttp://localhost:6419/にアクセスするとプレビュー結果を見ることが出来ます!最後に80などの数字を指定すると該当するポートを割り振ることが出来ます。

ちなみに、プレビューを見ながらエディターでファイル(今回はREADME.me)を開いて編集する場合、Command+Cで上書き保存したタイミングでプレビューも自動更新されます。とても便利ですね!