2014年7月11日金曜日

GitHub Flavored Markdown に対応した Grip というツールが便利だったので備忘録

GitHub閲覧を前提に GitHub Flavored Markdown でドキュメントを書いていて、手軽なプレビュー方法が欲しくなりました。今回採用したのは Grip というpythonで書かれたスクリプト。
[導入手順: Ubuntu-14.04]
  1. apt-get install python-pip
    (もだんなぱいそんのパッケージマネージャーらしい)
  2. sudo pip install grip
    (pipでgripを導入)
[使い方]
  • grip hoge.md
(初回は /usr/var/grip.server-instance を生成するために sudo 実行が必要。これはちょっと気に入らない・・・。)

[動作]

実行すると停止させるまでローカルウェブサーバーとして動作し続け、httpリクエストを受けると起動時にパラメーターとして渡した markdown ファイルをHTMLにレンダリングしてくれる。お好みのウェブブラウザーで http://localhost:5000/ にアクセス、更新すれば最新の状態を確認できる。




ほか、ポート番号の変更やgfmのHTMLへのレンダリングの際にGitHubのアカウントを使いたい場合など、さしあたりは grip -h 、その他細かいことはREADMEの後半に書かれています。

シンプルで便利なのでおおよそ気に入りました(╹◡╹)
しばらくこれを使おうと思います。

0 件のコメント:

コメントを投稿