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

Markdownではコードを書けるようになっています。基本的にはHTMLなどにした際にハイライト表示されるためのものですが、コードは実行してこそ意味があります。多くはコピー&ペーストで使われるでしょう。

そこで使ってみたいのがharmoniumです。Markdownファイル中にあるシェルコマンドを実行して、問題がないか確認できます。

使い方

harmoniumはrunオプションとともに、対象のMarkdownファイルを渡します。

$ go run harmonium.go run sample.md
execution successed!

このように表示されれば問題ありません。何かしらエラーがあると、処理が失敗します(具体的にどのコマンドが失敗したかは分かりません。ハイライト時にshを指定しておくとコマンド実行してくれます。

文書を書いて、そのコマンドがちゃんと実行できるかを確認する際に便利ではないでしょうか。また、環境セットアップ系などでも使えそうです。

harmoniumはGo製のオープンソース・ソフトウェア(MIT License)です。

syucream/harmonium: An executor shell script inlined in markdown

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2