markdown のリアルタイムレンダリングツール markup をリリースしました
intro
最近は Readme やら執筆原稿などで markdown を使うことが結構多かったりします。
markdown をレンダリングするツールは色々あるんですが、
エディタは好きなものを使いたいので、自分でレンダリングして、
ブラウザで確認できる何かがあればいいなぁと思ってました。
そんな時、 Github が markdown のレンダリングを API としてやっていたことを知りました。
しかも、サーバから叩くぶんには認証などもなく、 5000 回/時も叩けるということで、
それを使ってリアルタイムにレンダリングするツールを作りました。
使い方
インストールは
$ npm install markup $ markup readme.md [3000]
これだけです。
流行りに乗っかって?、ググラビリティの低い名前でリリースしてます。
markup コマンドはファイルパスとポート(デフォルト 3000) だけを受け取ります。
あとは(ポートが3000なら)
を開いて表示しておくだけです。(最初はレンダリングの結果を待つので少し待つかも)
あとは、ファイルを手元の好きなエディタで更新すれば、保存時にレンダリングしなおして
Socket.IO でリアルタイムに表示してくれます。
http://github.github.com/github-flavored-markdown/:github-flavered-markdown を基本に書いて下さい。
基本 Gihub に乗っかってるだけなので、規制的なものが入ったら潔く取り下げます。
special thanks
Thanks for Github <3