mdi : markdown 中嵌入代码 / 版本号 / markdown ...

序言

在 readme.md 中嵌入版本号、嵌入演示代码，是很常见的需求。

市面上有一些类似工具，但都不好用。于是自己写了一个 ( 可执行文件大小 256 KB )。

实现的功能是， markdown 中写类似 > ./demo.js 的语句就会嵌入代码，生成内容效果截图如下 :

另外，配合我写的 基于 deepl 的 markdown 翻译工具，就可以中英自动翻译并呈现在同一个 readme.md 文件中。

再在 github readme 的顶部设置一个文内锚点（如下图），点击就可以跳转到各种语言版本的说明，用户体验会很好。

安装

从 github 下载 或者 cargo install mdi

代码库地址

使用

mdi [dir]

会搜索目录下的 xxx.mdi.md 把 > ./xxx.rs 替换为代码内容嵌入 ，然后输出到 xxx.md 。

如果嵌入的是一个 markdown 文件，会递归渲染其中的引用。

查看演示文件 readme.mdi.md ，以及生成的文件 readme.md