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

Markdownの中にコードを書くことはよくあります。そんな時、このコードが実行できればいいのにと思ったことはないでしょうか。コードの実行結果をドキュメントに反映できれば、本当の結果との齟齬もなくなります。

そんな使い方ができそうなのがrunmdです。プログラムを実行し、ドキュメント内に反映できます。

runmdの使い方

元の文章です。--runを付けるのがポイントです(Markdownパーサーの関係でバッククォートが離れています)。

`` `javascript --run
console.log('Hello, World!');
`` `

そしてrunmdで変換した結果がこのようになります。

$ cat README.md 
<!--
  -- This file is auto-generated from README_js.md. Changes should be made there.
  -->
` ``javascript
console.log('Hello, World!');
⇒ Hello, World!
` ``
----
Markdown generated from [README_js.md](README_js.md) by [![RunMD Logo](http://i.imgur.com/h0FVyzU.png)](https://github.com/broofa/runmd)

このように実行結果が入ることで、よりドキュメントが分かりやすくなります。計算式はもちろん、オンラインからデータを取得した結果などを載せても面白そうです。

runmdはnode/JavaScript製のオープンソース・ソフトウェア(MIT License)です。

broofa/runmd: Executable markdown files

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2