Markdownに説明もコードも直接書けばいいのでは、と思ってCLIを作った
この記事で分かること
Markdownに説明とコードを直接記述するだけで動作するCLIツールの開発経緯と使い方を紹介している。ドキュメントと実行可能コードを一元管理できるため、説明と実装の乖離を防ぎたい開発者にとって、新しいドキュメント管理の選択肢となる。
詳細要約
Markdownファイル内に説明とコードを併記し、そのまま実行可能なCLIツールを作成した。実際の利用では、コードブロックに実行したいコマンドを記述し、ツールがそれを解釈してターミナルで自動実行する仕組みとなる。これにより、READMEなどに書いた手順をコピペせずにそのまま検証できる。注意点として、実行前にコード内容を確認する安全機構の有無が使い分けの判断材料になる。