mdi : マークダウンにコードを埋め込む / バージョン番号 / マークダウン ...
序文
readme.md
にバージョン番号やデモコードを埋め込むことは、一般的な要件です。
市販の類似ツールもありますが、なかなかうまくいきません。そこで、自分で書いてみました(実行ファイルサイズ256KB)。
機能としては、マークダウンで > ./demo.js
のような記述をすると、コードが埋め込まれ、その結果、以下のスクリーンショットのようなコンテンツが出来上がります。
また、私が deeplをベースに書いた マークダウン翻訳ツールを使えば、中国語から英語への自動翻訳を行い、同じ readme.md
ファイルで提示することも可能です。
githubのreadme(下図)の上部にテキスト内のアンカーポイントがあり、そこをクリックすると様々な言語版の説明書にジャンプできるなど、ユーザー体験は非常に良いものになると思います。
インストール
githubからダウンロード するか cargo install mdi
使用方法
mdi [dir]
ディレクトリ xxx.mdi.md
を検索し、 > ./xxx.rs
を埋め込みコードの内容に置き換えて、 xxx.md
に出力します。
埋め込みがマークダウンファイルの場合、そのファイルへの参照を再帰的にレンダリングします。
デモファイル readme.mdi.mdを見る