ITエンジニア/デザイナ向けにオープンソースを毎日紹介

ああ、確かにこれはあると便利かも…。

GitHubではREADME.mdなどのファイルを置いておくと自動的にHTMLに変換して表示してくれる機能があります。ただ慣れていないとMarkdownの記法を間違えて変に表示されてムダなコミットが増えることがあります。

そんなイライラを防ぐために使ってみたいのがGripです。ローカルでGitHubと同じような表示でプレビューができます。

インストール

インストールは簡単で、pipを使って行います。

$ pip install grip

これで準備は完了です。

使い方

後はGitHubを使っているリポジトリに移動してgripコマンドを実行するだけです。

$ grip 
 * Running on http://localhost:5000/

実行したら表示されている

http://localhost:5000/
を開きます。

このようにGitHub風に表示されれば確認が容易になります。
このようにGitHub風に表示されれば確認が容易になります。

オプションが幾つかあります。

$ grip -h
Usage:
  grip [options] [<path>] [<address>]
  grip -h | --help
  grip --version

Where:
  <path> is a file to render or a directory containing a README.md file
  <address> is what to listen on, of the form <host>[:<port>], or just </port><port>

Options:
  --gfm             Use GitHub-Flavored Markdown, e.g. comments or issues
  --context=<repo>  The repository context, only taken into account with --gfm
  --user=<username> A GitHub username for API authentication
  --pass=<password> A GitHub password for API authentication
  --export          Exports to <path>.html or README.md instead of serving

exportを使うとHTMLファイルの生成も可能です。またGitHub-Flavored Markdownにも対応しています。その他APIも提供しており、他のプログラムの中に組み込んで使うことも想定されています。

また、

$ grip AUTHORS.md
 * Running on http://localhost:5000/

のようにしてファイルを指定すると

http://localhost:5000/AUTHORS.md
で指定したファイルがプレビューできるようになります。README.md以外でも使えるのが便利です。

何気なく書いたMarkdown記法が方言によって異なっていたり、ミスしたりするとリポジトリを見た時に恥ずかしいだけでなく、さらに修正した時のログにも残って残念な気分になってしまいます。そうならないためにも予めプレビューをしておく習慣付けは良さそうです。

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

joeyespo/grip

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2